Class GlobalSecondaryIndexDescription
- All Implemented Interfaces:
Serializable
,Cloneable
Represents the properties of a global secondary index.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Indicates whether the index is currently backfilling.The Amazon Resource Name (ARN) that uniquely identifies the index.The name of the global secondary index.The total size of the specified index, in bytes.The current state of the global secondary index:The number of items in the specified index.The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:int
hashCode()
Indicates whether the index is currently backfilling.void
setBackfilling
(Boolean backfilling) Indicates whether the index is currently backfilling.void
setIndexArn
(String indexArn) The Amazon Resource Name (ARN) that uniquely identifies the index.void
setIndexName
(String indexName) The name of the global secondary index.void
setIndexSizeBytes
(Long indexSizeBytes) The total size of the specified index, in bytes.void
setIndexStatus
(IndexStatus indexStatus) The current state of the global secondary index:void
setIndexStatus
(String indexStatus) The current state of the global secondary index:void
setItemCount
(Long itemCount) The number of items in the specified index.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:void
setProjection
(Projection projection) void
setProvisionedThroughput
(ProvisionedThroughputDescription provisionedThroughput) toString()
Returns a string representation of this object; useful for testing and debugging.withBackfilling
(Boolean backfilling) Indicates whether the index is currently backfilling.withIndexArn
(String indexArn) The Amazon Resource Name (ARN) that uniquely identifies the index.withIndexName
(String indexName) The name of the global secondary index.withIndexSizeBytes
(Long indexSizeBytes) The total size of the specified index, in bytes.withIndexStatus
(IndexStatus indexStatus) The current state of the global secondary index:withIndexStatus
(String indexStatus) The current state of the global secondary index:withItemCount
(Long itemCount) The number of items in the specified index.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: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:withProjection
(Projection projection) withProvisionedThroughput
(ProvisionedThroughputDescription provisionedThroughput)
-
Constructor Details
-
GlobalSecondaryIndexDescription
public GlobalSecondaryIndexDescription()
-
-
Method Details
-
setIndexName
The name of the global secondary index.
- Parameters:
indexName
- The name of the global secondary index.
-
getIndexName
The name of the global secondary index.
- Returns:
- The name of the global secondary index.
-
withIndexName
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
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
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
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)
orwithKeySchema(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
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
- Parameters:
projection
-
-
getProjection
- Returns:
-
withProjection
- Parameters:
projection
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIndexStatus
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
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
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
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
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
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
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
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
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
- Parameters:
provisionedThroughput
-
-
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
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
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
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
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
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
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
The Amazon Resource Name (ARN) that uniquely identifies the index.
- Parameters:
indexArn
- The Amazon Resource Name (ARN) that uniquely identifies the index.
-
getIndexArn
The Amazon Resource Name (ARN) that uniquely identifies the index.
- Returns:
- The Amazon Resource Name (ARN) that uniquely identifies the index.
-
withIndexArn
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-