Interface DescribeStreamRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeStreamRequest.Builder,
,DescribeStreamRequest> KinesisRequest.Builder
,SdkBuilder<DescribeStreamRequest.Builder,
,DescribeStreamRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeStreamRequest
-
Method Summary
Modifier and TypeMethodDescriptionexclusiveStartShardId
(String exclusiveStartShardId) The shard ID of the shard to start with.The maximum number of shards to return in a single call.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The ARN of the stream.streamName
(String streamName) The name of the stream to describe.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.kinesis.model.KinesisRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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 results 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 results are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exclusiveStartShardId
The shard ID of the shard to start with.
Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID immediately follows
ExclusiveStartShardId
.If you don't specify this parameter, the default behavior for
DescribeStream
is to describe the stream starting with the first shard in the stream.- Parameters:
exclusiveStartShardId
- The shard ID of the shard to start with.Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID immediately follows
ExclusiveStartShardId
.If you don't specify this parameter, the default behavior for
DescribeStream
is to describe the stream starting with the first shard in the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamARN
The ARN of the stream.
- Parameters:
streamARN
- The ARN of the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeStreamRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-