Interface ListStreamConsumersResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<ListStreamConsumersResponse.Builder,
,ListStreamConsumersResponse> KinesisResponse.Builder
,SdkBuilder<ListStreamConsumersResponse.Builder,
,ListStreamConsumersResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
ListStreamConsumersResponse
-
Method Summary
Modifier and TypeMethodDescriptionconsumers
(Collection<Consumer> consumers) An array of JSON objects.consumers
(Consumer<Consumer.Builder>... consumers) An array of JSON objects.An array of JSON objects.When the number of consumers that are registered with the data stream is greater than the default value for theMaxResults
parameter, or if you explicitly specify a value forMaxResults
that is less than the number of registered consumers, the response includes a pagination token namedNextToken
.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 Details
-
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
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
An array of JSON objects. Each object represents one registered consumer.
This is a convenience method that creates an instance of theConsumer.Builder
avoiding the need to create one manually viaConsumer.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconsumers(List<Consumer>)
.- Parameters:
consumers
- a consumer that will call methods onConsumer.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 forMaxResults
that is less than the number of registered consumers, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call toListStreamConsumers
to list the next set of registered consumers. For more information about the use of this pagination token when calling theListStreamConsumers
operation, see ListStreamConsumersInput$NextToken.Tokens expire after 300 seconds. When you obtain a value for
NextToken
in the response to a call toListStreamConsumers
, you have 300 seconds to use that value. If you specify an expired token in a call toListStreamConsumers
, you getExpiredNextTokenException
.- Parameters:
nextToken
- When the number of consumers that are registered with the data stream is greater than the default value for theMaxResults
parameter, or if you explicitly specify a value forMaxResults
that is less than the number of registered consumers, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call toListStreamConsumers
to list the next set of registered consumers. For more information about the use of this pagination token when calling theListStreamConsumers
operation, see ListStreamConsumersInput$NextToken.Tokens expire after 300 seconds. When you obtain a value for
NextToken
in the response to a call toListStreamConsumers
, you have 300 seconds to use that value. If you specify an expired token in a call toListStreamConsumers
, you getExpiredNextTokenException
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-