com.amazonaws.services.dynamodbv2.model

Class UpdateTableRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.dynamodbv2.model.UpdateTableRequest

All Implemented Interfaces:

Serializable

public class UpdateTableRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UpdateTable operation.

Updates the provisioned throughput for the given table. Setting the throughput for a table helps you manage performance and is part of the provisioned throughput feature of DynamoDB.

The provisioned throughput values can be upgraded or downgraded based on the maximums and minimums listed in the Limits section in the Amazon DynamoDB Developer Guide.

The table must be in the ACTIVE state for this operation to succeed. UpdateTable is an asynchronous operation; while executing the operation, the table is in the UPDATING state. While the table is in the UPDATING state, the table still has the provisioned throughput from before the call. The new provisioned throughput setting is in effect only when the table returns to the ACTIVE state after the UpdateTable operation.

You cannot add, modify or delete indexes using UpdateTable . Indexes can only be defined at table creation time.

See Also:

AmazonDynamoDB.updateTable(UpdateTableRequest), Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<GlobalSecondaryIndexUpdate>	getGlobalSecondaryIndexUpdates() An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.
ProvisionedThroughput	getProvisionedThroughput() Represents the provisioned throughput settings for a specified table or index.
String	getTableName() The name of the table to be updated.
int	hashCode()
void	setGlobalSecondaryIndexUpdates(Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates) An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.
void	setProvisionedThroughput(ProvisionedThroughput provisionedThroughput) Represents the provisioned throughput settings for a specified table or index.
void	setTableName(String tableName) The name of the table to be updated.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateTableRequest	withGlobalSecondaryIndexUpdates(Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates) An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.
UpdateTableRequest	withGlobalSecondaryIndexUpdates(GlobalSecondaryIndexUpdate... globalSecondaryIndexUpdates) An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.
UpdateTableRequest	withProvisionedThroughput(ProvisionedThroughput provisionedThroughput) Represents the provisioned throughput settings for a specified table or index.
UpdateTableRequest	withTableName(String tableName) The name of the table to be updated.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateTableRequest

public UpdateTableRequest()

Default constructor for a new UpdateTableRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this 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 - Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Method Detail

getTableName

public 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(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(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()

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Returns:

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

setProvisionedThroughput

public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

withProvisionedThroughput

public UpdateTableRequest withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Returns a reference to this object so that method calls can be chained together.

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getGlobalSecondaryIndexUpdates

public List<GlobalSecondaryIndexUpdate> getGlobalSecondaryIndexUpdates()

An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.

Returns:

An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.

setGlobalSecondaryIndexUpdates

public void setGlobalSecondaryIndexUpdates(Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates)

An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.

Parameters:

globalSecondaryIndexUpdates - An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.

withGlobalSecondaryIndexUpdates

public UpdateTableRequest withGlobalSecondaryIndexUpdates(GlobalSecondaryIndexUpdate... globalSecondaryIndexUpdates)

An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.

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 on the table, together with provisioned throughput settings for each index.

Returns:

A reference to this updated 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 on the table, together with provisioned throughput settings for each index.

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 on the table, together with provisioned throughput settings for each index.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object