public static interface ListStreamConsumersRequest.Builder extends KinesisRequest.Builder, SdkPojo, CopyableBuilder<ListStreamConsumersRequest.Builder,ListStreamConsumersRequest>
Modifier and Type | Method and Description |
---|---|
ListStreamConsumersRequest.Builder |
maxResults(Integer maxResults)
The maximum number of consumers that you want a single call of
ListStreamConsumers to return. |
ListStreamConsumersRequest.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 consumers that are registered with the data stream, the response includes a
pagination token named NextToken . |
ListStreamConsumersRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
ListStreamConsumersRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
ListStreamConsumersRequest.Builder |
streamARN(String streamARN)
The ARN of the Kinesis data stream for which you want to list the registered consumers.
|
ListStreamConsumersRequest.Builder |
streamCreationTimestamp(Instant streamCreationTimestamp)
Specify this input parameter to distinguish data streams that have the same name.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
ListStreamConsumersRequest.Builder streamARN(String streamARN)
The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
streamARN
- The ARN of the Kinesis data stream for which you want to list the registered consumers. For more
information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.ListStreamConsumersRequest.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 consumers that are registered with the data stream, 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.
Don't specify StreamName
or StreamCreationTimestamp
if you specify
NextToken
because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults
parameter when you specify
NextToken
. If you specify a MaxResults
value that is less than the number of
consumers that the operation returns if you don't specify MaxResults
, the response will contain
a new NextToken
value. You can use the new NextToken
value in a subsequent call to
the ListStreamConsumers
operation to list the next set of consumers.
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 consumers that are registered with the data
stream, 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.
Don't specify StreamName
or StreamCreationTimestamp
if you specify
NextToken
because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults
parameter when you specify
NextToken
. If you specify a MaxResults
value that is less than the number of
consumers that the operation returns if you don't specify MaxResults
, the response will
contain a new NextToken
value. You can use the new NextToken
value in a
subsequent call to the ListStreamConsumers
operation to list the next set of consumers.
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
.
ListStreamConsumersRequest.Builder maxResults(Integer maxResults)
The maximum number of consumers that you want a single call of ListStreamConsumers
to return.
maxResults
- The maximum number of consumers that you want a single call of ListStreamConsumers
to
return.ListStreamConsumersRequest.Builder streamCreationTimestamp(Instant streamCreationTimestamp)
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.
You can't specify this parameter if you specify the NextToken parameter.
streamCreationTimestamp
- Specify this input parameter to distinguish data streams that have the same name. For example, if you
create a data stream and then delete it, and you later create another data stream with the same name,
you can use this input parameter to specify which of the two streams you want to list the consumers
for.
You can't specify this parameter if you specify the NextToken parameter.
ListStreamConsumersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
ListStreamConsumersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2019. All rights reserved.