Contents

QueryFilterOperator

Enumeration of the comparison operators supported in query filters.

Declaration

string QueryFilterOperator

Possible Values

EQUALS

Exact match.

NOT_EQUALS

Matches records where the field value is not equal to the specified value.

IN

Matches any of the specified values.

NOT_IN

Matches records where the field value is not in the specified set.

CONTAINS_ANY

Matches records where the field contains any of the specified values.

NOT_CONTAINS_ANY

Matches records where the field does not contain any of the specified values.

CONTAINS_ALL

Matches records where the field contains all of the specified values.

NOT_CONTAINS_ALL

Matches records where the field does not contain all of the specified values.

LIKE

Pattern match, case-sensitive. Use % as a wildcard to match any sequence of characters. Set ignoreCase to true on the QueryFilter for a case-insensitive pattern match.

NOT_LIKE

Matches records where the field does not match the pattern. Use % as a wildcard to match any sequence of characters.

STARTS_WITH

Matches records where the field value starts with the specified string.

ENDS_WITH

Matches records where the field value ends with the specified string.

GREATER_THAN

Matches records where the field value is greater than the specified value.

GREATER_THAN_OR_EQUAL_TO

Matches records where the field value is greater than or equal to the specified value.

LESS_THAN

Matches records where the field value is less than the specified value.

LESS_THAN_OR_EQUAL_TO

Matches records where the field value is less than or equal to the specified value.

BETWEEN

Matches values within an inclusive range. Requires exactly two values, ordered as [minimum, maximum].

IS_NULL

Matches records where the field has no value.

IS_NOT_NULL

Matches records where the field has a value.

Discussion

The QueryFilterOperator enumerates the comparison operators available in QueryFilter.operator. Not every field or endpoint supports all operators. Refer to each entity’s dictionary keys for per-field operator support.

Endpoints that accept a QueryFilter or QueryRequest:

See Also

Type Aliases