Package software.amazon.awssdk.services.kinesis.model

Interface DescribeStreamRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>, SdkBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>

Enclosing class:

DescribeStreamRequest

public static interface DescribeStreamRequest.Builder
extends CopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>

Method Summary

Modifier and Type	Method	Description
DescribeStreamRequest.Builder	exclusiveStartShardId(String exclusiveStartShardId)	The shard ID of the shard to start with.
DescribeStreamRequest.Builder	limit(Integer limit)	The maximum number of shards to return in a single call.
DescribeStreamRequest.Builder	streamName(String streamName)	The name of the stream to describe.

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

copy

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

apply, build

Method Detail

streamName

DescribeStreamRequest.Builder streamName(String streamName)

The name of the stream to describe.

Parameters:

streamName - The name of the stream to describe.

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 shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

Parameters:

limit - The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

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 shard to start with.

Parameters:

exclusiveStartShardId - The shard ID of the shard to start with.

Returns:

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