com.amazonaws.services.dynamodbv2.model.UpdateTableRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.dynamodbv2.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.dynamodbv2.AmazonDynamoDB#updateTable(UpdateTableRequest) UpdateTable operation}.
*
* 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 com.amazonaws.services.dynamodbv2.AmazonDynamoDB#updateTable(UpdateTableRequest)
*/
public class UpdateTableRequest extends AmazonWebServiceRequest implements Serializable {
/**
* 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 com.amazonaws.internal.ListWithAutoConstructFlag attributeDefinitions;
/**
* The name of the table to be updated.
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*/
private String tableName;
/**
* 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.
*/
private ProvisionedThroughput provisionedThroughput;
/**
* 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 com.amazonaws.internal.ListWithAutoConstructFlag globalSecondaryIndexUpdates;
/**
* 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.
*
*/
private StreamSpecification streamSpecification;
/**
* Default constructor for a new UpdateTableRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public UpdateTableRequest() {}
/**
* Constructs a new UpdateTableRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param tableName The name of the table to be updated.
* @param 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.
*/
public UpdateTableRequest(String tableName, ProvisionedThroughput provisionedThroughput) {
setTableName(tableName);
setProvisionedThroughput(provisionedThroughput);
}
/**
* 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.
*
* @return 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 java.util.List getAttributeDefinitions() {
return 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.
*
* @param 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 setAttributeDefinitions(java.util.Collection attributeDefinitions) {
if (attributeDefinitions == null) {
this.attributeDefinitions = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag attributeDefinitionsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(attributeDefinitions.size());
attributeDefinitionsCopy.addAll(attributeDefinitions);
this.attributeDefinitions = attributeDefinitionsCopy;
}
/**
* 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateTableRequest withAttributeDefinitions(AttributeDefinition... attributeDefinitions) {
if (getAttributeDefinitions() == null) setAttributeDefinitions(new java.util.ArrayList(attributeDefinitions.length));
for (AttributeDefinition value : attributeDefinitions) {
getAttributeDefinitions().add(value);
}
return this;
}
/**
* 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateTableRequest withAttributeDefinitions(java.util.Collection attributeDefinitions) {
if (attributeDefinitions == null) {
this.attributeDefinitions = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag attributeDefinitionsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(attributeDefinitions.size());
attributeDefinitionsCopy.addAll(attributeDefinitions);
this.attributeDefinitions = attributeDefinitionsCopy;
}
return this;
}
/**
* The name of the table to be updated.
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @return The name of the table to be updated.
*/
public String getTableName() {
return tableName;
}
/**
* The name of the table to be updated.
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @param tableName The name of the table to be updated.
*/
public void setTableName(String tableName) {
this.tableName = 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_.-]+
*
* @param tableName The name of the table to be updated.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateTableRequest withTableName(String tableName) {
this.tableName = tableName;
return this;
}
/**
* 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.
*
* @return 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.
*/
public ProvisionedThroughput getProvisionedThroughput() {
return 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.
*
* @param 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.
*/
public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput) {
this.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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateTableRequest withProvisionedThroughput(ProvisionedThroughput provisionedThroughput) {
this.provisionedThroughput = provisionedThroughput;
return this;
}
/**
* 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.
*
* @return 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 java.util.List getGlobalSecondaryIndexUpdates() {
return 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.
*
* @param 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 setGlobalSecondaryIndexUpdates(java.util.Collection globalSecondaryIndexUpdates) {
if (globalSecondaryIndexUpdates == null) {
this.globalSecondaryIndexUpdates = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag globalSecondaryIndexUpdatesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(globalSecondaryIndexUpdates.size());
globalSecondaryIndexUpdatesCopy.addAll(globalSecondaryIndexUpdates);
this.globalSecondaryIndexUpdates = globalSecondaryIndexUpdatesCopy;
}
/**
* 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateTableRequest withGlobalSecondaryIndexUpdates(GlobalSecondaryIndexUpdate... globalSecondaryIndexUpdates) {
if (getGlobalSecondaryIndexUpdates() == null) setGlobalSecondaryIndexUpdates(new java.util.ArrayList(globalSecondaryIndexUpdates.length));
for (GlobalSecondaryIndexUpdate value : globalSecondaryIndexUpdates) {
getGlobalSecondaryIndexUpdates().add(value);
}
return this;
}
/**
* 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateTableRequest withGlobalSecondaryIndexUpdates(java.util.Collection globalSecondaryIndexUpdates) {
if (globalSecondaryIndexUpdates == null) {
this.globalSecondaryIndexUpdates = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag globalSecondaryIndexUpdatesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(globalSecondaryIndexUpdates.size());
globalSecondaryIndexUpdatesCopy.addAll(globalSecondaryIndexUpdates);
this.globalSecondaryIndexUpdates = globalSecondaryIndexUpdatesCopy;
}
return this;
}
/**
* 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.
*
*
* @return 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() {
return 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.
*
*
* @param 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 void setStreamSpecification(StreamSpecification streamSpecification) {
this.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.
*
* @param 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.
*
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateTableRequest withStreamSpecification(StreamSpecification streamSpecification) {
this.streamSpecification = streamSpecification;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAttributeDefinitions() != null) sb.append("AttributeDefinitions: " + getAttributeDefinitions() + ",");
if (getTableName() != null) sb.append("TableName: " + getTableName() + ",");
if (getProvisionedThroughput() != null) sb.append("ProvisionedThroughput: " + getProvisionedThroughput() + ",");
if (getGlobalSecondaryIndexUpdates() != null) sb.append("GlobalSecondaryIndexUpdates: " + getGlobalSecondaryIndexUpdates() + ",");
if (getStreamSpecification() != null) sb.append("StreamSpecification: " + getStreamSpecification() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAttributeDefinitions() == null) ? 0 : getAttributeDefinitions().hashCode());
hashCode = prime * hashCode + ((getTableName() == null) ? 0 : getTableName().hashCode());
hashCode = prime * hashCode + ((getProvisionedThroughput() == null) ? 0 : getProvisionedThroughput().hashCode());
hashCode = prime * hashCode + ((getGlobalSecondaryIndexUpdates() == null) ? 0 : getGlobalSecondaryIndexUpdates().hashCode());
hashCode = prime * hashCode + ((getStreamSpecification() == null) ? 0 : getStreamSpecification().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof UpdateTableRequest == false) return false;
UpdateTableRequest other = (UpdateTableRequest)obj;
if (other.getAttributeDefinitions() == null ^ this.getAttributeDefinitions() == null) return false;
if (other.getAttributeDefinitions() != null && other.getAttributeDefinitions().equals(this.getAttributeDefinitions()) == false) return false;
if (other.getTableName() == null ^ this.getTableName() == null) return false;
if (other.getTableName() != null && other.getTableName().equals(this.getTableName()) == false) return false;
if (other.getProvisionedThroughput() == null ^ this.getProvisionedThroughput() == null) return false;
if (other.getProvisionedThroughput() != null && other.getProvisionedThroughput().equals(this.getProvisionedThroughput()) == false) return false;
if (other.getGlobalSecondaryIndexUpdates() == null ^ this.getGlobalSecondaryIndexUpdates() == null) return false;
if (other.getGlobalSecondaryIndexUpdates() != null && other.getGlobalSecondaryIndexUpdates().equals(this.getGlobalSecondaryIndexUpdates()) == false) return false;
if (other.getStreamSpecification() == null ^ this.getStreamSpecification() == null) return false;
if (other.getStreamSpecification() != null && other.getStreamSpecification().equals(this.getStreamSpecification()) == false) return false;
return true;
}
}