@Generated(value="software.amazon.awssdk:codegen") public final class ListShardsRequest extends KinesisRequest implements ToCopyableBuilder<ListShardsRequest.Builder,ListShardsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ListShardsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static ListShardsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
exclusiveStartShardId()
Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately
follows
ExclusiveStartShardId . |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Integer |
maxResults()
The maximum number of shards to return in a single call to
ListShards . |
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 ListShardsRequest.Builder> |
serializableBuilderClass() |
ShardFilter |
shardFilter()
Enables you to filter out the response of the
ListShards API. |
String |
streamARN()
The ARN of the stream.
|
Instant |
streamCreationTimestamp()
Specify this input parameter to distinguish data streams that have the same name.
|
String |
streamName()
The name of the data stream whose shards you want to list.
|
ListShardsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String streamName()
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
You cannot specify this parameter if you specify the NextToken
parameter.
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.
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 shards
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
ListShards
operation.
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.
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
shards 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 ListShards
operation.
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 final String exclusiveStartShardId()
Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately
follows ExclusiveStartShardId
.
If you don't specify this parameter, the default behavior is for ListShards
to list the shards
starting with the first one in the stream.
You cannot specify this parameter if you specify NextToken
.
ExclusiveStartShardId
.
If you don't specify this parameter, the default behavior is for ListShards
to list the
shards starting with the first one in the stream.
You cannot specify this parameter if you specify NextToken
.
public final Integer maxResults()
The maximum number of shards to return in a single call to ListShards
. The maximum number of shards
to return in a single call. The default value is 1000. If you specify a value greater than 1000, at most 1000
results are returned.
When the number of shards to be listed is greater than the value of MaxResults
, the response
contains a NextToken
value that you can use in a subsequent call to ListShards
to list
the next set of shards.
ListShards
. The maximum number of
shards to return in a single call. The default value is 1000. If you specify a value greater than 1000,
at most 1000 results are returned.
When the number of shards to be listed is greater than the value of MaxResults
, the response
contains a NextToken
value that you can use in a subsequent call to ListShards
to list the next set of shards.
public final 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 shards for.
You cannot specify this parameter if you specify the NextToken
parameter.
You cannot specify this parameter if you specify the NextToken
parameter.
public final ShardFilter shardFilter()
Enables you to filter out the response of the ListShards
API. You can only specify one filter at a
time.
If you use the ShardFilter
parameter when invoking the ListShards API, the Type
is the
required property and must be specified. If you specify the AT_TRIM_HORIZON
,
FROM_TRIM_HORIZON
, or AT_LATEST
types, you do not need to specify either the
ShardId
or the Timestamp
optional properties.
If you specify the AFTER_SHARD_ID
type, you must also provide the value for the optional
ShardId
property. The ShardId
property is identical in fuctionality to the
ExclusiveStartShardId
parameter of the ListShards
API. When ShardId
property is specified, the response includes the shards starting with the shard whose ID immediately follows the
ShardId
that you provided.
If you specify the AT_TIMESTAMP
or FROM_TIMESTAMP_ID
type, you must also provide the
value for the optional Timestamp
property. If you specify the AT_TIMESTAMP type, then all shards
that were open at the provided timestamp are returned. If you specify the FROM_TIMESTAMP type, then all shards
starting from the provided timestamp to TIP are returned.
ListShards
API. You can only specify one
filter at a time.
If you use the ShardFilter
parameter when invoking the ListShards API, the Type
is the required property and must be specified. If you specify the AT_TRIM_HORIZON
,
FROM_TRIM_HORIZON
, or AT_LATEST
types, you do not need to specify either the
ShardId
or the Timestamp
optional properties.
If you specify the AFTER_SHARD_ID
type, you must also provide the value for the optional
ShardId
property. The ShardId
property is identical in fuctionality to the
ExclusiveStartShardId
parameter of the ListShards
API. When
ShardId
property is specified, the response includes the shards starting with the shard
whose ID immediately follows the ShardId
that you provided.
If you specify the AT_TIMESTAMP
or FROM_TIMESTAMP_ID
type, you must also
provide the value for the optional Timestamp
property. If you specify the AT_TIMESTAMP type,
then all shards that were open at the provided timestamp are returned. If you specify the FROM_TIMESTAMP
type, then all shards starting from the provided timestamp to TIP are returned.
public final String streamARN()
The ARN of the stream.
public ListShardsRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListShardsRequest.Builder,ListShardsRequest>
toBuilder
in class KinesisRequest
public static ListShardsRequest.Builder builder()
public static Class<? extends ListShardsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
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 SdkRequest
Copyright © 2023. All rights reserved.