Class GlobalSecondaryIndexDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<GlobalSecondaryIndexDescription.Builder,
GlobalSecondaryIndexDescription>
Represents the properties of a global secondary index.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Indicates whether the index is currently backfilling.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the KeySchema property.final String
indexArn()
The Amazon Resource Name (ARN) that uniquely identifies the index.final String
The name of the global secondary index.final Long
The total size of the specified index, in bytes.final IndexStatus
The current state of the global secondary index:final String
The current state of the global secondary index:final Long
The number of items in the specified index.final List
<KeySchemaElement> The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:final Projection
Represents attributes that are copied (projected) from the table into the global secondary index.Represents the provisioned throughput settings for the specified global secondary index.static Class
<? extends GlobalSecondaryIndexDescription.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
indexName
The name of the global secondary index.
- Returns:
- The name of the global secondary index.
-
hasKeySchema
public final boolean hasKeySchema()For responses, this returns true if the service returned a value for the KeySchema property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasKeySchema()
method.- Returns:
- 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.
-
-
-
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.
- Returns:
- 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.
-
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 returnIndexStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromindexStatusAsString()
.- Returns:
- 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.
-
- See Also:
-
-
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 returnIndexStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromindexStatusAsString()
.- Returns:
- 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.
-
- See Also:
-
-
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 whenIndexStatus
is set to CREATING andBackfilling
is true. You can't delete the index that is being created whenIndexStatus
is set to CREATING andBackfilling
is false.For indexes that were created during a
CreateTable
operation, theBackfilling
attribute does not appear in theDescribeTable
output.- Returns:
- 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 whenIndexStatus
is set to CREATING andBackfilling
is true. You can't delete the index that is being created whenIndexStatus
is set to CREATING andBackfilling
is false.For indexes that were created during a
CreateTable
operation, theBackfilling
attribute does not appear in theDescribeTable
output.
-
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.
- Returns:
- 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.
-
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:
- 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.
-
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:
- 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.
-
indexArn
The Amazon Resource Name (ARN) that uniquely identifies the index.
- Returns:
- The Amazon Resource Name (ARN) that uniquely identifies the index.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GlobalSecondaryIndexDescription.Builder,
GlobalSecondaryIndexDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-