Interface SplitShardRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SplitShardRequest.Builder,
,SplitShardRequest> KinesisRequest.Builder
,SdkBuilder<SplitShardRequest.Builder,
,SplitShardRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SplitShardRequest
public static interface SplitShardRequest.Builder
extends KinesisRequest.Builder, SdkPojo, CopyableBuilder<SplitShardRequest.Builder,SplitShardRequest>
-
Method Summary
Modifier and TypeMethodDescriptionnewStartingHashKey
(String newStartingHashKey) A hash key value for the starting hash key of one of the child shards created by the split.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.shardToSplit
(String shardToSplit) The shard ID of the shard to split.The ARN of the stream.streamName
(String streamName) The name of the stream for the shard split.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 Details
-
streamName
The name of the stream for the shard split.
- Parameters:
streamName
- The name of the stream for the shard split.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
shardToSplit
The shard ID of the shard to split.
- Parameters:
shardToSplit
- The shard ID of the shard to split.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
newStartingHashKey
A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for
NewStartingHashKey
must be in the range of hash keys being mapped into the shard. TheNewStartingHashKey
hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.- Parameters:
newStartingHashKey
- A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value forNewStartingHashKey
must be in the range of hash keys being mapped into the shard. TheNewStartingHashKey
hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
SplitShardRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SplitShardRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-