@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListShardsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
ListShardsResult() |
Modifier and Type | Method and Description |
---|---|
ListShardsResult |
clone() |
boolean |
equals(Object obj) |
String |
getNextToken()
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<Shard> |
getShards()
An array of JSON objects.
|
int |
hashCode() |
void |
setNextToken(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 . |
void |
setShards(Collection<Shard> shards)
An array of JSON objects.
|
String |
toString()
Returns a string representation of this object.
|
ListShardsResult |
withNextToken(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 . |
ListShardsResult |
withShards(Collection<Shard> shards)
An array of JSON objects.
|
ListShardsResult |
withShards(Shard... shards)
An array of JSON objects.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public List<Shard> getShards()
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.
public void setShards(Collection<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.
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.public ListShardsResult withShards(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.
NOTE: This method appends the values to the existing list (if any). Use
setShards(java.util.Collection)
or withShards(java.util.Collection)
if you want to override the
existing values.
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.public ListShardsResult withShards(Collection<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.
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.public void setNextToken(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
.
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
.
public String getNextToken()
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 ListShardsResult withNextToken(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
.
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
.
public String toString()
toString
in class Object
Object.toString()
public ListShardsResult clone()