software.amazon.awssdk.services.dynamodb.model

Class UpdateTableRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateTableRequest.Builder,UpdateTableRequest>

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

Represents the input of an UpdateTable operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateTableRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<AttributeDefinition>	attributeDefinitions() An array of attributes that describe the key schema for the table and indexes.
BillingMode	billingMode() Controls how you are charged for read and write throughput and how you manage capacity.
String	billingModeAsString() Controls how you are charged for read and write throughput and how you manage capacity.
static UpdateTableRequest.Builder	builder()
Boolean	deletionProtectionEnabled() Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<GlobalSecondaryIndexUpdate>	globalSecondaryIndexUpdates() An array of one or more global secondary indexes for the table.
boolean	hasAttributeDefinitions() For responses, this returns true if the service returned a value for the AttributeDefinitions property.
boolean	hasGlobalSecondaryIndexUpdates() For responses, this returns true if the service returned a value for the GlobalSecondaryIndexUpdates property.
int	hashCode()
boolean	hasReplicaUpdates() For responses, this returns true if the service returned a value for the ReplicaUpdates property.
ProvisionedThroughput	provisionedThroughput() The new provisioned throughput settings for the specified table or index.
List<ReplicationGroupUpdate>	replicaUpdates() A list of replica update actions (create, delete, or update) for the table.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateTableRequest.Builder>	serializableBuilderClass()
SSESpecification	sseSpecification() The new server-side encryption settings for the specified table.
StreamSpecification	streamSpecification() Represents the DynamoDB Streams configuration for the table.
TableClass	tableClass() The table class of the table to be updated.
String	tableClassAsString() The table class of the table to be updated.
String	tableName() The name of the table to be updated.
UpdateTableRequest.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

hasAttributeDefinitions

public final boolean hasAttributeDefinitions()

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

attributeDefinitions

public final List<AttributeDefinition> attributeDefinitions()

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

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

Returns:

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

tableName

public final String tableName()

The name of the table to be updated.

Returns:

The name of the table to be updated.

billingMode

public final BillingMode billingMode()

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

• 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, billingMode will return BillingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingModeAsString().

Returns:

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

• 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

billingModeAsString

public final String billingModeAsString()

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

• 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, billingMode will return BillingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingModeAsString().

Returns:

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

• 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

provisionedThroughput

public final ProvisionedThroughput provisionedThroughput()

The new provisioned throughput settings for the specified table or index.

Returns:

The new provisioned throughput settings for the specified table or index.

hasGlobalSecondaryIndexUpdates

public final boolean hasGlobalSecondaryIndexUpdates()

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

globalSecondaryIndexUpdates

public final List<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates()

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

• Create - add a new global secondary index to the table.

• Update - modify the provisioned throughput settings of an existing global secondary index.

• Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

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

Returns:

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

• Create - add a new global secondary index to the table.

• Update - modify the provisioned throughput settings of an existing global secondary index.

• Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

streamSpecification

public final StreamSpecification streamSpecification()

Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

Returns:

Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

sseSpecification

public final SSESpecification sseSpecification()

The new server-side encryption settings for the specified table.

Returns:

The new server-side encryption settings for the specified table.

hasReplicaUpdates

public final boolean hasReplicaUpdates()

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

replicaUpdates

public final List<ReplicationGroupUpdate> replicaUpdates()

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 (Current) of global tables.

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

Returns:

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 (Current) of global tables.

tableClass

public final TableClass tableClass()

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

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

Returns:

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

See Also:

TableClass

tableClassAsString

public final String tableClassAsString()

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

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

Returns:

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

See Also:

TableClass

deletionProtectionEnabled

public final Boolean deletionProtectionEnabled()

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

Returns:

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

toBuilder

public UpdateTableRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateTableRequest.Builder,UpdateTableRequest>

Specified by:

toBuilder in class DynamoDbRequest

builder

public static UpdateTableRequest.Builder builder()

serializableBuilderClass

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