software.amazon.awssdk.services.dynamodb.model

Class GlobalSecondaryIndexInfo

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.GlobalSecondaryIndexInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GlobalSecondaryIndexInfo.Builder,GlobalSecondaryIndexInfo>

@Generated(value="software.amazon.awssdk:codegen")
public final class GlobalSecondaryIndexInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GlobalSecondaryIndexInfo.Builder,GlobalSecondaryIndexInfo>

Represents the properties of a global secondary index for the table when the backup was created.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GlobalSecondaryIndexInfo.Builder

Method Summary

Modifier and Type	Method and Description
static GlobalSecondaryIndexInfo.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexName() The name of the global secondary 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.
ProvisionedThroughput	provisionedThroughput() Represents the provisioned throughput settings for the specified global secondary index.
List<SdkField<?>>	sdkFields()
static Class<? extends GlobalSecondaryIndexInfo.Builder>	serializableBuilderClass()
GlobalSecondaryIndexInfo.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

indexName

public String indexName()

The name of the global secondary index.

Returns:

The name of the global secondary index.

keySchema

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' 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.

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' 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

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.

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.

provisionedThroughput

public ProvisionedThroughput provisionedThroughput()

Represents the provisioned throughput settings for the specified global secondary index.

Returns:

Represents the provisioned throughput settings for the specified global secondary index.

toBuilder

public GlobalSecondaryIndexInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GlobalSecondaryIndexInfo.Builder,GlobalSecondaryIndexInfo>

builder

public static GlobalSecondaryIndexInfo.Builder builder()

serializableBuilderClass

public static Class<? extends GlobalSecondaryIndexInfo.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String 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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo