software.amazon.awssdk.services.kinesis.model

Interface DescribeStreamRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeStreamRequest

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

Method Summary

Modifier and Type	Method and 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	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeStreamRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeStreamRequest.Builder	streamARN(String streamARN) The ARN of the stream.
DescribeStreamRequest.Builder	streamName(String streamName) The name of the stream to describe.

Methods inherited from interface software.amazon.awssdk.services.kinesis.model.KinesisRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, 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 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

DescribeStreamRequest.Builder exclusiveStartShardId(String 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

DescribeStreamRequest.Builder streamARN(String 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder