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

Class UpdateGlobalTableSettingsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest

software.amazon.awssdk.services.dynamodb.model.UpdateGlobalTableSettingsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateGlobalTableSettingsRequest.Builder,UpdateGlobalTableSettingsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateGlobalTableSettingsRequest
extends DynamoDbRequest
implements ToCopyableBuilder<UpdateGlobalTableSettingsRequest.Builder,UpdateGlobalTableSettingsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateGlobalTableSettingsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateGlobalTableSettingsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
BillingMode	globalTableBillingMode()	The billing mode of the global table.
String	globalTableBillingModeAsString()	The billing mode of the global table.
List<GlobalTableGlobalSecondaryIndexSettingsUpdate>	globalTableGlobalSecondaryIndexSettingsUpdate()	Represents the settings of a global secondary index for a global table that will be modified.
String	globalTableName()	The name of the global table
AutoScalingSettingsUpdate	globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate()	Auto scaling settings for managing provisioned write capacity for the global table.
Long	globalTableProvisionedWriteCapacityUnits()	The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
boolean	hasGlobalTableGlobalSecondaryIndexSettingsUpdate()	For responses, this returns true if the service returned a value for the GlobalTableGlobalSecondaryIndexSettingsUpdate property.
int	hashCode()
boolean	hasReplicaSettingsUpdate()	For responses, this returns true if the service returned a value for the ReplicaSettingsUpdate property.
List<ReplicaSettingsUpdate>	replicaSettingsUpdate()	Represents the settings for a global table in a Region that will be modified.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateGlobalTableSettingsRequest.Builder>	serializableBuilderClass()
UpdateGlobalTableSettingsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

globalTableName

public final String globalTableName()

The name of the global table

Returns:

The name of the global table

globalTableBillingMode

public final BillingMode globalTableBillingMode()

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

• PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

• PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

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

Returns:

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

• PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

• PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

See Also:

BillingMode

globalTableBillingModeAsString

public final String globalTableBillingModeAsString()

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

• PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

• PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

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

Returns:

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

• PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

• PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

See Also:

BillingMode

globalTableProvisionedWriteCapacityUnits

public final Long globalTableProvisionedWriteCapacityUnits()

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.

globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate

public final AutoScalingSettingsUpdate globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate()

Auto scaling settings for managing provisioned write capacity for the global table.

Returns:

Auto scaling settings for managing provisioned write capacity for the global table.

hasGlobalTableGlobalSecondaryIndexSettingsUpdate

public final boolean hasGlobalTableGlobalSecondaryIndexSettingsUpdate()

For responses, this returns true if the service returned a value for the GlobalTableGlobalSecondaryIndexSettingsUpdate 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.

globalTableGlobalSecondaryIndexSettingsUpdate

public final List<GlobalTableGlobalSecondaryIndexSettingsUpdate> globalTableGlobalSecondaryIndexSettingsUpdate()

Represents the settings of a global secondary index for a global table that will be modified.

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 hasGlobalTableGlobalSecondaryIndexSettingsUpdate() method.

Returns:

Represents the settings of a global secondary index for a global table that will be modified.

hasReplicaSettingsUpdate

public final boolean hasReplicaSettingsUpdate()

For responses, this returns true if the service returned a value for the ReplicaSettingsUpdate 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.

replicaSettingsUpdate

public final List<ReplicaSettingsUpdate> replicaSettingsUpdate()

Represents the settings for a global table in a Region that will be modified.

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 hasReplicaSettingsUpdate() method.

Returns:

Represents the settings for a global table in a Region that will be modified.

toBuilder

public UpdateGlobalTableSettingsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateGlobalTableSettingsRequest.Builder,UpdateGlobalTableSettingsRequest>

Specified by:

toBuilder in class DynamoDbRequest

builder

public static UpdateGlobalTableSettingsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo