Package com.amazonaws.services.dynamodbv2.model

Class UpdateTableRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.dynamodbv2.model.UpdateTableRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateTableRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input of an UpdateTable operation.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
UpdateTableRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
List<AttributeDefinition>	getAttributeDefinitions()	An array of attributes that describe the key schema for the table and indexes.
List<GlobalSecondaryIndexUpdate>	getGlobalSecondaryIndexUpdates()	An array of one or more global secondary indexes for the table.
ProvisionedThroughput	getProvisionedThroughput()
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	setGlobalSecondaryIndexUpdates(Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates)	An array of one or more global secondary indexes for the table.
void	setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
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; 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(Collection<AttributeDefinition> attributeDefinitions)	An array of attributes that describe the key schema for the table and indexes.
UpdateTableRequest	withGlobalSecondaryIndexUpdates(GlobalSecondaryIndexUpdate... globalSecondaryIndexUpdates)	An array of one or more global secondary indexes for the table.
UpdateTableRequest	withGlobalSecondaryIndexUpdates(Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates)	An array of one or more global secondary indexes for the table.
UpdateTableRequest	withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
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 com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

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 -

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.

setProvisionedThroughput

public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)

Parameters:

provisionedThroughput -

getProvisionedThroughput

public ProvisionedThroughput getProvisionedThroughput()

Returns:

withProvisionedThroughput

public UpdateTableRequest withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)

Parameters:

provisionedThroughput -

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.

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateTableRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()