Class Group

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

Contains dimensions that determine what to segment on.

See Also:

  • Method Details

    • hasDimensions

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

    • dimensions

      public final List<Dimension> dimensions()

      Defines the attributes to segment on.

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

      Returns:
      Defines the attributes to segment on.

    • hasSourceSegments

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

    • sourceSegments

      public final List<SourceSegment> sourceSegments()

      Defines the starting source of data.

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

      Returns:
      Defines the starting source of data.

    • sourceType

      public final IncludeOptions sourceType()

      Defines how to interact with the source data.

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

      Returns:
      Defines how to interact with the source data.
      See Also:

    • sourceTypeAsString

      public final String sourceTypeAsString()

      Defines how to interact with the source data.

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

      Returns:
      Defines how to interact with the source data.
      See Also:

    • type

      public final IncludeOptions type()

      Defines how to interact with the profiles found in the current filtering.

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

      Returns:
      Defines how to interact with the profiles found in the current filtering.
      See Also:

    • typeAsString

      public final String typeAsString()

      Defines how to interact with the profiles found in the current filtering.

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

      Returns:
      Defines how to interact with the profiles found in the current filtering.
      See Also:

    • toBuilder

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

    • builder

      public static Group.Builder builder()

    • serializableBuilderClass

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