UpdateTableRequest (AWS Java SDK for Amazon DynamoDB 1.11.466 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.dynamodbv2.model.UpdateTableRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateTableRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the input of an UpdateTable operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`UpdateTableRequest()` Default constructor for UpdateTableRequest object.
`UpdateTableRequest(String tableName, ProvisionedThroughput provisionedThroughput)` Constructs a new UpdateTableRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateTableRequest`	`clone()`
`boolean`	`equals(Object obj)`
`List<AttributeDefinition>`	`getAttributeDefinitions()` An array of attributes that describe the key schema for the table and indexes.
`String`	`getBillingMode()` Controls how you are charged for read and write throughput and how you manage capacity.
`List<GlobalSecondaryIndexUpdate>`	`getGlobalSecondaryIndexUpdates()` An array of one or more global secondary indexes for the table.
`ProvisionedThroughput`	`getProvisionedThroughput()` The new provisioned throughput settings for the specified table or index.
`SSESpecification`	`getSSESpecification()` The new server-side encryption settings for the specified table.
`StreamSpecification`	`getStreamSpecification()` Represents the DynamoDB Streams configuration for the table.
`String`	`getTableName()` The name of the table to be updated.
`int`	`hashCode()`
`void`	`setAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)` An array of attributes that describe the key schema for the table and indexes.
`void`	`setBillingMode(String billingMode)` Controls how you are charged for read and write throughput and how you manage capacity.
`void`	`setGlobalSecondaryIndexUpdates(Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates)` An array of one or more global secondary indexes for the table.
`void`	`setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)` The new provisioned throughput settings for the specified table or index.
`void`	`setSSESpecification(SSESpecification sSESpecification)` The new server-side encryption settings for the specified table.
`void`	`setStreamSpecification(StreamSpecification streamSpecification)` Represents the DynamoDB Streams configuration for the table.
`void`	`setTableName(String tableName)` The name of the table to be updated.
`String`	`toString()` Returns a string representation of this object.
`UpdateTableRequest`	`withAttributeDefinitions(AttributeDefinition... attributeDefinitions)` An array of attributes that describe the key schema for the table and indexes.
`UpdateTableRequest`	`withAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)` An array of attributes that describe the key schema for the table and indexes.
`UpdateTableRequest`	`withBillingMode(BillingMode billingMode)` Controls how you are charged for read and write throughput and how you manage capacity.
`UpdateTableRequest`	`withBillingMode(String billingMode)` Controls how you are charged for read and write throughput and how you manage capacity.
`UpdateTableRequest`	`withGlobalSecondaryIndexUpdates(Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates)` An array of one or more global secondary indexes for the table.
`UpdateTableRequest`	`withGlobalSecondaryIndexUpdates(GlobalSecondaryIndexUpdate... globalSecondaryIndexUpdates)` An array of one or more global secondary indexes for the table.
`UpdateTableRequest`	`withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)` The new provisioned throughput settings for the specified table or index.
`UpdateTableRequest`	`withSSESpecification(SSESpecification sSESpecification)` The new server-side encryption settings for the specified table.
`UpdateTableRequest`	`withStreamSpecification(StreamSpecification streamSpecification)` Represents the DynamoDB Streams configuration for the table.
`UpdateTableRequest`	`withTableName(String tableName)` The name of the table to be updated.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateTableRequest
```
public UpdateTableRequest()
```
    Default constructor for UpdateTableRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
  - UpdateTableRequest
```
public UpdateTableRequest(String tableName,
                          ProvisionedThroughput provisionedThroughput)
```
    Constructs a new UpdateTableRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    
    tableName - The name of the table to be updated.
    
    provisionedThroughput - The new provisioned throughput settings for the specified table or index.
- Method Detail
  - getAttributeDefinitions
```
public List<AttributeDefinition> getAttributeDefinitions()
```
    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.
    
    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.
  - setAttributeDefinitions
```
public void setAttributeDefinitions(Collection<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.
    
    Parameters:
    
    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.
  - withAttributeDefinitions
```
public UpdateTableRequest withAttributeDefinitions(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttributeDefinitions(java.util.Collection) or withAttributeDefinitions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttributeDefinitions
```
public UpdateTableRequest withAttributeDefinitions(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTableName
```
public void setTableName(String tableName)
```
    The name of the table to be updated.
    
    Parameters:
    
    tableName - The name of the table to be updated.
  - getTableName
```
public String getTableName()
```
    The name of the table to be updated.
    
    Returns:
    
    The name of the table to be updated.
  - withTableName
```
public UpdateTableRequest withTableName(String tableName)
```
    The name of the table to be updated.
    
    Parameters:
    
    tableName - The name of the table to be updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBillingMode
```
public void setBillingMode(String 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 - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
    - PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
    Parameters:
    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 - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
    
    PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
    See Also:
    
    BillingMode
  - getBillingMode
```
public String getBillingMode()
```
    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 - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
    - PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
    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 - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
    
    PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
    See Also:
    
    BillingMode
  - withBillingMode
```
public UpdateTableRequest withBillingMode(String 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 - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
    - PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
    Parameters:
    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 - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
    
    PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BillingMode
  - withBillingMode
```
public UpdateTableRequest withBillingMode(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 - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
    - PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
    Parameters:
    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 - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
    
    PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BillingMode
  - setProvisionedThroughput
```
public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
```
    The new provisioned throughput settings for the specified table or index.
    
    Parameters:
    
    provisionedThroughput - The new provisioned throughput settings for the specified table or index.
  - getProvisionedThroughput
```
public ProvisionedThroughput getProvisionedThroughput()
```
    The new provisioned throughput settings for the specified table or index.
    
    Returns:
    
    The new provisioned throughput settings for the specified table or index.
  - withProvisionedThroughput
```
public UpdateTableRequest withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
```
    The new provisioned throughput settings for the specified table or index.
    
    Parameters:
    
    provisionedThroughput - The new provisioned throughput settings for the specified table or index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getGlobalSecondaryIndexUpdates
```
public List<GlobalSecondaryIndexUpdate> getGlobalSecondaryIndexUpdates()
```
    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.
    For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
    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.
    
    For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
  - setGlobalSecondaryIndexUpdates
```
public void setGlobalSecondaryIndexUpdates(Collection<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.
    For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
    Parameters:
    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.
    
    For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
  - withGlobalSecondaryIndexUpdates
```
public UpdateTableRequest withGlobalSecondaryIndexUpdates(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.
    For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
    
    NOTE: This method appends the values to the existing list (if any). Use setGlobalSecondaryIndexUpdates(java.util.Collection) or withGlobalSecondaryIndexUpdates(java.util.Collection) if you want to override the existing values.
    Parameters:
    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.
    
    For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withGlobalSecondaryIndexUpdates
```
public UpdateTableRequest withGlobalSecondaryIndexUpdates(Collection<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.
    For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
    Parameters:
    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.
    
    For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStreamSpecification
```
public void setStreamSpecification(StreamSpecification streamSpecification)
```
    Represents the DynamoDB Streams configuration for the table.
    
    You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
    
    Parameters:
    
    streamSpecification - Represents the DynamoDB Streams configuration for the table.
    
    You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
  - getStreamSpecification
```
public StreamSpecification getStreamSpecification()
```
    Represents the DynamoDB Streams configuration for the table.
    
    You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
    
    Returns:
    
    Represents the DynamoDB Streams configuration for the table.
    
    You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
  - withStreamSpecification
```
public UpdateTableRequest withStreamSpecification(StreamSpecification streamSpecification)
```
    Represents the DynamoDB Streams configuration for the table.
    
    You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
    
    Parameters:
    
    streamSpecification - Represents the DynamoDB Streams configuration for the table.
    
    You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSSESpecification
```
public void setSSESpecification(SSESpecification sSESpecification)
```
    The new server-side encryption settings for the specified table.
    
    Parameters:
    
    sSESpecification - The new server-side encryption settings for the specified table.
  - getSSESpecification
```
public SSESpecification getSSESpecification()
```
    The new server-side encryption settings for the specified table.
    
    Returns:
    
    The new server-side encryption settings for the specified table.
  - withSSESpecification
```
public UpdateTableRequest withSSESpecification(SSESpecification sSESpecification)
```
    The new server-side encryption settings for the specified table.
    
    Parameters:
    
    sSESpecification - The new server-side encryption settings for the specified table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UpdateTableRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class UpdateTableRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateTableRequest

UpdateTableRequest

Method Detail

getAttributeDefinitions

setAttributeDefinitions

withAttributeDefinitions

withAttributeDefinitions

setTableName

getTableName

withTableName

setBillingMode

getBillingMode

withBillingMode

withBillingMode

setProvisionedThroughput

getProvisionedThroughput

withProvisionedThroughput

getGlobalSecondaryIndexUpdates

setGlobalSecondaryIndexUpdates

withGlobalSecondaryIndexUpdates

withGlobalSecondaryIndexUpdates

setStreamSpecification

getStreamSpecification

withStreamSpecification

setSSESpecification

getSSESpecification

withSSESpecification

toString

equals

hashCode

clone