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 |
getIndexArn()
The Amazon Resource Name (ARN) that uniquely identifies the index.
|
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()
Returns the value of the Projection property for this object.
|
ProvisionedThroughputDescription |
getProvisionedThroughput()
Returns the value of the ProvisionedThroughput property for this object.
|
int |
hashCode() |
Boolean |
isBackfilling()
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 the global secondary index, consisting of one
or more pairs of attribute names and key types (
HASH or
RANGE ). |
void |
setProjection(Projection projection)
Sets the value of the Projection property for this object.
|
void |
setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
Sets the value of the ProvisionedThroughput property for this object.
|
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 |
withIndexArn(String indexArn)
The Amazon Resource Name (ARN) that uniquely identifies the index.
|
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)
Sets the value of the Projection property for this object.
|
GlobalSecondaryIndexDescription |
withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
Sets the value of the ProvisionedThroughput property for this object.
|
public void setIndexName(String indexName)
The name of the global secondary index.
indexName
- The name of the global secondary index.public String getIndexName()
The name of the global secondary index.
public GlobalSecondaryIndexDescription withIndexName(String indexName)
The name of the global secondary index.
indexName
- The name of the global secondary index.public 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
).
HASH
or RANGE
).public 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
).
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)
The complete key schema for the global secondary index, consisting of one
or more pairs of attribute names and key types (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.
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)
The complete key schema for the global secondary index, consisting of one
or more pairs of attribute names and key types (HASH
or
RANGE
).
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 void setProjection(Projection projection)
projection
- The new value for the Projection property for this object.public Projection getProjection()
public GlobalSecondaryIndexDescription withProjection(Projection projection)
projection
- The new value for the Projection property for this object.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.
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 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.
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)
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
- 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.
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.
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 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 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.
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()
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.
For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
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 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.
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 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 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.
For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
public void setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
provisionedThroughput
- The new value for the ProvisionedThroughput property for this
object.public ProvisionedThroughputDescription getProvisionedThroughput()
public GlobalSecondaryIndexDescription withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
provisionedThroughput
- The new value for the ProvisionedThroughput property for this
object.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.
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 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.
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.
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 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.
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 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.
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.
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 void setIndexArn(String indexArn)
The Amazon Resource Name (ARN) that uniquely identifies the index.
indexArn
- The Amazon Resource Name (ARN) that uniquely identifies the index.public String getIndexArn()
The Amazon Resource Name (ARN) that uniquely identifies the index.
public GlobalSecondaryIndexDescription withIndexArn(String indexArn)
The Amazon Resource Name (ARN) that uniquely identifies the index.
indexArn
- The Amazon Resource Name (ARN) that uniquely identifies the index.public String toString()
toString
in class Object
Object.toString()
public GlobalSecondaryIndexDescription clone()
Copyright © 2015. All rights reserved.