public class GlobalSecondaryIndexDescription extends Object implements Serializable, Cloneable
Represents the properties of a global secondary index.
Constructor and Description |
---|
GlobalSecondaryIndexDescription() |
Modifier and Type | Method and Description |
---|---|
GlobalSecondaryIndexDescription |
clone() |
boolean |
equals(Object obj) |
Boolean |
getBackfilling()
Indicates whether the index is currently backfilling.
|
String |
getIndexName()
The name of the global secondary index.
|
Long |
getIndexSizeBytes()
The total size of the specified index, in bytes.
|
String |
getIndexStatus()
The current state of the global secondary index:
|
Long |
getItemCount()
The number of items in the specified index.
|
List<KeySchemaElement> |
getKeySchema()
The complete key schema for the global secondary index, consisting of
one or more pairs of attribute names and key types (
HASH
or RANGE ). |
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() |
Boolean |
isBackfilling()
Indicates whether the index is currently backfilling.
|
void |
setBackfilling(Boolean backfilling)
Indicates whether the index is currently backfilling.
|
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 the global secondary index, consisting of
one or more pairs of attribute names and key types (
HASH
or RANGE ). |
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.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GlobalSecondaryIndexDescription |
withBackfilling(Boolean backfilling)
Indicates whether the index is currently backfilling.
|
GlobalSecondaryIndexDescription |
withIndexName(String indexName)
The name of the global secondary index.
|
GlobalSecondaryIndexDescription |
withIndexSizeBytes(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(String indexStatus)
The current state of the global secondary index:
|
GlobalSecondaryIndexDescription |
withItemCount(Long itemCount)
The number of items in the specified index.
|
GlobalSecondaryIndexDescription |
withKeySchema(Collection<KeySchemaElement> keySchema)
The complete key schema for the global secondary index, consisting of
one or more pairs of attribute names and key types (
HASH
or RANGE ). |
GlobalSecondaryIndexDescription |
withKeySchema(KeySchemaElement... keySchema)
The complete key schema for the global secondary index, consisting of
one or more pairs of attribute names and key types (
HASH
or RANGE ). |
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 String getIndexName()
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
public void setIndexName(String indexName)
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
indexName
- The name of the global secondary index.public GlobalSecondaryIndexDescription withIndexName(String indexName)
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 List<KeySchemaElement> getKeySchema()
HASH
or RANGE
).
Constraints:
Length: 1 - 2
HASH
or RANGE
).public void setKeySchema(Collection<KeySchemaElement> keySchema)
HASH
or RANGE
).
Constraints:
Length: 1 - 2
keySchema
- The complete key schema for the global secondary index, consisting of
one or more pairs of attribute names and key types (HASH
or RANGE
).public GlobalSecondaryIndexDescription withKeySchema(KeySchemaElement... keySchema)
HASH
or RANGE
).
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 2
keySchema
- The complete key schema for the global secondary index, consisting of
one or more pairs of attribute names and key types (HASH
or RANGE
).public GlobalSecondaryIndexDescription withKeySchema(Collection<KeySchemaElement> keySchema)
HASH
or RANGE
).
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 2
keySchema
- The complete key schema for the global secondary index, consisting of
one or more pairs of attribute names and key types (HASH
or RANGE
).public Projection getProjection()
public void setProjection(Projection 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.public GlobalSecondaryIndexDescription withProjection(Projection projection)
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 String getIndexStatus()
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
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(String indexStatus)
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(String indexStatus)
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)
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)
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 Boolean isBackfilling()
For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
public void setBackfilling(Boolean backfilling)
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 hash key attribute cannot have any
duplicates.) 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(Boolean backfilling)
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 hash key attribute cannot have any
duplicates.) 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 Boolean getBackfilling()
For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
public ProvisionedThroughputDescription getProvisionedThroughput()
public void setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
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)
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 Long getIndexSizeBytes()
public void setIndexSizeBytes(Long indexSizeBytes)
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(Long indexSizeBytes)
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 Long getItemCount()
public void setItemCount(Long itemCount)
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(Long itemCount)
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 String toString()
toString
in class Object
Object.toString()
public GlobalSecondaryIndexDescription clone()
Copyright © 2015. All rights reserved.