RuleAction Class

  • Reference

Definition

Namespace:
Microsoft.ServiceBus.Messaging
Assembly:
Microsoft.ServiceBus.dll
Package:
WindowsAzure.ServiceBus v6.2.2

Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.

[System.Runtime.Serialization.DataContract(Name="RuleAction", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.EmptyRuleAction))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.SqlRuleAction))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.CompositeAction))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.RuleCreationAction))]
[System.Runtime.Serialization.KnownType(typeof(System.DateTimeOffset))]
public abstract class RuleAction : System.Runtime.Serialization.IExtensibleDataObject
[<System.Runtime.Serialization.DataContract(Name="RuleAction", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.EmptyRuleAction))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.SqlRuleAction))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.CompositeAction))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.RuleCreationAction))>]
[<System.Runtime.Serialization.KnownType(typeof(System.DateTimeOffset))>]
type RuleAction = class
    interface IExtensibleDataObject
Public MustInherit Class RuleAction
Implements IExtensibleDataObject
Inheritance
Object
RuleAction
Derived
Attributes
DataContractAttribute KnownTypeAttribute
Implements
IExtensibleDataObject

Remarks

Filter actions allow for the transformation of a message that have been matched by a filter expression. The typical use case for filter acions is to append or update the properties that are attached to a message, for example assigning a group ID based on the correlation ID of a message.

Properties

RequiresPreprocessing

Gets a value that indicates whether the rule action requires preprocessing.

Methods

Execute(BrokeredMessage)

Executes the filter action on the supplied BrokeredMessage.
Preprocess()

Preprocesses the RuleAction object.
Validate()

Validates the rule action against the grammar.

Explicit Interface Implementations

IExtensibleDataObject.ExtensionData

Applies to

See also

  • SqlRuleAction
  • <xref:Microsoft.ServiceBus.Messaging.EmptyRuleAction>