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

Class GlobalSecondaryIndexUpdate

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.GlobalSecondaryIndexUpdate

All Implemented Interfaces:

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

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

Represents one of the following:

• A new global secondary index to be added to an existing table.

• New provisioned throughput parameters for an existing global secondary index.

• An existing global secondary index to be removed from an existing table.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GlobalSecondaryIndexUpdate.Builder

Method Summary

Modifier and Type	Method	Description
static GlobalSecondaryIndexUpdate.Builder	builder()
CreateGlobalSecondaryIndexAction	create()	The parameters required for creating a global secondary index on an existing table:
DeleteGlobalSecondaryIndexAction	delete()	The name of an existing global secondary index to be removed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GlobalSecondaryIndexUpdate.Builder>	serializableBuilderClass()
GlobalSecondaryIndexUpdate.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UpdateGlobalSecondaryIndexAction	update()	The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

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

update

public final UpdateGlobalSecondaryIndexAction update()

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

Returns:

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

create

public final CreateGlobalSecondaryIndexAction create()

The parameters required for creating a global secondary index on an existing table:

• IndexName

• KeySchema

• AttributeDefinitions

• Projection

• ProvisionedThroughput

Returns:

The parameters required for creating a global secondary index on an existing table:

• IndexName

• KeySchema

• AttributeDefinitions

• Projection

• ProvisionedThroughput

delete

public final DeleteGlobalSecondaryIndexAction delete()

The name of an existing global secondary index to be removed.

Returns:

The name of an existing global secondary index to be removed.

toBuilder

public GlobalSecondaryIndexUpdate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GlobalSecondaryIndexUpdate.Builder,GlobalSecondaryIndexUpdate>

builder

public static GlobalSecondaryIndexUpdate.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo