Interface GetStreamResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetStreamResponse.Builder,GetStreamResponse>, KeyspacesStreamsResponse.Builder, SdkBuilder<GetStreamResponse.Builder,GetStreamResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetStreamResponse

@Mutable
@NotThreadSafe
public static interface GetStreamResponse.Builder
extends KeyspacesStreamsResponse.Builder, SdkPojo, CopyableBuilder<GetStreamResponse.Builder,GetStreamResponse>

Method Summary

Modifier and Type	Method	Description
GetStreamResponse.Builder	creationRequestDateTime(Instant creationRequestDateTime)	The date and time when the request to create this stream was issued.
GetStreamResponse.Builder	keyspaceName(String keyspaceName)	The name of the keyspace containing the table associated with this stream.
GetStreamResponse.Builder	nextToken(String nextToken)	A pagination token that can be used in a subsequent GetStream request.
GetStreamResponse.Builder	shards(Collection<Shard> shards)	An array of shard objects associated with this stream.
GetStreamResponse.Builder	shards(Consumer<Shard.Builder>... shards)	An array of shard objects associated with this stream.
GetStreamResponse.Builder	shards(Shard... shards)	An array of shard objects associated with this stream.
GetStreamResponse.Builder	streamArn(String streamArn)	The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces.
GetStreamResponse.Builder	streamLabel(String streamLabel)	A timestamp that serves as a unique identifier for this stream, used for debugging and monitoring purposes.
GetStreamResponse.Builder	streamStatus(String streamStatus)	The current status of the stream.
GetStreamResponse.Builder	streamStatus(StreamStatus streamStatus)	The current status of the stream.
GetStreamResponse.Builder	streamViewType(String streamViewType)	The format of the data records in this stream.
GetStreamResponse.Builder	streamViewType(StreamViewType streamViewType)	The format of the data records in this stream.
GetStreamResponse.Builder	tableName(String tableName)	The name of the table associated with this stream.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.keyspacesstreams.model.KeyspacesStreamsResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

streamArn

GetStreamResponse.Builder streamArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

streamLabel

GetStreamResponse.Builder streamLabel(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

streamStatus

GetStreamResponse.Builder streamStatus(String streamStatus)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StreamStatus
• StreamStatus

streamStatus

GetStreamResponse.Builder streamStatus(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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StreamStatus
• StreamStatus

streamViewType

GetStreamResponse.Builder streamViewType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StreamViewType
• StreamViewType

streamViewType

GetStreamResponse.Builder streamViewType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StreamViewType
• StreamViewType

creationRequestDateTime

GetStreamResponse.Builder creationRequestDateTime(Instant creationRequestDateTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

keyspaceName

GetStreamResponse.Builder keyspaceName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

tableName

GetStreamResponse.Builder tableName(String tableName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

shards

GetStreamResponse.Builder shards(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

shards

GetStreamResponse.Builder shards(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

shards

GetStreamResponse.Builder shards(Consumer<Shard.Builder>... 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.

This is a convenience method that creates an instance of the Shard.Builder avoiding the need to create one manually via Shard.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to shards(List<Shard>).

Parameters:

shards - a consumer that will call methods on Shard.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• shards(java.util.Collection<Shard>)

nextToken

GetStreamResponse.Builder nextToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.