Class ReplicaGlobalSecondaryIndexSettingsDescription

java.lang.Object
software.amazon.awssdk.services.dynamodb.model.ReplicaGlobalSecondaryIndexSettingsDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,ReplicaGlobalSecondaryIndexSettingsDescription>
@Generated("software.amazon.awssdk:codegen") public final class ReplicaGlobalSecondaryIndexSettingsDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,ReplicaGlobalSecondaryIndexSettingsDescription>

Represents the properties of a global secondary index.

See Also:

  • Method Details

    • indexName

      public final String indexName()

      The name of the global secondary index. The name must be unique among all other indexes on this table.

      Returns:
      The name of the global secondary index. The name must be unique among all other indexes on this table.

    • indexStatus

      public final IndexStatus indexStatus()

      The current status of the global secondary index:

      • CREATING - The global secondary index is being created.

      • UPDATING - The global secondary index is being updated.

      • DELETING - The global secondary index is being deleted.

      • ACTIVE - The global secondary index is ready for use.

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

      Returns:
      The current status of the global secondary index:

      • CREATING - The global secondary index is being created.

      • UPDATING - The global secondary index is being updated.

      • DELETING - The global secondary index is being deleted.

      • ACTIVE - The global secondary index is ready for use.

      See Also:

    • indexStatusAsString

      public final String indexStatusAsString()

      The current status of the global secondary index:

      • CREATING - The global secondary index is being created.

      • UPDATING - The global secondary index is being updated.

      • DELETING - The global secondary index is being deleted.

      • ACTIVE - The global secondary index is ready for use.

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

      Returns:
      The current status of the global secondary index:

      • CREATING - The global secondary index is being created.

      • UPDATING - The global secondary index is being updated.

      • DELETING - The global secondary index is being deleted.

      • ACTIVE - The global secondary index is ready for use.

      See Also:

    • provisionedReadCapacityUnits

      public final Long provisionedReadCapacityUnits()

      The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

      Returns:
      The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

    • provisionedReadCapacityAutoScalingSettings

      public final AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings()

      Auto scaling settings for a global secondary index replica's read capacity units.

      Returns:
      Auto scaling settings for a global secondary index replica's read capacity units.

    • provisionedWriteCapacityUnits

      public final Long provisionedWriteCapacityUnits()

      The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

      Returns:
      The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

    • provisionedWriteCapacityAutoScalingSettings

      public final AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings()

      Auto scaling settings for a global secondary index replica's write capacity units.

      Returns:
      Auto scaling settings for a global secondary index replica's write capacity units.

    • toBuilder

      public ReplicaGlobalSecondaryIndexSettingsDescription.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<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,ReplicaGlobalSecondaryIndexSettingsDescription>
      Returns:
      a builder for type T

    • builder

      public static ReplicaGlobalSecondaryIndexSettingsDescription.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.