Class UpdateTableRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input of an UpdateTable operation.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for UpdateTableRequest object.UpdateTableRequest
(String tableName, ProvisionedThroughput provisionedThroughput) Constructs a new UpdateTableRequest object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
An array of attributes that describe the key schema for the table and indexes.An array of one or more global secondary indexes for the table.Represents the DynamoDB Streams configuration for the table.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.toString()
Returns a string representation of this object; useful for testing and debugging.withAttributeDefinitions
(AttributeDefinition... attributeDefinitions) An array of attributes that describe the key schema for the table and indexes.withAttributeDefinitions
(Collection<AttributeDefinition> attributeDefinitions) An array of attributes that describe the key schema for the table and indexes.withGlobalSecondaryIndexUpdates
(GlobalSecondaryIndexUpdate... globalSecondaryIndexUpdates) An array of one or more global secondary indexes for the table.withGlobalSecondaryIndexUpdates
(Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates) An array of one or more global secondary indexes for the table.withProvisionedThroughput
(ProvisionedThroughput provisionedThroughput) withStreamSpecification
(StreamSpecification streamSpecification) Represents the DynamoDB Streams configuration for the table.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
-
Constructor Details
-
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
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 Details
-
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
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
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)
orwithAttributeDefinitions(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
The name of the table to be updated.
- Parameters:
tableName
- The name of the table to be updated.
-
getTableName
The name of the table to be updated.
- Returns:
- The name of the table to be updated.
-
withTableName
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
- Parameters:
provisionedThroughput
-
-
getProvisionedThroughput
- Returns:
-
withProvisionedThroughput
- Parameters:
provisionedThroughput
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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)
orwithGlobalSecondaryIndexUpdates(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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-