public class GlobalSecondaryIndexDescription
extends java.lang.Object
implements java.io.Serializable
Represents the properties of a global secondary index.
Constructor and Description |
---|
GlobalSecondaryIndexDescription() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.Boolean |
getBackfilling()
Indicates whether the index is currently backfilling.
|
java.lang.String |
getIndexArn()
The Amazon Resource Name (ARN) that uniquely identifies the index.
|
java.lang.String |
getIndexName()
The name of the global secondary index.
|
java.lang.Long |
getIndexSizeBytes()
The total size of the specified index, in bytes.
|
java.lang.String |
getIndexStatus()
The current state of the global secondary index:
|
java.lang.Long |
getItemCount()
The number of items in the specified index.
|
java.util.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:
|
Projection |
getProjection()
Represents attributes that are copied (projected) from the table into an
index.
|
ProvisionedThroughputDescription |
getProvisionedThroughput()
Represents the provisioned throughput settings for the table, consisting
of read and write capacity units, along with data about increases and
decreases.
|
int |
hashCode() |
java.lang.Boolean |
isBackfilling()
Indicates whether the index is currently backfilling.
|
void |
setBackfilling(java.lang.Boolean backfilling)
Indicates whether the index is currently backfilling.
|
void |
setIndexArn(java.lang.String indexArn)
The Amazon Resource Name (ARN) that uniquely identifies the index.
|
void |
setIndexName(java.lang.String indexName)
The name of the global secondary index.
|
void |
setIndexSizeBytes(java.lang.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(java.lang.String indexStatus)
The current state of the global secondary index:
|
void |
setItemCount(java.lang.Long itemCount)
The number of items in the specified index.
|
void |
setKeySchema(java.util.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)
Represents attributes that are copied (projected) from the table into an
index.
|
void |
setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
Represents the provisioned throughput settings for the table, consisting
of read and write capacity units, along with data about increases and
decreases.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GlobalSecondaryIndexDescription |
withBackfilling(java.lang.Boolean backfilling)
Indicates whether the index is currently backfilling.
|
GlobalSecondaryIndexDescription |
withIndexArn(java.lang.String indexArn)
The Amazon Resource Name (ARN) that uniquely identifies the index.
|
GlobalSecondaryIndexDescription |
withIndexName(java.lang.String indexName)
The name of the global secondary index.
|
GlobalSecondaryIndexDescription |
withIndexSizeBytes(java.lang.Long indexSizeBytes)
The total size of the specified index, in bytes.
|
GlobalSecondaryIndexDescription |
withIndexStatus(IndexStatus indexStatus)
The current state of the global secondary index:
|
GlobalSecondaryIndexDescription |
withIndexStatus(java.lang.String indexStatus)
The current state of the global secondary index:
|
GlobalSecondaryIndexDescription |
withItemCount(java.lang.Long itemCount)
The number of items in the specified index.
|
GlobalSecondaryIndexDescription |
withKeySchema(java.util.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:
|
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:
|
GlobalSecondaryIndexDescription |
withProjection(Projection projection)
Represents attributes that are copied (projected) from the table into an
index.
|
GlobalSecondaryIndexDescription |
withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
Represents the provisioned throughput settings for the table, consisting
of read and write capacity units, along with data about increases and
decreases.
|
public java.lang.String getIndexName()
The name of the global secondary index.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
The name of the global secondary index.
public void setIndexName(java.lang.String indexName)
The name of the global secondary index.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
indexName
- The name of the global secondary index.
public GlobalSecondaryIndexDescription withIndexName(java.lang.String indexName)
The name of the global secondary index.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
indexName
- The name of the global secondary index.
public java.util.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.
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.
public void setKeySchema(java.util.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.
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.
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.
Returns a reference to this object so that method calls can be chained together.
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.
public GlobalSecondaryIndexDescription withKeySchema(java.util.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.
Returns a reference to this object so that method calls can be chained together.
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.
public Projection getProjection()
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.
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.
public void setProjection(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.
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.
public GlobalSecondaryIndexDescription withProjection(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 a reference to this object so that method calls can be chained together.
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.
public java.lang.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.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
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.
IndexStatus
public void setIndexStatus(java.lang.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.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
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.
IndexStatus
public GlobalSecondaryIndexDescription withIndexStatus(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
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.
IndexStatus
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.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
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.
IndexStatus
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
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.
IndexStatus
public java.lang.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.
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.
public java.lang.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.
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.
public void setBackfilling(java.lang.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.
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.
public GlobalSecondaryIndexDescription withBackfilling(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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.
public ProvisionedThroughputDescription getProvisionedThroughput()
Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
public void setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
provisionedThroughput
- Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
public GlobalSecondaryIndexDescription withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
Returns a reference to this object so that method calls can be chained together.
provisionedThroughput
- Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
public java.lang.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.
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.
public void setIndexSizeBytes(java.lang.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.
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.
public GlobalSecondaryIndexDescription withIndexSizeBytes(java.lang.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 a reference to this object so that method calls can be chained together.
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.
public java.lang.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.
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.
public void setItemCount(java.lang.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.
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.
public GlobalSecondaryIndexDescription withItemCount(java.lang.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 a reference to this object so that method calls can be chained together.
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.
public java.lang.String getIndexArn()
The Amazon Resource Name (ARN) that uniquely identifies the index.
The Amazon Resource Name (ARN) that uniquely identifies the index.
public void setIndexArn(java.lang.String indexArn)
The Amazon Resource Name (ARN) that uniquely identifies the index.
indexArn
- The Amazon Resource Name (ARN) that uniquely identifies the index.
public GlobalSecondaryIndexDescription withIndexArn(java.lang.String indexArn)
The Amazon Resource Name (ARN) that uniquely identifies the index.
Returns a reference to this object so that method calls can be chained together.
indexArn
- The Amazon Resource Name (ARN) that uniquely identifies the index.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.