Class GlobalSecondaryIndexUpdate

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

Represents one of the following:

  • A new global secondary index to be added to an existing table.

  • New provisioned throughput parameters for an existing global secondary index.

  • An existing global secondary index to be removed from an existing table.

See Also:

  • Method Details

    • update

      public final UpdateGlobalSecondaryIndexAction update()

      The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

      Returns:
      The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

    • create

      public final CreateGlobalSecondaryIndexAction create()

      The parameters required for creating a global secondary index on an existing table:

      • IndexName

      • KeySchema

      • AttributeDefinitions

      • Projection

      • ProvisionedThroughput

      Returns:
      The parameters required for creating a global secondary index on an existing table:

      • IndexName

      • KeySchema

      • AttributeDefinitions

      • Projection

      • ProvisionedThroughput

    • delete

      public final DeleteGlobalSecondaryIndexAction delete()

      The name of an existing global secondary index to be removed.

      Returns:
      The name of an existing global secondary index to be removed.

    • toBuilder

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

    • builder

      public static GlobalSecondaryIndexUpdate.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GlobalSecondaryIndexUpdate.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.