@Generated(value="software.amazon.awssdk:codegen") public final class GlobalSecondaryIndexDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GlobalSecondaryIndexDescription.Builder,GlobalSecondaryIndexDescription>
Represents the properties of a global secondary index.
Modifier and Type | Class and Description |
---|---|
static interface |
GlobalSecondaryIndexDescription.Builder |
Modifier and Type | Method and Description |
---|---|
Boolean |
backfilling()
Indicates whether the index is currently backfilling.
|
static GlobalSecondaryIndexDescription.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasKeySchema()
Returns true if the KeySchema property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
String |
indexArn()
The Amazon Resource Name (ARN) that uniquely identifies the index.
|
String |
indexName()
The name of the global secondary index.
|
Long |
indexSizeBytes()
The total size of the specified index, in bytes.
|
IndexStatus |
indexStatus()
The current state of the global secondary index:
|
String |
indexStatusAsString()
The current state of the global secondary index:
|
Long |
itemCount()
The number of items in the specified index.
|
List<KeySchemaElement> |
keySchema()
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and
key types:
|
Projection |
projection()
Represents attributes that are copied (projected) from the table into the global secondary index.
|
ProvisionedThroughputDescription |
provisionedThroughput()
Represents the provisioned throughput settings for the specified global secondary index.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GlobalSecondaryIndexDescription.Builder> |
serializableBuilderClass() |
GlobalSecondaryIndexDescription.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public String indexName()
The name of the global secondary index.
public boolean hasKeySchema()
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasKeySchema()
to see if a value was sent in this field.
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 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.
public 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.
If the service returns an enum value that is not available in the current SDK version, indexStatus
will
return IndexStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
indexStatusAsString()
.
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 indexStatusAsString()
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.
If the service returns an enum value that is not available in the current SDK version, indexStatus
will
return IndexStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
indexStatusAsString()
.
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 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
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 ProvisionedThroughputDescription provisionedThroughput()
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
public 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.
public 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.
public String indexArn()
The Amazon Resource Name (ARN) that uniquely identifies the index.
public GlobalSecondaryIndexDescription.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<GlobalSecondaryIndexDescription.Builder,GlobalSecondaryIndexDescription>
public static GlobalSecondaryIndexDescription.Builder builder()
public static Class<? extends GlobalSecondaryIndexDescription.Builder> serializableBuilderClass()
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
Copyright © 2020. All rights reserved.