Interface GetStreamResponse.Builder

All Superinterfaces:

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

Enclosing class:

GetStreamResponse

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

Method Summary

Modifier and Type	Method	Description
GetStreamResponse.Builder	arn(String arn)	The ARN of the retrieved stream.
GetStreamResponse.Builder	clusterIdentifier(String clusterIdentifier)	The ID of the cluster for the retrieved stream.
GetStreamResponse.Builder	creationTime(Instant creationTime)	The time when the stream was created.
GetStreamResponse.Builder	format(String format)	The format of the stream records.
GetStreamResponse.Builder	format(StreamFormat format)	The format of the stream records.
GetStreamResponse.Builder	ordering(String ordering)	The ordering mode of the stream.
GetStreamResponse.Builder	ordering(StreamOrdering ordering)	The ordering mode of the stream.
GetStreamResponse.Builder	status(String status)	The current status of the retrieved stream.
GetStreamResponse.Builder	status(StreamStatus status)	The current status of the retrieved stream.
default GetStreamResponse.Builder	statusReason(Consumer<StatusReason.Builder> statusReason)	Stream status reason with error code and timestamp (if applicable).
GetStreamResponse.Builder	statusReason(StatusReason statusReason)	Stream status reason with error code and timestamp (if applicable).
GetStreamResponse.Builder	streamIdentifier(String streamIdentifier)	The ID of the retrieved stream.
GetStreamResponse.Builder	tags(Map<String,String> tags)	A map of tags associated with the stream.
default GetStreamResponse.Builder	targetDefinition(Consumer<TargetDefinition.Builder> targetDefinition)	The target definition for the stream destination.
GetStreamResponse.Builder	targetDefinition(TargetDefinition targetDefinition)	The target definition for the stream destination.

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

copy

Methods inherited from interface software.amazon.awssdk.services.dsql.model.DsqlResponse.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

clusterIdentifier

GetStreamResponse.Builder clusterIdentifier(String clusterIdentifier)

The ID of the cluster for the retrieved stream.

Parameters:

clusterIdentifier - The ID of the cluster for the retrieved stream.

Returns:

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

streamIdentifier

GetStreamResponse.Builder streamIdentifier(String streamIdentifier)

The ID of the retrieved stream.

Parameters:

streamIdentifier - The ID of the retrieved stream.

Returns:

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

arn

GetStreamResponse.Builder arn(String arn)

The ARN of the retrieved stream.

Parameters:

arn - The ARN of the retrieved stream.

Returns:

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

status

GetStreamResponse.Builder status(String status)

The current status of the retrieved stream.

Parameters:

status - The current status of the retrieved stream.

Returns:

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

See Also:

• StreamStatus
• StreamStatus

status

GetStreamResponse.Builder status(StreamStatus status)

The current status of the retrieved stream.

Parameters:

status - The current status of the retrieved stream.

Returns:

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

See Also:

• StreamStatus
• StreamStatus

creationTime

GetStreamResponse.Builder creationTime(Instant creationTime)

The time when the stream was created.

Parameters:

creationTime - The time when the stream was created.

Returns:

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

ordering

GetStreamResponse.Builder ordering(String ordering)

The ordering mode of the stream.

Parameters:

ordering - The ordering mode of the stream.

Returns:

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

See Also:

• StreamOrdering
• StreamOrdering

ordering

GetStreamResponse.Builder ordering(StreamOrdering ordering)

The ordering mode of the stream.

Parameters:

ordering - The ordering mode of the stream.

Returns:

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

See Also:

• StreamOrdering
• StreamOrdering

format

GetStreamResponse.Builder format(String format)

The format of the stream records.

Parameters:

format - The format of the stream records.

Returns:

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

See Also:

• StreamFormat
• StreamFormat

format

GetStreamResponse.Builder format(StreamFormat format)

The format of the stream records.

Parameters:

format - The format of the stream records.

Returns:

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

See Also:

• StreamFormat
• StreamFormat

targetDefinition

GetStreamResponse.Builder targetDefinition(TargetDefinition targetDefinition)

The target definition for the stream destination.

Parameters:

targetDefinition - The target definition for the stream destination.

Returns:

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

targetDefinition

default GetStreamResponse.Builder targetDefinition(Consumer<TargetDefinition.Builder> targetDefinition)

The target definition for the stream destination.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetDefinition(TargetDefinition).

Parameters:

targetDefinition - a consumer that will call methods on TargetDefinition.Builder

Returns:

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

See Also:

• targetDefinition(TargetDefinition)

statusReason

GetStreamResponse.Builder statusReason(StatusReason statusReason)

Stream status reason with error code and timestamp (if applicable).

Parameters:

statusReason - Stream status reason with error code and timestamp (if applicable).

Returns:

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

statusReason

default GetStreamResponse.Builder statusReason(Consumer<StatusReason.Builder> statusReason)

Stream status reason with error code and timestamp (if applicable).

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to statusReason(StatusReason).

Parameters:

statusReason - a consumer that will call methods on StatusReason.Builder

Returns:

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

See Also:

• statusReason(StatusReason)

tags

GetStreamResponse.Builder tags(Map<String,String> tags)

A map of tags associated with the stream.

Parameters:

tags - A map of tags associated with the stream.

Returns:

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