Class GlobalSecondaryIndexDescription

java.lang.Object
com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexDescription
All Implemented Interfaces:
Serializable, Cloneable

public class GlobalSecondaryIndexDescription extends Object implements Serializable, Cloneable

Represents the properties of a global secondary index.

See Also:
  • Constructor Details

    • GlobalSecondaryIndexDescription

      public GlobalSecondaryIndexDescription()
  • Method Details

    • setIndexName

      public void setIndexName(String indexName)

      The name of the global secondary index.

      Parameters:
      indexName - The name of the global secondary index.
    • getIndexName

      public String getIndexName()

      The name of the global secondary index.

      Returns:
      The name of the global secondary index.
    • withIndexName

      public GlobalSecondaryIndexDescription withIndexName(String indexName)

      The name of the global secondary index.

      Parameters:
      indexName - The name of the global secondary index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getKeySchema

      public List<KeySchemaElement> getKeySchema()

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

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

    • setKeySchema

      public void setKeySchema(Collection<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' 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.

      Parameters:
      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' 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.

    • withKeySchema

      public GlobalSecondaryIndexDescription withKeySchema(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' 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.

      NOTE: This method appends the values to the existing list (if any). Use setKeySchema(java.util.Collection) or withKeySchema(java.util.Collection) if you want to override the existing values.

      Parameters:
      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' 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withKeySchema

      public GlobalSecondaryIndexDescription withKeySchema(Collection<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' 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.

      Parameters:
      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' 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setProjection

      public void setProjection(Projection projection)
      Parameters:
      projection -
    • getProjection

      public Projection getProjection()
      Returns:
    • withProjection

      public GlobalSecondaryIndexDescription withProjection(Projection projection)
      Parameters:
      projection -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setIndexStatus

      public void setIndexStatus(String 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.

      Parameters:
      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.

      See Also:
    • getIndexStatus

      public String getIndexStatus()

      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.

      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:
    • withIndexStatus

      public GlobalSecondaryIndexDescription withIndexStatus(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setIndexStatus

      public void setIndexStatus(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.

      Parameters:
      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.

      See Also:
    • withIndexStatus

      public GlobalSecondaryIndexDescription withIndexStatus(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setBackfilling

      public void setBackfilling(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.

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

      Parameters:
      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.

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

    • getBackfilling

      public Boolean getBackfilling()

      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.

      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.

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

    • withBackfilling

      public GlobalSecondaryIndexDescription withBackfilling(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.

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

      Parameters:
      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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isBackfilling

      public Boolean isBackfilling()

      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.

      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.

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

    • setProvisionedThroughput

      public void setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
      Parameters:
      provisionedThroughput -
    • getProvisionedThroughput

      public ProvisionedThroughputDescription getProvisionedThroughput()
      Returns:
    • withProvisionedThroughput

      public GlobalSecondaryIndexDescription withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
      Parameters:
      provisionedThroughput -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setIndexSizeBytes

      public void setIndexSizeBytes(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.

      Parameters:
      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.
    • getIndexSizeBytes

      public Long getIndexSizeBytes()

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

      public GlobalSecondaryIndexDescription withIndexSizeBytes(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • setItemCount

      public void setItemCount(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.

      Parameters:
      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.
    • getItemCount

      public Long getItemCount()

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

      public GlobalSecondaryIndexDescription withItemCount(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • setIndexArn

      public void setIndexArn(String indexArn)

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

      Parameters:
      indexArn - The Amazon Resource Name (ARN) that uniquely identifies the index.
    • getIndexArn

      public String getIndexArn()

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

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

      public GlobalSecondaryIndexDescription withIndexArn(String indexArn)

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

      Parameters:
      indexArn - The Amazon Resource Name (ARN) that uniquely identifies the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      Overrides:
      clone in class Object