Class AttributeDimension

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

Specifies attribute-based criteria for including or excluding endpoints from a segment.

See Also:

  • Method Details

    • attributeType

      public final AttributeType attributeType()

      The type of segment dimension to use. Valid values are:

      • INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
      • EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
      • CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
      • BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
      • AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
      • ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
      • BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

        • If the service returns an enum value that is not available in the current SDK version, attributeType will return AttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeTypeAsString().

      Returns:
      The type of segment dimension to use. Valid values are:
      • INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
      • EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
      • CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
      • BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
      • AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
      • ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
      • BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
      See Also:

    • attributeTypeAsString

      public final String attributeTypeAsString()

      The type of segment dimension to use. Valid values are:

      • INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
      • EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
      • CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
      • BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
      • AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
      • ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
      • BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

        • If the service returns an enum value that is not available in the current SDK version, attributeType will return AttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeTypeAsString().

      Returns:
      The type of segment dimension to use. Valid values are:
      • INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
      • EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
      • CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
      • BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
      • AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
      • ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
      • BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
      See Also:

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • values

      public final List<String> values()

      The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

      Returns:
      The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

    • toBuilder

      public AttributeDimension.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<AttributeDimension.Builder,AttributeDimension>
      Returns:
      a builder for type T

    • builder

      public static AttributeDimension.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AttributeDimension.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.