Package software.amazon.awssdk.services.dynamodb.model

Class LocalSecondaryIndex

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.LocalSecondaryIndex

All Implemented Interfaces:

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

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

Represents the properties of a local secondary index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LocalSecondaryIndex.Builder

Method Summary

Modifier and Type	Method	Description
static LocalSecondaryIndex.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasKeySchema()	For responses, this returns true if the service returned a value for the KeySchema property.
String	indexName()	The name of the local secondary index.
List<KeySchemaElement>	keySchema()	The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
Projection	projection()	Represents attributes that are copied (projected) from the table into the local secondary index.
List<SdkField<?>>	sdkFields()
static Class<? extends LocalSecondaryIndex.Builder>	serializableBuilderClass()
LocalSecondaryIndex.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 local secondary index. The name must be unique among all other indexes on this table.

Returns:

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

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 the isEmpty() 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

public final List<KeySchemaElement> keySchema()

The complete key schema for the local secondary index, consisting 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 the local secondary index, consisting 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 local 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 local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

toBuilder

public LocalSecondaryIndex.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LocalSecondaryIndex.Builder,LocalSecondaryIndex>

builder

public static LocalSecondaryIndex.Builder builder()

serializableBuilderClass

public static Class<? extends LocalSecondaryIndex.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