public class UpdateTableRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Represents the input of an UpdateTable operation.
Modifier and Type | Field and Description |
---|---|
private java.util.List<AttributeDefinition> |
attributeDefinitions
An array of attributes that describe the key schema for the table and
indexes.
|
private java.util.List<GlobalSecondaryIndexUpdate> |
globalSecondaryIndexUpdates
An array of one or more global secondary indexes for the table.
|
private ProvisionedThroughput |
provisionedThroughput |
private StreamSpecification |
streamSpecification
Represents the DynamoDB Streams configuration for the table.
|
private java.lang.String |
tableName
The name of the table to be updated.
|
NOOP
Constructor and Description |
---|
UpdateTableRequest()
Default constructor for UpdateTableRequest object.
|
UpdateTableRequest(java.lang.String tableName,
ProvisionedThroughput provisionedThroughput)
Constructs a new UpdateTableRequest object.
|
Modifier and Type | Method and Description |
---|---|
UpdateTableRequest |
clone()
Creates a shallow clone of this request.
|
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() |
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) |
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) |
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.
|
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
private java.util.List<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.
private java.lang.String tableName
The name of the table to be updated.
private ProvisionedThroughput provisionedThroughput
private java.util.List<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.
private 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.
public UpdateTableRequest()
public UpdateTableRequest(java.lang.String tableName, ProvisionedThroughput provisionedThroughput)
tableName
- The name of the table to be updated.provisionedThroughput
- 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.
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.
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.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.
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.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.
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.public void setTableName(java.lang.String tableName)
The name of the table to be updated.
tableName
- The name of the table to be updated.public java.lang.String getTableName()
The name of the table to be updated.
public UpdateTableRequest withTableName(java.lang.String tableName)
The name of the table to be updated.
tableName
- The name of the table to be updated.public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
provisionedThroughput
- public ProvisionedThroughput getProvisionedThroughput()
public UpdateTableRequest withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
provisionedThroughput
- 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public UpdateTableRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()