software.amazon.awssdk.services.dynamodb.model

Class GlobalSecondaryIndex

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.GlobalSecondaryIndex

All Implemented Interfaces:

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

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

Represents the properties of a global secondary index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GlobalSecondaryIndex.Builder

Method Summary

Modifier and Type	Method and Description
static GlobalSecondaryIndex.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	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 GlobalSecondaryIndex.Builder>	serializableBuilderClass()
GlobalSecondaryIndex.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 final String indexName()

The name of the global secondary index. The name must be unique among all other indexes on this table.

Returns:

The name of the global secondary index. The name must be unique among all other indexes on this table.

hasKeySchema

public final 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). For responses returned by the SDK, the sender is the AWS service.

keySchema

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

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

public final 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 final ProvisionedThroughput 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.

toBuilder

public GlobalSecondaryIndex.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GlobalSecondaryIndex.Builder,GlobalSecondaryIndex>

builder

public static GlobalSecondaryIndex.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo