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

Class SplitShardRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.kinesis.model.KinesisRequest
software.amazon.awssdk.services.kinesis.model.SplitShardRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SplitShardRequest.Builder,SplitShardRequest>
@Generated("software.amazon.awssdk:codegen") public final class SplitShardRequest extends KinesisRequest implements ToCopyableBuilder<SplitShardRequest.Builder,SplitShardRequest>

Represents the input for SplitShard.

  • Method Details

    • streamName

      public final String streamName()

      The name of the stream for the shard split.

      Returns:
      The name of the stream for the shard split.

    • shardToSplit

      public final String shardToSplit()

      The shard ID of the shard to split.

      Returns:
      The shard ID of the shard to split.

    • newStartingHashKey

      public final 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.

    • streamARN

      public final String streamARN()

      The ARN of the stream.

      Returns:
      The ARN of the stream.

    • streamId

      public final String streamId()

      Not Implemented. Reserved for future use.

      Returns:
      Not Implemented. Reserved for future use.

    • toBuilder

      public SplitShardRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<SplitShardRequest.Builder,SplitShardRequest>
      Specified by:
      toBuilder in class KinesisRequest

    • builder

      public static SplitShardRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo