Class CreateGlobalSecondaryIndexAction

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

Represents a new global secondary index to be added to an existing table.

See Also:

  • Method Details

    • indexName

      public final String indexName()

      The name of the global secondary index to be created.

      Returns:
      The name of the global secondary index to be created.

    • hasKeySchema

      public final boolean hasKeySchema()
      For responses, this returns true if the service returned a value for the KeySchema property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • keySchema

      public final List<KeySchemaElement> keySchema()

      The key schema for the global secondary index.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasKeySchema() method.

      Returns:
      The key schema for the global secondary index.

    • projection

      public final Projection projection()

      Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

      Returns:
      Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

    • provisionedThroughput

      public final ProvisionedThroughput provisionedThroughput()

      Represents the provisioned throughput settings for the specified global secondary index.

      For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

      Returns:
      Represents the provisioned throughput settings for the specified global secondary index.

      For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

    • onDemandThroughput

      public final OnDemandThroughput onDemandThroughput()

      The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemand Throughput or ProvisionedThroughput based on your table's capacity mode.

      Returns:
      The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemand Throughput or ProvisionedThroughput based on your table's capacity mode.

    • warmThroughput

      public final WarmThroughput warmThroughput()

      Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.

      Returns:
      Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.

    • toBuilder

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

    • builder

      public static CreateGlobalSecondaryIndexAction.Builder builder()

    • serializableBuilderClass

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