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("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 Description

static interface UpdateTableRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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.
`List<GlobalTableWitnessGroupUpdate>`	`globalTableWitnessUpdates()`	A list of witness updates for a MRSC global 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.
`boolean`	`hasGlobalTableWitnessUpdates()`	For responses, this returns true if the service returned a value for the GlobalTableWitnessUpdates property.
`int`	`hashCode()`
`boolean`	`hasReplicaUpdates()`	For responses, this returns true if the service returned a value for the ReplicaUpdates property.
`MultiRegionConsistency`	`multiRegionConsistency()`	Specifies the consistency mode for a new global table.
`String`	`multiRegionConsistencyAsString()`	Specifies the consistency mode for a new global table.
`OnDemandThroughput`	`onDemandThroughput()`	Updates the maximum number of read and write units for the specified table in on-demand capacity mode.
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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.
`WarmThroughput`	`warmThroughput()`	Represents the warm throughput (in read units per second and write units per second) for updating a table.

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. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
    
    Returns:
    
    The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
  - 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.
    
    PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
    
    PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity 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.
    
    PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
    
    PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity 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.
    
    PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
    
    PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity 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.
    
    PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
    
    PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity 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 ValidationException 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 ValidationException 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.
    
    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.
  - 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.
  - multiRegionConsistency
```
public final MultiRegionConsistency multiRegionConsistency()
```
    Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.
    
    You can specify one of the following consistency modes:
    
    EVENTUAL: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables.
    
    STRONG: Configures a new global table for multi-Region strong consistency (MRSC).
    
    If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
    
    If the service returns an enum value that is not available in the current SDK version, multiRegionConsistency will return MultiRegionConsistency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from multiRegionConsistencyAsString().
    Returns:
    
    Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.
    
    You can specify one of the following consistency modes:
    
    EVENTUAL: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables.
    
    STRONG: Configures a new global table for multi-Region strong consistency (MRSC).
    
    If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
    
    See Also:
    
    MultiRegionConsistency
  - multiRegionConsistencyAsString
```
public final String multiRegionConsistencyAsString()
```
    Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.
    
    You can specify one of the following consistency modes:
    
    EVENTUAL: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables.
    
    STRONG: Configures a new global table for multi-Region strong consistency (MRSC).
    
    If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
    
    If the service returns an enum value that is not available in the current SDK version, multiRegionConsistency will return MultiRegionConsistency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from multiRegionConsistencyAsString().
    Returns:
    
    Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.
    
    You can specify one of the following consistency modes:
    
    EVENTUAL: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables.
    
    STRONG: Configures a new global table for multi-Region strong consistency (MRSC).
    
    If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
    
    See Also:
    
    MultiRegionConsistency
  - hasGlobalTableWitnessUpdates
```
public final boolean hasGlobalTableWitnessUpdates()
```
    For responses, this returns true if the service returned a value for the GlobalTableWitnessUpdates 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.
  - globalTableWitnessUpdates
```
public final List<GlobalTableWitnessGroupUpdate> globalTableWitnessUpdates()
```
    A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:
    
    Create - add a new witness to the global table.
    
    Delete - remove a witness from the global table.
    
    You can create or delete only one witness per UpdateTable operation.
    
    For more information, see Multi-Region strong consistency (MRSC) 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 hasGlobalTableWitnessUpdates() method.
    Returns:
    
    A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:
    
    Create - add a new witness to the global table.
    
    Delete - remove a witness from the global table.
    
    You can create or delete only one witness per UpdateTable operation.
    
    For more information, see Multi-Region strong consistency (MRSC) in the Amazon DynamoDB Developer Guide
  - onDemandThroughput
```
public final OnDemandThroughput onDemandThroughput()
```
    Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
    
    Returns:
    
    Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
  - warmThroughput
```
public final WarmThroughput warmThroughput()
```
    Represents the warm throughput (in read units per second and write units per second) for updating a table.
    
    Returns:
    
    Represents the warm throughput (in read units per second and write units per second) for updating a 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class UpdateTableRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasAttributeDefinitions

attributeDefinitions

tableName

billingMode

billingModeAsString

provisionedThroughput

hasGlobalSecondaryIndexUpdates

globalSecondaryIndexUpdates

streamSpecification

sseSpecification

hasReplicaUpdates

replicaUpdates

tableClass

tableClassAsString

deletionProtectionEnabled

multiRegionConsistency

multiRegionConsistencyAsString

hasGlobalTableWitnessUpdates

globalTableWitnessUpdates

onDemandThroughput

warmThroughput

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField