Interface DescribeStreamRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>, KinesisRequest.Builder, SdkBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeStreamRequest
@Mutable @NotThreadSafe public static interface DescribeStreamRequest.Builder extends KinesisRequest.Builder, SdkPojo, CopyableBuilder<DescribeStreamRequest.Builder,DescribeStreamRequest>

  • Method Details

    • 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)
      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.