Class AssociatedSegment

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

Represents a segment associated with a membership event stream.

See Also:

  • Method Details

    • segmentName

      public final String segmentName()

      The unique name of the segment definition.

      Returns:
      The unique name of the segment definition.

    • status

      public final EventSubscriptionSegmentStatus status()

      The subscription status of the segment. The following are valid values:

      • STARTING: The segment is being prepared to publish membership events.

      • RUNNING: The segment is actively publishing membership events to the stream.

      • STOPPED: The segment has stopped publishing membership events.

      • FAILED: The segment failed to publish membership events.

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

      Returns:
      The subscription status of the segment. The following are valid values:

      • STARTING: The segment is being prepared to publish membership events.

      • RUNNING: The segment is actively publishing membership events to the stream.

      • STOPPED: The segment has stopped publishing membership events.

      • FAILED: The segment failed to publish membership events.

      See Also:

    • statusAsString

      public final String statusAsString()

      The subscription status of the segment. The following are valid values:

      • STARTING: The segment is being prepared to publish membership events.

      • RUNNING: The segment is actively publishing membership events to the stream.

      • STOPPED: The segment has stopped publishing membership events.

      • FAILED: The segment failed to publish membership events.

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

      Returns:
      The subscription status of the segment. The following are valid values:

      • STARTING: The segment is being prepared to publish membership events.

      • RUNNING: The segment is actively publishing membership events to the stream.

      • STOPPED: The segment has stopped publishing membership events.

      • FAILED: The segment failed to publish membership events.

      See Also:

    • message

      public final String message()

      An optional message providing context, such as a failure reason.

      Returns:
      An optional message providing context, such as a failure reason.

    • toBuilder

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

    • builder

      public static AssociatedSegment.Builder builder()

    • serializableBuilderClass

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