Class AwsDynamoDbTableGlobalSecondaryIndex
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsDynamoDbTableGlobalSecondaryIndex.Builder,
AwsDynamoDbTableGlobalSecondaryIndex>
Information abut a global secondary index for the table.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
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 ARN of the index.final String
The name of the index.final Long
The total size in bytes of the index.final String
The current status of the index.final Integer
The number of items in the index.final List
<AwsDynamoDbTableKeySchema> The key schema for the index.Attributes that are copied from the table into an index.Information about the provisioned throughput settings for the indexes.static Class
<? extends AwsDynamoDbTableGlobalSecondaryIndex.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
-
backfilling
Whether the index is currently backfilling.
- Returns:
- Whether the index is currently backfilling.
-
indexArn
The ARN of the index.
- Returns:
- The ARN of the index.
-
indexName
The name of the index.
- Returns:
- The name of the index.
-
indexSizeBytes
The total size in bytes of the index.
- Returns:
- The total size in bytes of the index.
-
indexStatus
The current status of the index.
-
ACTIVE
-
CREATING
-
DELETING
-
UPDATING
- Returns:
- The current status of the index.
-
ACTIVE
-
CREATING
-
DELETING
-
UPDATING
-
-
-
itemCount
The number of items in the index.
- Returns:
- The number of items in the 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 key schema for the index.
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 key schema for the index.
-
projection
Attributes that are copied from the table into an index.
- Returns:
- Attributes that are copied from the table into an index.
-
provisionedThroughput
Information about the provisioned throughput settings for the indexes.
- Returns:
- Information about the provisioned throughput settings for the indexes.
-
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<AwsDynamoDbTableGlobalSecondaryIndex.Builder,
AwsDynamoDbTableGlobalSecondaryIndex> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AwsDynamoDbTableGlobalSecondaryIndex.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
-