Interface DescribeStreamRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>, DynamoDbStreamsRequest.Builder, SdkBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeStreamRequest

@Mutable
@NotThreadSafe
public static interface DescribeStreamRequest.Builder
extends DynamoDbStreamsRequest.Builder, SdkPojo, CopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>

Method Summary

Modifier and Type	Method	Description
DescribeStreamRequest.Builder	exclusiveStartShardId(String exclusiveStartShardId)	The shard ID of the first item that this operation will evaluate.
DescribeStreamRequest.Builder	limit(Integer limit)	The maximum number of shard objects to return.
DescribeStreamRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DescribeStreamRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default DescribeStreamRequest.Builder	shardFilter(Consumer<ShardFilter.Builder> shardFilter)	This optional field contains the filter definition for the DescribeStream API.
DescribeStreamRequest.Builder	shardFilter(ShardFilter shardFilter)	This optional field contains the filter definition for the DescribeStream API.
DescribeStreamRequest.Builder	streamArn(String streamArn)	The Amazon Resource Name (ARN) for the stream.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.dynamodb.model.DynamoDbStreamsRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

streamArn

DescribeStreamRequest.Builder streamArn(String streamArn)

The Amazon Resource Name (ARN) for the stream.

Parameters:

streamArn - The Amazon Resource Name (ARN) for the stream.

Returns:

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

limit

DescribeStreamRequest.Builder limit(Integer limit)

The maximum number of shard objects to return. The upper limit is 100.

Parameters:

limit - The maximum number of shard objects to return. The upper limit is 100.

Returns:

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

exclusiveStartShardId

DescribeStreamRequest.Builder exclusiveStartShardId(String exclusiveStartShardId)

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Parameters:

exclusiveStartShardId - The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Returns:

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

shardFilter

DescribeStreamRequest.Builder shardFilter(ShardFilter shardFilter)

This optional field contains the filter definition for the DescribeStream API.

Parameters:

shardFilter - This optional field contains the filter definition for the DescribeStream API.

Returns:

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

shardFilter

default DescribeStreamRequest.Builder shardFilter(Consumer<ShardFilter.Builder> shardFilter)

This optional field contains the filter definition for the DescribeStream API.

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

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

Parameters:

shardFilter - a consumer that will call methods on ShardFilter.Builder

Returns:

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

See Also:

• shardFilter(ShardFilter)

overrideConfiguration

DescribeStreamRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

DescribeStreamRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.