@Generated(value="software.amazon.awssdk:codegen") public final class ListStreamConsumersResponse extends KinesisResponse implements ToCopyableBuilder<ListStreamConsumersResponse.Builder,ListStreamConsumersResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
ListStreamConsumersResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static ListStreamConsumersResponse.Builder |
builder() |
List<Consumer> |
consumers()
An array of JSON objects.
|
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
SdkResponse . |
int |
hashCode() |
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 . |
static Class<? extends ListStreamConsumersResponse.Builder> |
serializableBuilderClass() |
ListStreamConsumersResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
sdkHttpResponse
copy
public List<Consumer> consumers()
An array of JSON objects. Each object represents one registered consumer.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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 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
.
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
.
public ListStreamConsumersResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ListStreamConsumersResponse.Builder,ListStreamConsumersResponse>
toBuilder
in class AwsResponse
public static ListStreamConsumersResponse.Builder builder()
public static Class<? extends ListStreamConsumersResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. 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 SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- 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.