Package software.amazon.awssdk.services.kinesis.model

Class SplitShardRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.kinesis.model.SplitShardRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<SplitShardRequest.Builder,SplitShardRequest>

@Generated("software.amazon.awssdk:codegen")
public class SplitShardRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<SplitShardRequest.Builder,SplitShardRequest>

Represents the input for SplitShard.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SplitShardRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static SplitShardRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	newStartingHashKey()	A hash key value for the starting hash key of one of the child shards created by the split.
static Class<? extends SplitShardRequest.Builder>	serializableBuilderClass()
String	shardToSplit()	The shard ID of the shard to split.
String	streamName()	The name of the stream for the shard split.
SplitShardRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

streamName

public String streamName()

The name of the stream for the shard split.

Returns:

The name of the stream for the shard split.

shardToSplit

public String shardToSplit()

The shard ID of the shard to split.

Returns:

The shard ID of the shard to split.

newStartingHashKey

public String 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. The NewStartingHashKey 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:

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. The NewStartingHashKey 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.

toBuilder

public SplitShardRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SplitShardRequest.Builder,SplitShardRequest>

Returns:

a builder for type T

builder

public static SplitShardRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SplitShardRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object