public static interface ListStreamConsumersResponse.Builder extends KinesisResponse.Builder, SdkPojo, CopyableBuilder<ListStreamConsumersResponse.Builder,ListStreamConsumersResponse>
Modifier and Type | Method and Description |
---|---|
ListStreamConsumersResponse.Builder |
consumers(Collection<Consumer> consumers)
An array of JSON objects.
|
ListStreamConsumersResponse.Builder |
consumers(Consumer... consumers)
An array of JSON objects.
|
ListStreamConsumersResponse.Builder |
consumers(Consumer<Consumer.Builder>... 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 . |
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
ListStreamConsumersResponse.Builder consumers(Collection<Consumer> consumers)
An array of JSON objects. Each object represents one registered consumer.
consumers
- An array of JSON objects. Each object represents one registered consumer.ListStreamConsumersResponse.Builder consumers(Consumer... consumers)
An array of JSON objects. Each object represents one registered consumer.
consumers
- An array of JSON objects. Each object represents one registered consumer.ListStreamConsumersResponse.Builder consumers(Consumer<Consumer.Builder>... consumers)
An array of JSON objects. Each object represents one registered consumer.
This is a convenience that creates an instance of theList.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #consumers(List)
.consumers
- a consumer that will call methods on List.Builder
#consumers(List)
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
.
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
.
Copyright © 2021. All rights reserved.