Table of Contents

Class RuleDescription

Namespace
Microsoft.ServiceBus.Messaging
Assembly
Microsoft.ServiceBus.dll

Represents a description of a rule.

[DataContract(Name = "RuleDescription", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public sealed class RuleDescription : EntityDescription, IExtensibleDataObject
Inheritance
RuleDescription
Implements
IExtensibleDataObject
Inherited Members

Constructors

RuleDescription()

Initializes a new instance of the RuleDescription class with default values.

public RuleDescription()

RuleDescription(Filter)

Initializes a new instance of the RuleDescription class with the specified filter expression.

public RuleDescription(Filter filter)

Parameters

filter Filter

The filter expression used to match messages.

RuleDescription(string)

Initializes a new instance of the RuleDescription class with the specified name.

public RuleDescription(string name)

Parameters

name string

The name of the rule.

RuleDescription(string, Filter)

Initializes a new instance of the RuleDescription class with the specified name and filter expression.

public RuleDescription(string name, Filter filter)

Parameters

name string

The name of the rule.

filter Filter

The filter expression used to match messages.

Fields

DefaultRuleName

Specifies the name of the default rule.

public const string DefaultRuleName = "$Default"

Field Value

string

Properties

Action

Gets or sets the action to perform if the message satisfies the filtering expression.

[DataMember(Name = "Action", IsRequired = false, Order = 65538, EmitDefaultValue = false)]
public RuleAction Action { get; set; }

Property Value

RuleAction

The action to perform if the message satisfies the filtering expression.

CreatedAt

Gets creation time of the rule.

public DateTime CreatedAt { get; }

Property Value

DateTime

The creation time of the rule.

Filter

Gets or sets the filter expression used to match messages.

[DataMember(Name = "Filter", IsRequired = false, Order = 65537, EmitDefaultValue = false)]
public Filter Filter { get; set; }

Property Value

Filter

The filter expression used to match messages.

Exceptions

ArgumentNullException

null (Nothing in Visual Basic) is assigned.

Name

Gets or sets the name of the rule.

[DataMember(Name = "Name", IsRequired = false, Order = 131077, EmitDefaultValue = false)]
public string Name { get; set; }

Property Value

string

Returns a string Representing the name of the rule.