@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GlobalSecondaryIndexDescription extends Object implements Serializable, Cloneable, StructuredPojo
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 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 the global secondary index.
|
ProvisionedThroughputDescription |
getProvisionedThroughput()
Represents the provisioned throughput settings for the specified global secondary index.
|
int |
hashCode() |
Boolean |
isBackfilling()
Indicates whether the index is currently backfilling.
|
void |
marshall(ProtocolMarshaller protocolMarshaller) |
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)
Represents attributes that are copied (projected) from the table into the global secondary index.
|
void |
setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
Represents the provisioned throughput settings for the specified global secondary index.
|
String |
toString()
Returns a string representation of this object.
|
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 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 the global secondary index.
|
GlobalSecondaryIndexDescription |
withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
Represents the provisioned throughput settings for the specified global secondary index.
|
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 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's 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.
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's 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(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's 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's 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's 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.
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's 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(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's 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's 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 setProjection(Projection projection)
Represents attributes that are copied (projected) from the table into the global secondary 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 the global secondary index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected.public Projection getProjection()
Represents attributes that are copied (projected) from the table into the global secondary 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 the global secondary 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 the global secondary index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected.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
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.
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
is being created when IndexStatus
is set to CREATING 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.
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the
index that is being created when IndexStatus
is set to CREATING 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
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.
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
is being created when IndexStatus
is set to CREATING and Backfilling
is false.
For indexes that were created during a CreateTable
operation, the Backfilling
attribute
does not appear in the DescribeTable
output.
Backfilling
is false.
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the
index that is being created when IndexStatus
is set to CREATING 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)
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.
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
is being created when IndexStatus
is set to CREATING 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.
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the
index that is being created when IndexStatus
is set to CREATING 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
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.
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
is being created when IndexStatus
is set to CREATING and Backfilling
is false.
For indexes that were created during a CreateTable
operation, the Backfilling
attribute
does not appear in the DescribeTable
output.
Backfilling
is false.
You can delete an index that is being created during the Backfilling
phase when
IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the
index that is being created when IndexStatus
is set to CREATING 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 setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
provisionedThroughput
- Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
public ProvisionedThroughputDescription getProvisionedThroughput()
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
public GlobalSecondaryIndexDescription withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
provisionedThroughput
- Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
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()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2021. All rights reserved.