Class EventSubscriptionFilter


  • public final class EventSubscriptionFilter
    extends Object
    Filter for the Event Subscription.
    • Constructor Detail

      • EventSubscriptionFilter

        public EventSubscriptionFilter()
    • Method Detail

      • subjectBeginsWith

        public String subjectBeginsWith()
        Get the subjectBeginsWith property: 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.
        Returns:
        the subjectBeginsWith value.
      • withSubjectBeginsWith

        public EventSubscriptionFilter withSubjectBeginsWith​(String subjectBeginsWith)
        Set the subjectBeginsWith property: 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.
        Parameters:
        subjectBeginsWith - the subjectBeginsWith value to set.
        Returns:
        the EventSubscriptionFilter object itself.
      • subjectEndsWith

        public String subjectEndsWith()
        Get the subjectEndsWith property: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path.
        Returns:
        the subjectEndsWith value.
      • withSubjectEndsWith

        public EventSubscriptionFilter withSubjectEndsWith​(String subjectEndsWith)
        Set the subjectEndsWith property: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path.
        Parameters:
        subjectEndsWith - the subjectEndsWith value to set.
        Returns:
        the EventSubscriptionFilter object itself.
      • includedEventTypes

        public List<String> includedEventTypes()
        Get the includedEventTypes property: 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.
        Returns:
        the includedEventTypes value.
      • withIncludedEventTypes

        public EventSubscriptionFilter withIncludedEventTypes​(List<String> includedEventTypes)
        Set the includedEventTypes property: 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.
        Parameters:
        includedEventTypes - the includedEventTypes value to set.
        Returns:
        the EventSubscriptionFilter object itself.
      • isSubjectCaseSensitive

        public Boolean isSubjectCaseSensitive()
        Get the isSubjectCaseSensitive property: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner.
        Returns:
        the isSubjectCaseSensitive value.
      • withIsSubjectCaseSensitive

        public EventSubscriptionFilter withIsSubjectCaseSensitive​(Boolean isSubjectCaseSensitive)
        Set the isSubjectCaseSensitive property: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner.
        Parameters:
        isSubjectCaseSensitive - the isSubjectCaseSensitive value to set.
        Returns:
        the EventSubscriptionFilter object itself.
      • enableAdvancedFilteringOnArrays

        public Boolean enableAdvancedFilteringOnArrays()
        Get the enableAdvancedFilteringOnArrays property: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.
        Returns:
        the enableAdvancedFilteringOnArrays value.
      • withEnableAdvancedFilteringOnArrays

        public EventSubscriptionFilter withEnableAdvancedFilteringOnArrays​(Boolean enableAdvancedFilteringOnArrays)
        Set the enableAdvancedFilteringOnArrays property: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.
        Parameters:
        enableAdvancedFilteringOnArrays - the enableAdvancedFilteringOnArrays value to set.
        Returns:
        the EventSubscriptionFilter object itself.
      • advancedFilters

        public List<AdvancedFilter> advancedFilters()
        Get the advancedFilters property: An array of advanced filters that are used for filtering event subscriptions.
        Returns:
        the advancedFilters value.
      • withAdvancedFilters

        public EventSubscriptionFilter withAdvancedFilters​(List<AdvancedFilter> advancedFilters)
        Set the advancedFilters property: An array of advanced filters that are used for filtering event subscriptions.
        Parameters:
        advancedFilters - the advancedFilters value to set.
        Returns:
        the EventSubscriptionFilter object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.