UpdateTableRequest (AWS Java SDK :: Services :: Amazon DynamoDB 2.10.56 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateTableRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`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()` Returns true if the AttributeDefinitions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasGlobalSecondaryIndexUpdates()` Returns true if the GlobalSecondaryIndexUpdates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasReplicaUpdates()` Returns true if the ReplicaUpdates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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.
`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 boolean hasAttributeDefinitions()
```
    Returns true if the AttributeDefinitions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - attributeDefinitions
```
public 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.
    
    You can use hasAttributeDefinitions() to see if a value was sent in this field.
    
    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 String tableName()
```
    The name of the table to be updated.
    
    Returns:
    
    The name of the table to be updated.
  - billingMode
```
public 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 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 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 boolean hasGlobalSecondaryIndexUpdates()
```
    Returns true if the GlobalSecondaryIndexUpdates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - globalSecondaryIndexUpdates
```
public 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.
    
    You can use hasGlobalSecondaryIndexUpdates() to see if a value was sent in this field.
    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 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 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 boolean hasReplicaUpdates()
```
    Returns true if the ReplicaUpdates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - replicaUpdates
```
public 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 of global tables.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasReplicaUpdates() to see if a value was sent in this field.
    
    Returns:
    
    A list of replica update actions (create, delete, or update) for the table.
    
    This property only applies to Version 2019.11.21 of global tables.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields 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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields