Share via


EventSubscriptionFilter Class

Filter for the Event Subscription.

Constructor

EventSubscriptionFilter(*, subject_begins_with: str | None = None, subject_ends_with: str | None = None, included_event_types: List[str] | None = None, is_subject_case_sensitive: bool = False, enable_advanced_filtering_on_arrays: bool | None = None, advanced_filters: List[_models.AdvancedFilter] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
subject_begins_with
str

An optional string to filter events for an event subscription based on a resource path prefix. The format of this depends on the publisher of the events. Wildcard characters are not supported in this path.

Default value: None
subject_ends_with
str

An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path.

Default value: None
included_event_types

A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.

Default value: None
is_subject_case_sensitive

Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner.

Default value: False
enable_advanced_filtering_on_arrays

Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.

Default value: None
advanced_filters

An array of advanced filters that are used for filtering event subscriptions.

Default value: None

Variables

Name Description
subject_begins_with
str

An optional string to filter events for an event subscription based on a resource path prefix. The format of this depends on the publisher of the events. Wildcard characters are not supported in this path.

subject_ends_with
str

An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path.

included_event_types

A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.

is_subject_case_sensitive

Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner.

enable_advanced_filtering_on_arrays

Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.

advanced_filters

An array of advanced filters that are used for filtering event subscriptions.