public static interface ListShardsRequest.Builder extends KinesisRequest.Builder, SdkPojo, CopyableBuilder<ListShardsRequest.Builder,ListShardsRequest>
Modifier and Type | Method and Description |
---|---|
ListShardsRequest.Builder |
exclusiveStartShardId(String exclusiveStartShardId)
Specify this parameter to indicate that you want to list the shards starting with the shard whose ID
immediately follows
ExclusiveStartShardId . |
ListShardsRequest.Builder |
maxResults(Integer maxResults)
The maximum number of shards to return in a single call to
ListShards . |
ListShardsRequest.Builder |
nextToken(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 . |
ListShardsRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
ListShardsRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
default ListShardsRequest.Builder |
shardFilter(Consumer<ShardFilter.Builder> shardFilter)
Sets the value of the ShardFilter property for this object.
|
ListShardsRequest.Builder |
shardFilter(ShardFilter shardFilter)
Sets the value of the ShardFilter property for this object.
|
ListShardsRequest.Builder |
streamCreationTimestamp(Instant streamCreationTimestamp)
Specify this input parameter to distinguish data streams that have the same name.
|
ListShardsRequest.Builder |
streamName(String streamName)
The name of the data stream whose shards you want to list.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
ListShardsRequest.Builder streamName(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.
streamName
- The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
ListShardsRequest.Builder nextToken(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
.
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
.
ListShardsRequest.Builder exclusiveStartShardId(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
- 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
.
ListShardsRequest.Builder maxResults(Integer maxResults)
The maximum number of shards to return in a single call to ListShards
. The minimum value you can
specify for this parameter is 1, and the maximum is 10,000, which is also the default.
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.
maxResults
- The maximum number of shards to return in a single call to ListShards
. The minimum value
you can specify for this parameter is 1, and the maximum is 10,000, which is also the default.
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.
ListShardsRequest.Builder streamCreationTimestamp(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.
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.
ListShardsRequest.Builder shardFilter(ShardFilter shardFilter)
shardFilter
- The new value for the ShardFilter property for this object.default ListShardsRequest.Builder shardFilter(Consumer<ShardFilter.Builder> shardFilter)
ShardFilter.Builder
avoiding the need to create
one manually via ShardFilter.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to shardFilter(ShardFilter)
.shardFilter
- a consumer that will call methods on ShardFilter.Builder
shardFilter(ShardFilter)
ListShardsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
ListShardsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2020. All rights reserved.