Package software.amazon.awssdk.services.pinpoint.model

Class EventFilter

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.EventFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EventFilter.Builder,EventFilter>
@Generated("software.amazon.awssdk:codegen") public final class EventFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EventFilter.Builder,EventFilter>

Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.

See Also:

  • Method Details

    • dimensions

      public final EventDimensions dimensions()

      The dimensions for the event filter to use for the campaign or the journey activity.

      Returns:
      The dimensions for the event filter to use for the campaign or the journey activity.

    • filterType

      public final FilterType filterType()

      The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.

      If the service returns an enum value that is not available in the current SDK version, filterType will return FilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterTypeAsString().

      Returns:
      The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
      See Also:

    • filterTypeAsString

      public final String filterTypeAsString()

      The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.

      If the service returns an enum value that is not available in the current SDK version, filterType will return FilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterTypeAsString().

      Returns:
      The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
      See Also:

    • toBuilder

      public EventFilter.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<EventFilter.Builder,EventFilter>
      Returns:
      a builder for type T

    • builder

      public static EventFilter.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EventFilter.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.