com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexUpdate Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2019-2024 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.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Represents one of the following:
*
*
* -
*
* A new global secondary index to be added to an existing table.
*
*
* -
*
* New provisioned throughput parameters for an existing global secondary index.
*
*
* -
*
* An existing global secondary index to be removed from an existing table.
*
*
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GlobalSecondaryIndexUpdate implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of an existing global secondary index, along with new provisioned throughput settings to be applied to
* that index.
*
*/
private UpdateGlobalSecondaryIndexAction update;
/**
*
* The parameters required for creating a global secondary index on an existing table:
*
*
* -
*
* IndexName
*
*
* -
*
* KeySchema
*
*
* -
*
* AttributeDefinitions
*
*
* -
*
* Projection
*
*
* -
*
* ProvisionedThroughput
*
*
*
*/
private CreateGlobalSecondaryIndexAction create;
/**
*
* The name of an existing global secondary index to be removed.
*
*/
private DeleteGlobalSecondaryIndexAction delete;
/**
*
* The name of an existing global secondary index, along with new provisioned throughput settings to be applied to
* that index.
*
*
* @param update
* The name of an existing global secondary index, along with new provisioned throughput settings to be
* applied to that index.
*/
public void setUpdate(UpdateGlobalSecondaryIndexAction update) {
this.update = update;
}
/**
*
* The name of an existing global secondary index, along with new provisioned throughput settings to be applied to
* that index.
*
*
* @return The name of an existing global secondary index, along with new provisioned throughput settings to be
* applied to that index.
*/
public UpdateGlobalSecondaryIndexAction getUpdate() {
return this.update;
}
/**
*
* The name of an existing global secondary index, along with new provisioned throughput settings to be applied to
* that index.
*
*
* @param update
* The name of an existing global secondary index, along with new provisioned throughput settings to be
* applied to that index.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlobalSecondaryIndexUpdate withUpdate(UpdateGlobalSecondaryIndexAction update) {
setUpdate(update);
return this;
}
/**
*
* The parameters required for creating a global secondary index on an existing table:
*
*
* -
*
* IndexName
*
*
* -
*
* KeySchema
*
*
* -
*
* AttributeDefinitions
*
*
* -
*
* Projection
*
*
* -
*
* ProvisionedThroughput
*
*
*
*
* @param create
* The parameters required for creating a global secondary index on an existing table:
*
* -
*
* IndexName
*
*
* -
*
* KeySchema
*
*
* -
*
* AttributeDefinitions
*
*
* -
*
* Projection
*
*
* -
*
* ProvisionedThroughput
*
*
*/
public void setCreate(CreateGlobalSecondaryIndexAction create) {
this.create = create;
}
/**
*
* The parameters required for creating a global secondary index on an existing table:
*
*
* -
*
* IndexName
*
*
* -
*
* KeySchema
*
*
* -
*
* AttributeDefinitions
*
*
* -
*
* Projection
*
*
* -
*
* ProvisionedThroughput
*
*
*
*
* @return The parameters required for creating a global secondary index on an existing table:
*
* -
*
* IndexName
*
*
* -
*
* KeySchema
*
*
* -
*
* AttributeDefinitions
*
*
* -
*
* Projection
*
*
* -
*
* ProvisionedThroughput
*
*
*/
public CreateGlobalSecondaryIndexAction getCreate() {
return this.create;
}
/**
*
* The parameters required for creating a global secondary index on an existing table:
*
*
* -
*
* IndexName
*
*
* -
*
* KeySchema
*
*
* -
*
* AttributeDefinitions
*
*
* -
*
* Projection
*
*
* -
*
* ProvisionedThroughput
*
*
*
*
* @param create
* The parameters required for creating a global secondary index on an existing table:
*
* -
*
* IndexName
*
*
* -
*
* KeySchema
*
*
* -
*
* AttributeDefinitions
*
*
* -
*
* Projection
*
*
* -
*
* ProvisionedThroughput
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlobalSecondaryIndexUpdate withCreate(CreateGlobalSecondaryIndexAction create) {
setCreate(create);
return this;
}
/**
*
* The name of an existing global secondary index to be removed.
*
*
* @param delete
* The name of an existing global secondary index to be removed.
*/
public void setDelete(DeleteGlobalSecondaryIndexAction delete) {
this.delete = delete;
}
/**
*
* The name of an existing global secondary index to be removed.
*
*
* @return The name of an existing global secondary index to be removed.
*/
public DeleteGlobalSecondaryIndexAction getDelete() {
return this.delete;
}
/**
*
* The name of an existing global secondary index to be removed.
*
*
* @param delete
* The name of an existing global secondary index to be removed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlobalSecondaryIndexUpdate withDelete(DeleteGlobalSecondaryIndexAction delete) {
setDelete(delete);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getUpdate() != null)
sb.append("Update: ").append(getUpdate()).append(",");
if (getCreate() != null)
sb.append("Create: ").append(getCreate()).append(",");
if (getDelete() != null)
sb.append("Delete: ").append(getDelete());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GlobalSecondaryIndexUpdate == false)
return false;
GlobalSecondaryIndexUpdate other = (GlobalSecondaryIndexUpdate) obj;
if (other.getUpdate() == null ^ this.getUpdate() == null)
return false;
if (other.getUpdate() != null && other.getUpdate().equals(this.getUpdate()) == false)
return false;
if (other.getCreate() == null ^ this.getCreate() == null)
return false;
if (other.getCreate() != null && other.getCreate().equals(this.getCreate()) == false)
return false;
if (other.getDelete() == null ^ this.getDelete() == null)
return false;
if (other.getDelete() != null && other.getDelete().equals(this.getDelete()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUpdate() == null) ? 0 : getUpdate().hashCode());
hashCode = prime * hashCode + ((getCreate() == null) ? 0 : getCreate().hashCode());
hashCode = prime * hashCode + ((getDelete() == null) ? 0 : getDelete().hashCode());
return hashCode;
}
@Override
public GlobalSecondaryIndexUpdate clone() {
try {
return (GlobalSecondaryIndexUpdate) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.dynamodbv2.model.transform.GlobalSecondaryIndexUpdateMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}