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

Interface ListShardsResponse.Builder

    • Method Detail

      • shards

        ListShardsResponse.Builder shards​(Collection<Shard> shards)

        An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

        Parameters:
        shards - An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shards

        ListShardsResponse.Builder shards​(Shard... shards)

        An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

        Parameters:
        shards - An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shards

        ListShardsResponse.Builder shards​(Consumer<Shard.Builder>... shards)

        An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

        This is a convenience method that creates an instance of the Shard.Builder avoiding the need to create one manually via Shard.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #shards(List).

        Parameters:
        shards - a consumer that will call methods on Shard.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #shards(java.util.Collection)

      • nextToken

        ListShardsResponse.Builder nextToken​(String nextToken)

        When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

        Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.

        Parameters:
        nextToken - When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

        Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.

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