@Generated(value="software.amazon.awssdk:codegen") public final class ListShardsResponse extends KinesisResponse implements ToCopyableBuilder<ListShardsResponse.Builder,ListShardsResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
ListShardsResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static ListShardsResponse.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
SdkResponse. |
int |
hashCode() |
String |
nextToken()
When the number of shards in 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
shards in the data stream, the response includes a pagination token named NextToken. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListShardsResponse.Builder> |
serializableBuilderClass() |
List<Shard> |
shards()
An array of JSON objects.
|
ListShardsResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
responseMetadatasdkHttpResponsecopypublic List<Shard> shards()
An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String nextToken()
When the number of shards in 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
shards in the data stream, the response includes a pagination token named NextToken. You can specify
this NextToken value in a subsequent call to ListShards to list the next set of shards.
For more information about the use of this pagination token when calling the ListShards operation,
see ListShardsInput$NextToken.
Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to
ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to
ListShards, you get ExpiredNextTokenException.
MaxResults parameter, or if you explicitly specify a value for MaxResults that
is less than the number of shards in the data stream, the response includes a pagination token named
NextToken. You can specify this NextToken value in a subsequent call to
ListShards to list the next set of shards. For more information about the use of this
pagination token when calling the ListShards operation, see
ListShardsInput$NextToken.
Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a
call to ListShards, you have 300 seconds to use that value. If you specify an expired token
in a call to ListShards, you get ExpiredNextTokenException.
public ListShardsResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<ListShardsResponse.Builder,ListShardsResponse>toBuilder in class AwsResponsepublic static ListShardsResponse.Builder builder()
public static Class<? extends ListShardsResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. 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 SdkResponsefieldName - 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.