Class GetStreamForSegmentsResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse
software.amazon.awssdk.services.customerprofiles.model.GetStreamForSegmentsResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetStreamForSegmentsResponse.Builder,GetStreamForSegmentsResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetStreamForSegmentsResponse extends CustomerProfilesResponse implements ToCopyableBuilder<GetStreamForSegmentsResponse.Builder,GetStreamForSegmentsResponse>

  • Method Details

    • associatedAt

      public final Instant associatedAt()

      The timestamp of when the stream was associated.

      Returns:
      The timestamp of when the stream was associated.

    • hasAssociatedSegments

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

    • associatedSegments

      public final List<AssociatedSegment> associatedSegments()

      A list of segments currently associated with the stream and their subscription status.

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

      Returns:
      A list of segments currently associated with the stream and their subscription status.

    • domainName

      public final String domainName()

      The unique name of the domain.

      Returns:
      The unique name of the domain.

    • destinationArn

      public final String destinationArn()

      The Amazon Resource Name (ARN) of the Amazon Kinesis data stream receiving segment membership events.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Kinesis data stream receiving segment membership events.

    • destinationRoleArn

      public final String destinationRoleArn()

      The Amazon Resource Name (ARN) of the IAM role used for Amazon Kinesis and AWS Key Management Service (KMS) operations.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role used for Amazon Kinesis and AWS Key Management Service (KMS) operations.

    • state

      public final EventSubscriptionState state()

      The operational state of the destination stream. The following are valid values:

      • RUNNING: The stream is associated and healthy. Segment membership events are being published.

      • UNHEALTHY: The stream is associated but events cannot currently be published. See FailureReason for details.

      • STOPPED: The stream is no longer publishing segment membership events.

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

      Returns:
      The operational state of the destination stream. The following are valid values:

      • RUNNING: The stream is associated and healthy. Segment membership events are being published.

      • UNHEALTHY: The stream is associated but events cannot currently be published. See FailureReason for details.

      • STOPPED: The stream is no longer publishing segment membership events.

      See Also:

    • stateAsString

      public final String stateAsString()

      The operational state of the destination stream. The following are valid values:

      • RUNNING: The stream is associated and healthy. Segment membership events are being published.

      • UNHEALTHY: The stream is associated but events cannot currently be published. See FailureReason for details.

      • STOPPED: The stream is no longer publishing segment membership events.

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

      Returns:
      The operational state of the destination stream. The following are valid values:

      • RUNNING: The stream is associated and healthy. Segment membership events are being published.

      • UNHEALTHY: The stream is associated but events cannot currently be published. See FailureReason for details.

      • STOPPED: The stream is no longer publishing segment membership events.

      See Also:

    • disassociatedAt

      public final Instant disassociatedAt()

      The timestamp of when the stream was disassociated.

      Returns:
      The timestamp of when the stream was disassociated.

    • failureReason

      public final String failureReason()

      The reason why the stream is in an unhealthy state, if applicable.

      Returns:
      The reason why the stream is in an unhealthy state, if applicable.

    • toBuilder

      public GetStreamForSegmentsResponse.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<GetStreamForSegmentsResponse.Builder,GetStreamForSegmentsResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetStreamForSegmentsResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetStreamForSegmentsResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.