Class GetStreamResponse

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

  • Method Details

    • streamArn

      public final String streamArn()

      The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces. This ARN can be used in other API operations to reference this specific stream.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces. This ARN can be used in other API operations to reference this specific stream.

    • streamLabel

      public final String streamLabel()

      A timestamp that serves as a unique identifier for this stream, used for debugging and monitoring purposes. The stream label represents the point in time when the stream was created.

      Returns:
      A timestamp that serves as a unique identifier for this stream, used for debugging and monitoring purposes. The stream label represents the point in time when the stream was created.

    • streamStatus

      public final StreamStatus streamStatus()

      The current status of the stream. Values can be ENABLING, ENABLED, DISABLING, or DISABLED. Operations on the stream depend on its current status.

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

      Returns:
      The current status of the stream. Values can be ENABLING, ENABLED, DISABLING, or DISABLED. Operations on the stream depend on its current status.
      See Also:

    • streamStatusAsString

      public final String streamStatusAsString()

      The current status of the stream. Values can be ENABLING, ENABLED, DISABLING, or DISABLED. Operations on the stream depend on its current status.

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

      Returns:
      The current status of the stream. Values can be ENABLING, ENABLED, DISABLING, or DISABLED. Operations on the stream depend on its current status.
      See Also:

    • streamViewType

      public final StreamViewType streamViewType()

      The format of the data records in this stream. Currently, this can be one of the following options:

      • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

      • NEW_IMAGE - the version of the row after the change.

      • OLD_IMAGE - the version of the row before the change.

      • KEYS_ONLY - the partition and clustering keys of the row that was changed.

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

      Returns:
      The format of the data records in this stream. Currently, this can be one of the following options:

      • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

      • NEW_IMAGE - the version of the row after the change.

      • OLD_IMAGE - the version of the row before the change.

      • KEYS_ONLY - the partition and clustering keys of the row that was changed.

      See Also:

    • streamViewTypeAsString

      public final String streamViewTypeAsString()

      The format of the data records in this stream. Currently, this can be one of the following options:

      • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

      • NEW_IMAGE - the version of the row after the change.

      • OLD_IMAGE - the version of the row before the change.

      • KEYS_ONLY - the partition and clustering keys of the row that was changed.

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

      Returns:
      The format of the data records in this stream. Currently, this can be one of the following options:

      • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

      • NEW_IMAGE - the version of the row after the change.

      • OLD_IMAGE - the version of the row before the change.

      • KEYS_ONLY - the partition and clustering keys of the row that was changed.

      See Also:

    • creationRequestDateTime

      public final Instant creationRequestDateTime()

      The date and time when the request to create this stream was issued. The value is represented in ISO 8601 format.

      Returns:
      The date and time when the request to create this stream was issued. The value is represented in ISO 8601 format.

    • keyspaceName

      public final String keyspaceName()

      The name of the keyspace containing the table associated with this stream. The keyspace name is part of the table's hierarchical identifier in Amazon Keyspaces.

      Returns:
      The name of the keyspace containing the table associated with this stream. The keyspace name is part of the table's hierarchical identifier in Amazon Keyspaces.

    • tableName

      public final String tableName()

      The name of the table associated with this stream. The stream captures changes to rows in this Amazon Keyspaces table.

      Returns:
      The name of the table associated with this stream. The stream captures changes to rows in this Amazon Keyspaces table.

    • hasShards

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

    • shards

      public final List<Shard> shards()

      An array of shard objects associated with this stream. Each shard contains a subset of the stream's data records and has its own unique identifier. The collection of shards represents the complete stream 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 hasShards() method.

      Returns:
      An array of shard objects associated with this stream. Each shard contains a subset of the stream's data records and has its own unique identifier. The collection of shards represents the complete stream data.

    • nextToken

      public final String nextToken()

      A pagination token that can be used in a subsequent GetStream request. This token is returned if the response contains more shards than can be returned in a single response.

      Returns:
      A pagination token that can be used in a subsequent GetStream request. This token is returned if the response contains more shards than can be returned in a single response.

    • toBuilder

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

    • builder

      public static GetStreamResponse.Builder builder()

    • serializableBuilderClass

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