Class SegmentDimensions

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

Specifies the dimension settings for a segment.

See Also:

  • Method Details

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes 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.

    • attributes

      public final Map<String,AttributeDimension> attributes()

      One or more custom attributes to use as criteria for the segment.

      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 hasAttributes() method.

      Returns:
      One or more custom attributes to use as criteria for the segment.

    • behavior

      public final SegmentBehaviors behavior()

      The behavior-based criteria, such as how recently users have used your app, for the segment.

      Returns:
      The behavior-based criteria, such as how recently users have used your app, for the segment.

    • demographic

      public final SegmentDemographics demographic()

      The demographic-based criteria, such as device platform, for the segment.

      Returns:
      The demographic-based criteria, such as device platform, for the segment.

    • location

      public final SegmentLocation location()

      The location-based criteria, such as region or GPS coordinates, for the segment.

      Returns:
      The location-based criteria, such as region or GPS coordinates, for the segment.

    • hasMetrics

      public final boolean hasMetrics()
      For responses, this returns true if the service returned a value for the Metrics 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.

    • metrics

      public final Map<String,MetricDimension> metrics()

      One or more custom metrics to use as criteria for the segment.

      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 hasMetrics() method.

      Returns:
      One or more custom metrics to use as criteria for the segment.

    • hasUserAttributes

      public final boolean hasUserAttributes()
      For responses, this returns true if the service returned a value for the UserAttributes 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.

    • userAttributes

      public final Map<String,AttributeDimension> userAttributes()

      One or more custom user attributes to use as criteria for the segment.

      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 hasUserAttributes() method.

      Returns:
      One or more custom user attributes to use as criteria for the segment.

    • toBuilder

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

    • builder

      public static SegmentDimensions.Builder builder()

    • serializableBuilderClass

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