UpdateTableRequest (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class UpdateTableRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

You can only perform one of the following operations at once:
- Modify the provisioned throughput settings of the table.
- Enable or disable Streams on the table.
- Remove a global secondary index from the table.
- Create a new global secondary index on the table. Once the index begins backfilling, you can use UpdateTable to perform other operations.
UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.
See Also:

Serialized Form

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<AttributeDefinition>`	`getAttributeDefinitions()` An array of attributes that describe the key schema for the table and indexes.
`java.util.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.
`java.lang.String`	`getTableName()` The name of the table to be updated.
`int`	`hashCode()`
`void`	`setAttributeDefinitions(java.util.Collection<AttributeDefinition> attributeDefinitions)` An array of attributes that describe the key schema for the table and indexes.
`void`	`setGlobalSecondaryIndexUpdates(java.util.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(java.lang.String tableName)` The name of the table to be updated.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UpdateTableRequest`	`withAttributeDefinitions(AttributeDefinition... attributeDefinitions)` An array of attributes that describe the key schema for the table and indexes.
`UpdateTableRequest`	`withAttributeDefinitions(java.util.Collection<AttributeDefinition> attributeDefinitions)` An array of attributes that describe the key schema for the table and indexes.
`UpdateTableRequest`	`withGlobalSecondaryIndexUpdates(java.util.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(java.lang.String tableName)` The name of the table to be updated.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
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 any additional object members.
  - UpdateTableRequest
```
public UpdateTableRequest(java.lang.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 java.util.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(java.util.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - withAttributeDefinitions
```
public UpdateTableRequest withAttributeDefinitions(java.util.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getTableName
```
public java.lang.String getTableName()
```
    The name of the table to be updated.
    
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    
    The name of the table to be updated.
  - setTableName
```
public void setTableName(java.lang.String tableName)
```
    The name of the table to be updated.
    
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    tableName -
    The name of the table to be updated.
  - withTableName
```
public UpdateTableRequest withTableName(java.lang.String tableName)
```
    The name of the table to be updated.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    tableName -
    The name of the table to be updated.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withProvisionedThroughput
```
public UpdateTableRequest withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
```
    The new provisioned throughput settings for the specified table or index.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    provisionedThroughput -
    The new provisioned throughput settings for the specified table or index.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getGlobalSecondaryIndexUpdates
```
public java.util.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(java.util.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.
    
    Returns a reference to this object so that method calls can be chained together.
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - withGlobalSecondaryIndexUpdates
```
public UpdateTableRequest withGlobalSecondaryIndexUpdates(java.util.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.
    
    Returns a reference to this object so that method calls can be chained together.
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withSSESpecification
```
public UpdateTableRequest withSSESpecification(SSESpecification sSESpecification)
```
    The new server-side encryption settings for the specified table.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    sSESpecification -
    The new server-side encryption settings for the specified table.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class UpdateTableRequest

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

getTableName

setTableName

withTableName

getProvisionedThroughput

setProvisionedThroughput

withProvisionedThroughput

getGlobalSecondaryIndexUpdates

setGlobalSecondaryIndexUpdates

withGlobalSecondaryIndexUpdates

withGlobalSecondaryIndexUpdates

getStreamSpecification

setStreamSpecification

withStreamSpecification

getSSESpecification

setSSESpecification

withSSESpecification

toString

hashCode

equals