Class GlobalSecondaryIndexDescription

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

Represents the properties of a global secondary index.

See Also:

  • Method Details

    • indexName

      public final String indexName()

      The name of the global secondary index.

      Returns:
      The name of the global secondary index.

    • 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 complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

      • HASH - partition key

      • RANGE - sort key

      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

      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 complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

      • HASH - partition key

      • RANGE - sort key

      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

    • projection

      public final Projection projection()

      Represents attributes that are copied (projected) from the table into the global secondary 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 the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

    • indexStatus

      public final IndexStatus indexStatus()

      The current state of the global secondary index:

      • CREATING - The index is being created.

      • UPDATING - The index is being updated.

      • DELETING - The index is being deleted.

      • ACTIVE - The 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 state of the global secondary index:

      • CREATING - The index is being created.

      • UPDATING - The index is being updated.

      • DELETING - The index is being deleted.

      • ACTIVE - The index is ready for use.

      See Also:

    • indexStatusAsString

      public final String indexStatusAsString()

      The current state of the global secondary index:

      • CREATING - The index is being created.

      • UPDATING - The index is being updated.

      • DELETING - The index is being deleted.

      • ACTIVE - The 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 state of the global secondary index:

      • CREATING - The index is being created.

      • UPDATING - The index is being updated.

      • DELETING - The index is being deleted.

      • ACTIVE - The index is ready for use.

      See Also:

    • backfilling

      public final Boolean backfilling()

      Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

      You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false.

      For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.

      Returns:
      Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

      You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false.

      For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.

    • provisionedThroughput

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

    • indexSizeBytes

      public final Long indexSizeBytes()

      The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

      Returns:
      The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

    • itemCount

      public final Long itemCount()

      The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

      Returns:
      The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

    • indexArn

      public final String indexArn()

      The Amazon Resource Name (ARN) that uniquely identifies the index.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies the index.

    • onDemandThroughput

      public final OnDemandThroughput onDemandThroughput()

      The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

      Returns:
      The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

    • toBuilder

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

    • builder

      public static GlobalSecondaryIndexDescription.Builder builder()

    • serializableBuilderClass

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