@Generated(value="software.amazon.awssdk:codegen") public final class ListStreamConsumersRequest extends KinesisRequest implements ToCopyableBuilder<ListStreamConsumersRequest.Builder,ListStreamConsumersRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
ListStreamConsumersRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static ListStreamConsumersRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
Integer |
maxResults()
The maximum number of consumers that you want a single call of
ListStreamConsumers to return. |
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. |
static Class<? extends ListStreamConsumersRequest.Builder> |
serializableBuilderClass() |
String |
streamARN()
The ARN of the Kinesis data stream for which you want to list the registered consumers.
|
Instant |
streamCreationTimestamp()
Specify this input parameter to distinguish data streams that have the same name.
|
ListStreamConsumersRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfigurationcopypublic 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.
public 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.
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.
public Integer maxResults()
The maximum number of consumers that you want a single call of ListStreamConsumers to return.
ListStreamConsumers to
return.public 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.
You can't specify this parameter if you specify the NextToken parameter.
public ListStreamConsumersRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<ListStreamConsumersRequest.Builder,ListStreamConsumersRequest>toBuilder in class KinesisRequestpublic static ListStreamConsumersRequest.Builder builder()
public static Class<? extends ListStreamConsumersRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.