Class UpdateShardCountRequest

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.UpdateShardCountRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateShardCountRequest.Builder,UpdateShardCountRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateShardCountRequest extends KinesisRequest implements ToCopyableBuilder<UpdateShardCountRequest.Builder,UpdateShardCountRequest>

  • Method Details

    • streamName

      public final String streamName()

      The name of the stream.

      Returns:
      The name of the stream.

    • targetShardCount

      public final Integer targetShardCount()

      The new number of shards. This value has the following default limits. By default, you cannot do the following:

      • Set this value to more than double your current shard count for a stream.

      • Set this value below half your current shard count for a stream.

      • Set this value to more than 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.

      • Scale a stream with more than 10000 shards down unless you set this value to less than 10000 shards.

      Returns:
      The new number of shards. This value has the following default limits. By default, you cannot do the following:

      • Set this value to more than double your current shard count for a stream.

      • Set this value below half your current shard count for a stream.

      • Set this value to more than 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.

      • Scale a stream with more than 10000 shards down unless you set this value to less than 10000 shards.

    • scalingType

      public final ScalingType scalingType()

      The scaling type. Uniform scaling creates shards of equal size.

      If the service returns an enum value that is not available in the current SDK version, scalingType will return ScalingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingTypeAsString().

      Returns:
      The scaling type. Uniform scaling creates shards of equal size.
      See Also:

    • scalingTypeAsString

      public final String scalingTypeAsString()

      The scaling type. Uniform scaling creates shards of equal size.

      If the service returns an enum value that is not available in the current SDK version, scalingType will return ScalingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingTypeAsString().

      Returns:
      The scaling type. Uniform scaling creates shards of equal size.
      See Also:

    • streamARN

      public final String streamARN()

      The ARN of the stream.

      Returns:
      The ARN of the stream.

    • toBuilder

      public UpdateShardCountRequest.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<UpdateShardCountRequest.Builder,UpdateShardCountRequest>
      Specified by:
      toBuilder in class KinesisRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateShardCountRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateShardCountRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.