Class SegmentResponse

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

Provides information about the configuration, dimension, and other settings for a segment.

See Also:

  • Method Details

    • applicationId

      public final String applicationId()

      The unique identifier for the application that the segment is associated with.

      Returns:
      The unique identifier for the application that the segment is associated with.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the segment.

      Returns:
      The Amazon Resource Name (ARN) of the segment.

    • creationDate

      public final String creationDate()

      The date and time when the segment was created.

      Returns:
      The date and time when the segment was created.

    • dimensions

      public final SegmentDimensions dimensions()

      The dimension settings for the segment.

      Returns:
      The dimension settings for the segment.

    • id

      public final String id()

      The unique identifier for the segment.

      Returns:
      The unique identifier for the segment.

    • importDefinition

      public final SegmentImportResource importDefinition()

      The settings for the import job that's associated with the segment.

      Returns:
      The settings for the import job that's associated with the segment.

    • lastModifiedDate

      public final String lastModifiedDate()

      The date and time when the segment was last modified.

      Returns:
      The date and time when the segment was last modified.

    • name

      public final String name()

      The name of the segment.

      Returns:
      The name of the segment.

    • segmentGroups

      public final SegmentGroupList segmentGroups()

      A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

      Returns:
      A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

    • segmentType

      public final SegmentType segmentType()

      The segment type. Valid values are:

      • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

      • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you they don't change over time.

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

      Returns:
      The segment type. Valid values are:

      • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

      • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

      See Also:

    • segmentTypeAsString

      public final String segmentTypeAsString()

      The segment type. Valid values are:

      • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

      • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

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

      Returns:
      The segment type. Valid values are:

      • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

      • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

      See Also:

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

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

      Returns:
      A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

    • version

      public final Integer version()

      The version number of the segment.

      Returns:
      The version number of the segment.

    • toBuilder

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

    • builder

      public static SegmentResponse.Builder builder()

    • serializableBuilderClass

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