Class SegmentGroupList

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

Specifies the settings that define the relationships between segment groups for a segment.

See Also:

  • Method Details

    • hasGroups

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

    • groups

      public final List<SegmentGroup> groups()

      An array that defines the set of segment criteria to evaluate when handling segment groups 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 hasGroups() method.

      Returns:
      An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

    • include

      public final Include include()

      Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

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

      Returns:
      Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
      See Also:

    • includeAsString

      public final String includeAsString()

      Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

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

      Returns:
      Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
      See Also:

    • toBuilder

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

    • builder

      public static SegmentGroupList.Builder builder()

    • serializableBuilderClass

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