software.amazon.awssdk.services.dynamodb.model

Class CreateGlobalSecondaryIndexAction

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.CreateGlobalSecondaryIndexAction

All Implemented Interfaces:

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

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

Represents a new global secondary index to be added to an existing table.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateGlobalSecondaryIndexAction.Builder

Method Summary

Modifier and Type	Method and Description
static CreateGlobalSecondaryIndexAction.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 to be created.
List<KeySchemaElement>	keySchema() The key schema for the global secondary index.
Projection	projection() Represents attributes that are copied (projected) from the table into an index.
ProvisionedThroughput	provisionedThroughput() Represents the provisioned throughput settings for the specified global secondary index.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateGlobalSecondaryIndexAction.Builder>	serializableBuilderClass()
CreateGlobalSecondaryIndexAction.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 to be created.

Returns:

The name of the global secondary index to be created.

hasKeySchema

public 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 List<KeySchemaElement> keySchema()

The key schema for the global secondary index.

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 key schema for the global secondary index.

projection

public Projection projection()

Represents attributes that are copied (projected) from the table into an 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 an 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.

For current minimum and maximum provisioned throughput values, see Limits 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 Limits in the Amazon DynamoDB Developer Guide.

toBuilder

public CreateGlobalSecondaryIndexAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateGlobalSecondaryIndexAction.Builder,CreateGlobalSecondaryIndexAction>

builder

public static CreateGlobalSecondaryIndexAction.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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