Interface ListStreamConsumersRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListStreamConsumersRequest.Builder,
,ListStreamConsumersRequest> KinesisRequest.Builder
,SdkBuilder<ListStreamConsumersRequest.Builder,
,ListStreamConsumersRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListStreamConsumersRequest
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults
(Integer maxResults) The maximum number of consumers that you want a single call ofListStreamConsumers
to return.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 consumers that are registered with the data stream, the response includes a pagination token namedNextToken
.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The ARN of the Kinesis data stream for which you want to list the registered consumers.streamCreationTimestamp
(Instant streamCreationTimestamp) Specify this input parameter to distinguish data streams that have the same name.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kinesis.model.KinesisRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 Amazon Web Services Service Namespaces.
- Parameters:
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 Amazon Web Services Service Namespaces.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 consumers that are registered with the data stream, 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.Don't specify
StreamName
orStreamCreationTimestamp
if you specifyNextToken
because the latter unambiguously identifies the stream.You can optionally specify a value for the
MaxResults
parameter when you specifyNextToken
. If you specify aMaxResults
value that is less than the number of consumers that the operation returns if you don't specifyMaxResults
, the response will contain a newNextToken
value. You can use the newNextToken
value in a subsequent call to theListStreamConsumers
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 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 consumers that are registered with the data stream, 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.Don't specify
StreamName
orStreamCreationTimestamp
if you specifyNextToken
because the latter unambiguously identifies the stream.You can optionally specify a value for the
MaxResults
parameter when you specifyNextToken
. If you specify aMaxResults
value that is less than the number of consumers that the operation returns if you don't specifyMaxResults
, the response will contain a newNextToken
value. You can use the newNextToken
value in a subsequent call to theListStreamConsumers
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 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.
-
maxResults
The maximum number of consumers that you want a single call of
ListStreamConsumers
to return. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.- Parameters:
maxResults
- The maximum number of consumers that you want a single call ofListStreamConsumers
to return. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListStreamConsumersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListStreamConsumersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-