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

Interface ListStreamConsumersResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<ListStreamConsumersResponse.Builder,ListStreamConsumersResponse>, KinesisResponse.Builder, SdkBuilder<ListStreamConsumersResponse.Builder,ListStreamConsumersResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ListStreamConsumersResponse

public static interface ListStreamConsumersResponse.Builder
extends KinesisResponse.Builder, SdkPojo, CopyableBuilder<ListStreamConsumersResponse.Builder,ListStreamConsumersResponse>

Method Summary

Modifier and Type	Method	Description
ListStreamConsumersResponse.Builder	consumers(Collection<Consumer> consumers)	An array of JSON objects.
ListStreamConsumersResponse.Builder	consumers(Consumer<Consumer.Builder>... consumers)	An array of JSON objects.
ListStreamConsumersResponse.Builder	consumers(Consumer... consumers)	An array of JSON objects.
ListStreamConsumersResponse.Builder	nextToken(String nextToken)	When the number of consumers that are registered with 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 registered consumers, the response includes a pagination token named NextToken.

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

copy

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

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

consumers

ListStreamConsumersResponse.Builder consumers(Collection<Consumer> consumers)

An array of JSON objects. Each object represents one registered consumer.

Parameters:

consumers - An array of JSON objects. Each object represents one registered consumer.

Returns:

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

consumers

ListStreamConsumersResponse.Builder consumers(Consumer... consumers)

An array of JSON objects. Each object represents one registered consumer.

Parameters:

consumers - An array of JSON objects. Each object represents one registered consumer.

Returns:

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

consumers

ListStreamConsumersResponse.Builder consumers(Consumer<Consumer.Builder>... consumers)

An array of JSON objects. Each object represents one registered consumer.

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

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

Parameters:

consumers - a consumer that will call methods on Consumer.Builder

Returns:

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

See Also:

#consumers(java.util.Collection)

nextToken

ListStreamConsumersResponse.Builder nextToken(String nextToken)

When the number of consumers that are registered with 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 registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

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

Parameters:

nextToken - When the number of consumers that are registered with 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 registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

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

Returns:

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