com.azure.messaging.servicebus.administration.models

Class SqlRuleFilter

java.lang.Object

com.azure.messaging.servicebus.administration.models.RuleFilter

com.azure.messaging.servicebus.administration.models.SqlRuleFilter

Direct Known Subclasses:

FalseRuleFilter, TrueRuleFilter

public class SqlRuleFilter
extends RuleFilter

Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.

A SqlRuleFilter holds a SQL-like condition expression that is evaluated in the broker against the arriving messages' user-defined properties and system properties. All system properties (which are all properties explicitly listed on the ServiceBusMessage class) must be prefixed with sys. in the condition expression. The SQL subset implements testing for existence of properties (EXISTS), testing for null-values (IS NULL), logical NOT/AND/OR, relational operators, numeric arithmetic, and simple text pattern matching with LIKE.

See Also:

CreateRuleOptions.setFilter(RuleFilter), RuleProperties.setFilter(RuleFilter)

Constructor Summary

Constructors

Constructor and Description
SqlRuleFilter(String sqlExpression) Creates a new instance with the given SQL expression.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getParameters() Gets the value of a filter expression.
String	getSqlExpression() Gets the SQL expression.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SqlRuleFilter

public SqlRuleFilter(String sqlExpression)

Creates a new instance with the given SQL expression.

Parameters:

sqlExpression - SQL expression for the filter.

Throws:

NullPointerException - if sqlExpression is null.

IllegalArgumentException - if sqlExpression is an empty string.

Method Detail

getParameters

public Map<String,Object> getParameters()

Gets the value of a filter expression. Allowed types: string, int, long, bool, double

Returns:

Gets the value of a filter expression.

getSqlExpression

public String getSqlExpression()

Gets the SQL expression.

Returns:

The SQL expression.