Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RuleDescription

Package version

Represents a Rule on a Subscription that is used to filter the incoming message from the Subscription.

Hierarchy

  • RuleDescription

Index

Properties

Properties

Optional action

action: undefined | string

Action to perform if the message satisfies the filtering expression.

Optional filter

filter: string | CorrelationRuleFilter

Filter expression used to match messages. Supports 2 types:

  • string: SQL-like condition expression that is evaluated against the messages' user-defined properties and system properties. All system properties will be prefixed with sys. in the condition expression.
  • CorrelationRuleFilter: Properties of the filter will be used to match with the message properties.

name

name: string

Represents the name of the rule.

Generated using TypeDoc