Interface ListShardsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListShardsRequest.Builder,ListShardsRequest>
,KinesisRequest.Builder
,SdkBuilder<ListShardsRequest.Builder,ListShardsRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- ListShardsRequest
public static interface ListShardsRequest.Builder extends KinesisRequest.Builder, SdkPojo, CopyableBuilder<ListShardsRequest.Builder,ListShardsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method 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 followsExclusiveStartShardId
.ListShardsRequest.Builder
maxResults(Integer maxResults)
The maximum number of shards to return in a single call toListShards
.ListShardsRequest.Builder
nextToken(String nextToken)
When the number of shards in the data stream is greater than the default value for theMaxResults
parameter, or if you explicitly specify a value forMaxResults
that is less than the number of shards in the data stream, the response includes a pagination token namedNextToken
.ListShardsRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListShardsRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default ListShardsRequest.Builder
shardFilter(Consumer<ShardFilter.Builder> shardFilter)
Enables you to filter out the response of theListShards
API.ListShardsRequest.Builder
shardFilter(ShardFilter shardFilter)
Enables you to filter out the response of theListShards
API.ListShardsRequest.Builder
streamARN(String streamARN)
The ARN of the stream.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.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.kinesis.model.KinesisRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
streamName
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.- Parameters:
streamName
- The name of the data stream whose shards you want to list.You cannot specify this parameter if you specify the
NextToken
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
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 forMaxResults
that is less than the number of shards in the data stream, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call toListShards
to list the next set of shards.Don't specify
StreamName
orStreamCreationTimestamp
if you specifyNextToken
because the latter unambiguously identifies the stream.You can optionally specify a value for the
MaxResults
parameter when you specifyNextToken
. If you specify aMaxResults
value that is less than the number of shards that the operation returns if you don't specifyMaxResults
, the response will contain a newNextToken
value. You can use the newNextToken
value in a subsequent call to theListShards
operation.Tokens expire after 300 seconds. When you obtain a value for
NextToken
in the response to a call toListShards
, you have 300 seconds to use that value. If you specify an expired token in a call toListShards
, you getExpiredNextTokenException
.- Parameters:
nextToken
- When the number of shards in the data stream is greater than the default value for theMaxResults
parameter, or if you explicitly specify a value forMaxResults
that is less than the number of shards in the data stream, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call toListShards
to list the next set of shards.Don't specify
StreamName
orStreamCreationTimestamp
if you specifyNextToken
because the latter unambiguously identifies the stream.You can optionally specify a value for the
MaxResults
parameter when you specifyNextToken
. If you specify aMaxResults
value that is less than the number of shards that the operation returns if you don't specifyMaxResults
, the response will contain a newNextToken
value. You can use the newNextToken
value in a subsequent call to theListShards
operation.Tokens expire after 300 seconds. When you obtain a value for
NextToken
in the response to a call toListShards
, you have 300 seconds to use that value. If you specify an expired token in a call toListShards
, you getExpiredNextTokenException
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exclusiveStartShardId
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
.- Parameters:
exclusiveStartShardId
- Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately followsExclusiveStartShardId
.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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
ListShardsRequest.Builder maxResults(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 aNextToken
value that you can use in a subsequent call toListShards
to list the next set of shards.- Parameters:
maxResults
- The maximum number of shards to return in a single call toListShards
. 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 aNextToken
value that you can use in a subsequent call toListShards
to list the next set of shards.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamCreationTimestamp
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
shardFilter
ListShardsRequest.Builder shardFilter(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, theType
is the required property and must be specified. If you specify theAT_TRIM_HORIZON
,FROM_TRIM_HORIZON
, orAT_LATEST
types, you do not need to specify either theShardId
or theTimestamp
optional properties.If you specify the
AFTER_SHARD_ID
type, you must also provide the value for the optionalShardId
property. TheShardId
property is identical in fuctionality to theExclusiveStartShardId
parameter of theListShards
API. WhenShardId
property is specified, the response includes the shards starting with the shard whose ID immediately follows theShardId
that you provided.If you specify the
AT_TIMESTAMP
orFROM_TIMESTAMP_ID
type, you must also provide the value for the optionalTimestamp
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.- Parameters:
shardFilter
- Enables you to filter out the response of theListShards
API. You can only specify one filter at a time.If you use the
ShardFilter
parameter when invoking the ListShards API, theType
is the required property and must be specified. If you specify theAT_TRIM_HORIZON
,FROM_TRIM_HORIZON
, orAT_LATEST
types, you do not need to specify either theShardId
or theTimestamp
optional properties.If you specify the
AFTER_SHARD_ID
type, you must also provide the value for the optionalShardId
property. TheShardId
property is identical in fuctionality to theExclusiveStartShardId
parameter of theListShards
API. WhenShardId
property is specified, the response includes the shards starting with the shard whose ID immediately follows theShardId
that you provided.If you specify the
AT_TIMESTAMP
orFROM_TIMESTAMP_ID
type, you must also provide the value for the optionalTimestamp
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
shardFilter
default ListShardsRequest.Builder shardFilter(Consumer<ShardFilter.Builder> 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, theType
is the required property and must be specified. If you specify theAT_TRIM_HORIZON
,FROM_TRIM_HORIZON
, orAT_LATEST
types, you do not need to specify either theShardId
or theTimestamp
optional properties.If you specify the
AFTER_SHARD_ID
type, you must also provide the value for the optionalShardId
property. TheShardId
property is identical in fuctionality to theExclusiveStartShardId
parameter of theListShards
API. WhenShardId
property is specified, the response includes the shards starting with the shard whose ID immediately follows theShardId
that you provided.If you specify the
This is a convenience method that creates an instance of theAT_TIMESTAMP
orFROM_TIMESTAMP_ID
type, you must also provide the value for the optionalTimestamp
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.ShardFilter.Builder
avoiding the need to create one manually viaShardFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toshardFilter(ShardFilter)
.- Parameters:
shardFilter
- a consumer that will call methods onShardFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
shardFilter(ShardFilter)
-
streamARN
ListShardsRequest.Builder streamARN(String streamARN)
The ARN of the stream.
- Parameters:
streamARN
- The ARN of the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListShardsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
ListShardsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-