@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) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasShards()
Returns true if the Shards property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
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() |
String |
toString()
Returns a string representation of this object.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasShards()
public final 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.
You can use hasShards()
to see if a value was sent in this field.
public final 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()
toBuilder
in interface ToCopyableBuilder<ListShardsResponse.Builder,ListShardsResponse>
toBuilder
in class AwsResponse
public static ListShardsResponse.Builder builder()
public static Class<? extends ListShardsResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2021. All rights reserved.