software.amazon.awssdk.services.dynamodb.model

Class ReplicaGlobalSecondaryIndexSettingsDescription

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.ReplicaGlobalSecondaryIndexSettingsDescription

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,ReplicaGlobalSecondaryIndexSettingsDescription>

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

Represents the properties of a global secondary index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ReplicaGlobalSecondaryIndexSettingsDescription.Builder

Method Summary

Modifier and Type	Method and Description
static ReplicaGlobalSecondaryIndexSettingsDescription.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.
IndexStatus	indexStatus() The current status of the global secondary index:
String	indexStatusAsString() The current status of the global secondary index:
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
Long	provisionedReadCapacityUnits() The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
Long	provisionedWriteCapacityUnits() The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
static Class<? extends ReplicaGlobalSecondaryIndexSettingsDescription.Builder>	serializableBuilderClass()
ReplicaGlobalSecondaryIndexSettingsDescription.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

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

indexStatus

public IndexStatus indexStatus()

The current status of the global secondary index:

• CREATING - The global secondary index is being created.

• UPDATING - The global secondary index is being updated.

• DELETING - The global secondary index is being deleted.

• ACTIVE - The global secondary index is ready for use.

If the service returns an enum value that is not available in the current SDK version, indexStatus will return IndexStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexStatusAsString().

Returns:

The current status of the global secondary index:

• CREATING - The global secondary index is being created.

• UPDATING - The global secondary index is being updated.

• DELETING - The global secondary index is being deleted.

• ACTIVE - The global secondary index is ready for use.

See Also:

IndexStatus

indexStatusAsString

public String indexStatusAsString()

The current status of the global secondary index:

• CREATING - The global secondary index is being created.

• UPDATING - The global secondary index is being updated.

• DELETING - The global secondary index is being deleted.

• ACTIVE - The global secondary index is ready for use.

If the service returns an enum value that is not available in the current SDK version, indexStatus will return IndexStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexStatusAsString().

Returns:

The current status of the global secondary index:

• CREATING - The global secondary index is being created.

• UPDATING - The global secondary index is being updated.

• DELETING - The global secondary index is being deleted.

• ACTIVE - The global secondary index is ready for use.

See Also:

IndexStatus

provisionedReadCapacityUnits

public Long provisionedReadCapacityUnits()

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

Returns:

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

provisionedWriteCapacityUnits

public Long provisionedWriteCapacityUnits()

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

Returns:

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

toBuilder

public ReplicaGlobalSecondaryIndexSettingsDescription.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,ReplicaGlobalSecondaryIndexSettingsDescription>

Returns:

a builder for type T

builder

public static ReplicaGlobalSecondaryIndexSettingsDescription.Builder builder()

serializableBuilderClass

public static Class<? extends ReplicaGlobalSecondaryIndexSettingsDescription.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()

Overrides:

toString in class Object

getValueForField

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.