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

Class ReplicaGlobalSecondaryIndexSettingsDescription

java.lang.Object

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

All Implemented Interfaces:

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

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

Represents the properties of a global secondary index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReplicaGlobalSecondaryIndexSettingsDescription.Builder

Method Summary

Modifier and Type	Method	Description
static ReplicaGlobalSecondaryIndexSettingsDescription.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(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:
AutoScalingSettingsDescription	provisionedReadCapacityAutoScalingSettings()	Auto scaling settings for a global secondary index replica's read capacity units.
Long	provisionedReadCapacityUnits()	The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
AutoScalingSettingsDescription	provisionedWriteCapacityAutoScalingSettings()	Auto scaling settings for a global secondary index replica's write capacity units.
Long	provisionedWriteCapacityUnits()	The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ReplicaGlobalSecondaryIndexSettingsDescription.Builder>	serializableBuilderClass()
ReplicaGlobalSecondaryIndexSettingsDescription.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.

indexStatus

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

provisionedReadCapacityAutoScalingSettings

public final AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings()

Auto scaling settings for a global secondary index replica's read capacity units.

Returns:

Auto scaling settings for a global secondary index replica's read capacity units.

provisionedWriteCapacityUnits

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

provisionedWriteCapacityAutoScalingSettings

public final AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings()

Auto scaling settings for a global secondary index replica's write capacity units.

Returns:

Auto scaling settings for a global secondary index replica's write capacity units.

toBuilder

public ReplicaGlobalSecondaryIndexSettingsDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,ReplicaGlobalSecondaryIndexSettingsDescription>

builder

public static ReplicaGlobalSecondaryIndexSettingsDescription.Builder builder()

serializableBuilderClass

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