Interface GetStreamRequest.Builder

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

  • Method Details

    • streamArn

      GetStreamRequest.Builder streamArn(String streamArn)

      The Amazon Resource Name (ARN) of the stream for which detailed information is requested. This uniquely identifies the specific stream you want to get information about.

      Parameters:
      streamArn - The Amazon Resource Name (ARN) of the stream for which detailed information is requested. This uniquely identifies the specific stream you want to get information about.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetStreamRequest.Builder maxResults(Integer maxResults)

      The maximum number of shard objects to return in a single GetStream request. Default value is 100. The minimum value is 1 and the maximum value is 100.

      Parameters:
      maxResults - The maximum number of shard objects to return in a single GetStream request. Default value is 100. The minimum value is 1 and the maximum value is 100.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shardFilter

      GetStreamRequest.Builder shardFilter(ShardFilter shardFilter)

      Optional filter criteria to apply when retrieving shards. You can filter shards based on their state or other attributes to narrow down the results returned by the GetStream operation.

      Parameters:
      shardFilter - Optional filter criteria to apply when retrieving shards. You can filter shards based on their state or other attributes to narrow down the results returned by the GetStream operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shardFilter

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

      Optional filter criteria to apply when retrieving shards. You can filter shards based on their state or other attributes to narrow down the results returned by the GetStream operation.

      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:

    • nextToken

      GetStreamRequest.Builder nextToken(String nextToken)

      An optional pagination token provided by a previous GetStream operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by maxResults.

      Parameters:
      nextToken - An optional pagination token provided by a previous GetStream operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by maxResults.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetStreamRequest.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

      GetStreamRequest.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.