com.amazonaws.services.dynamodbv2.model.UpdateTableRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2012-2017 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input of an UpdateTable operation.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateTableRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.util.List attributeDefinitions;
/**
*
* The name of the table to be updated.
*
*/
private String tableName;
/**
*
* The new provisioned throughput settings for the specified table or index.
*
*/
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 java.util.List 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 UpdateTableRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize the 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
* The new provisioned throughput settings for the specified table or index.
*/
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;
}
this.attributeDefinitions = new java.util.ArrayList(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
* {@link #setAttributeDefinitions(java.util.Collection)} or {@link #withAttributeDefinitions(java.util.Collection)}
* if you want to override the existing values.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
public UpdateTableRequest withAttributeDefinitions(AttributeDefinition... attributeDefinitions) {
if (this.attributeDefinitions == null) {
setAttributeDefinitions(new java.util.ArrayList(attributeDefinitions.length));
}
for (AttributeDefinition ele : attributeDefinitions) {
this.attributeDefinitions.add(ele);
}
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.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
public UpdateTableRequest withAttributeDefinitions(java.util.Collection attributeDefinitions) {
setAttributeDefinitions(attributeDefinitions);
return this;
}
/**
*
* The name of the table to be updated.
*
*
* @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.
*
*
* @return The name of the table to be updated.
*/
public String getTableName() {
return this.tableName;
}
/**
*
* The name of the table to be updated.
*
*
* @param tableName
* The name of the table to be updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateTableRequest withTableName(String tableName) {
setTableName(tableName);
return this;
}
/**
*
* The new provisioned throughput settings for the specified table or index.
*
*
* @param provisionedThroughput
* The new provisioned throughput settings for the specified table or index.
*/
public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput) {
this.provisionedThroughput = provisionedThroughput;
}
/**
*
* The new provisioned throughput settings for the specified table or index.
*
*
* @return The new provisioned throughput settings for the specified table or index.
*/
public ProvisionedThroughput getProvisionedThroughput() {
return this.provisionedThroughput;
}
/**
*
* The new provisioned throughput settings for the specified table or index.
*
*
* @param provisionedThroughput
* The new provisioned throughput settings for the specified table or index.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateTableRequest withProvisionedThroughput(ProvisionedThroughput provisionedThroughput) {
setProvisionedThroughput(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;
}
this.globalSecondaryIndexUpdates = new java.util.ArrayList(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
* {@link #setGlobalSecondaryIndexUpdates(java.util.Collection)} or
* {@link #withGlobalSecondaryIndexUpdates(java.util.Collection)} if you want to override the existing values.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
public UpdateTableRequest withGlobalSecondaryIndexUpdates(GlobalSecondaryIndexUpdate... globalSecondaryIndexUpdates) {
if (this.globalSecondaryIndexUpdates == null) {
setGlobalSecondaryIndexUpdates(new java.util.ArrayList(globalSecondaryIndexUpdates.length));
}
for (GlobalSecondaryIndexUpdate ele : globalSecondaryIndexUpdates) {
this.globalSecondaryIndexUpdates.add(ele);
}
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.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
public UpdateTableRequest withGlobalSecondaryIndexUpdates(java.util.Collection globalSecondaryIndexUpdates) {
setGlobalSecondaryIndexUpdates(globalSecondaryIndexUpdates);
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.
*
*
*
* @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.
*
*
*
* @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 this.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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateTableRequest withStreamSpecification(StreamSpecification streamSpecification) {
setStreamSpecification(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: ").append(getAttributeDefinitions()).append(",");
if (getTableName() != null)
sb.append("TableName: ").append(getTableName()).append(",");
if (getProvisionedThroughput() != null)
sb.append("ProvisionedThroughput: ").append(getProvisionedThroughput()).append(",");
if (getGlobalSecondaryIndexUpdates() != null)
sb.append("GlobalSecondaryIndexUpdates: ").append(getGlobalSecondaryIndexUpdates()).append(",");
if (getStreamSpecification() != null)
sb.append("StreamSpecification: ").append(getStreamSpecification());
sb.append("}");
return sb.toString();
}
@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;
}
@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 UpdateTableRequest clone() {
return (UpdateTableRequest) super.clone();
}
}