com.amazonaws.services.docdb.model.DeleteDBClusterRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-docdb 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.docdb.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input to DeleteDBCluster.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DeleteDBClusterRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match an existing DBClusterIdentifier.
*
*
*
*/
private String dBClusterIdentifier;
/**
*
* Determines whether a final cluster snapshot is created before the cluster is deleted. If true is
* specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created
* before the DB cluster is deleted.
*
*
*
* If SkipFinalSnapshot is false, you must specify a
* FinalDBSnapshotIdentifier parameter.
*
*
*
* Default: false
*
*/
private Boolean skipFinalSnapshot;
/**
*
* The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to
* false.
*
*
*
* Specifying this parameter and also setting the SkipFinalShapshot parameter to true
* results in an error.
*
*
*
* Constraints:
*
*
* -
*
* Must be from 1 to 255 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*/
private String finalDBSnapshotIdentifier;
/**
*
* The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match an existing DBClusterIdentifier.
*
*
*
*
* @param dBClusterIdentifier
* The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
*
* Constraints:
*
*
* -
*
* Must match an existing DBClusterIdentifier.
*
*
*/
public void setDBClusterIdentifier(String dBClusterIdentifier) {
this.dBClusterIdentifier = dBClusterIdentifier;
}
/**
*
* The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match an existing DBClusterIdentifier.
*
*
*
*
* @return The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
*
* Constraints:
*
*
* -
*
* Must match an existing DBClusterIdentifier.
*
*
*/
public String getDBClusterIdentifier() {
return this.dBClusterIdentifier;
}
/**
*
* The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match an existing DBClusterIdentifier.
*
*
*
*
* @param dBClusterIdentifier
* The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
*
* Constraints:
*
*
* -
*
* Must match an existing DBClusterIdentifier.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteDBClusterRequest withDBClusterIdentifier(String dBClusterIdentifier) {
setDBClusterIdentifier(dBClusterIdentifier);
return this;
}
/**
*
* Determines whether a final cluster snapshot is created before the cluster is deleted. If true is
* specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created
* before the DB cluster is deleted.
*
*
*
* If SkipFinalSnapshot is false, you must specify a
* FinalDBSnapshotIdentifier parameter.
*
*
*
* Default: false
*
*
* @param skipFinalSnapshot
* Determines whether a final cluster snapshot is created before the cluster is deleted. If true
* is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is
* created before the DB cluster is deleted.
*
* If SkipFinalSnapshot is false, you must specify a
* FinalDBSnapshotIdentifier parameter.
*
*
*
* Default: false
*/
public void setSkipFinalSnapshot(Boolean skipFinalSnapshot) {
this.skipFinalSnapshot = skipFinalSnapshot;
}
/**
*
* Determines whether a final cluster snapshot is created before the cluster is deleted. If true is
* specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created
* before the DB cluster is deleted.
*
*
*
* If SkipFinalSnapshot is false, you must specify a
* FinalDBSnapshotIdentifier parameter.
*
*
*
* Default: false
*
*
* @return Determines whether a final cluster snapshot is created before the cluster is deleted. If
* true is specified, no cluster snapshot is created. If false is specified, a
* cluster snapshot is created before the DB cluster is deleted.
*
* If SkipFinalSnapshot is false, you must specify a
* FinalDBSnapshotIdentifier parameter.
*
*
*
* Default: false
*/
public Boolean getSkipFinalSnapshot() {
return this.skipFinalSnapshot;
}
/**
*
* Determines whether a final cluster snapshot is created before the cluster is deleted. If true is
* specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created
* before the DB cluster is deleted.
*
*
*
* If SkipFinalSnapshot is false, you must specify a
* FinalDBSnapshotIdentifier parameter.
*
*
*
* Default: false
*
*
* @param skipFinalSnapshot
* Determines whether a final cluster snapshot is created before the cluster is deleted. If true
* is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is
* created before the DB cluster is deleted.
*
* If SkipFinalSnapshot is false, you must specify a
* FinalDBSnapshotIdentifier parameter.
*
*
*
* Default: false
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteDBClusterRequest withSkipFinalSnapshot(Boolean skipFinalSnapshot) {
setSkipFinalSnapshot(skipFinalSnapshot);
return this;
}
/**
*
* Determines whether a final cluster snapshot is created before the cluster is deleted. If true is
* specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created
* before the DB cluster is deleted.
*
*
*
* If SkipFinalSnapshot is false, you must specify a
* FinalDBSnapshotIdentifier parameter.
*
*
*
* Default: false
*
*
* @return Determines whether a final cluster snapshot is created before the cluster is deleted. If
* true is specified, no cluster snapshot is created. If false is specified, a
* cluster snapshot is created before the DB cluster is deleted.
*
* If SkipFinalSnapshot is false, you must specify a
* FinalDBSnapshotIdentifier parameter.
*
*
*
* Default: false
*/
public Boolean isSkipFinalSnapshot() {
return this.skipFinalSnapshot;
}
/**
*
* The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to
* false.
*
*
*
* Specifying this parameter and also setting the SkipFinalShapshot parameter to true
* results in an error.
*
*
*
* Constraints:
*
*
* -
*
* Must be from 1 to 255 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* @param finalDBSnapshotIdentifier
* The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is
* set to false.
*
* Specifying this parameter and also setting the SkipFinalShapshot parameter to
* true results in an error.
*
*
*
* Constraints:
*
*
* -
*
* Must be from 1 to 255 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*/
public void setFinalDBSnapshotIdentifier(String finalDBSnapshotIdentifier) {
this.finalDBSnapshotIdentifier = finalDBSnapshotIdentifier;
}
/**
*
* The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to
* false.
*
*
*
* Specifying this parameter and also setting the SkipFinalShapshot parameter to true
* results in an error.
*
*
*
* Constraints:
*
*
* -
*
* Must be from 1 to 255 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* @return The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot
* is set to false.
*
* Specifying this parameter and also setting the SkipFinalShapshot parameter to
* true results in an error.
*
*
*
* Constraints:
*
*
* -
*
* Must be from 1 to 255 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*/
public String getFinalDBSnapshotIdentifier() {
return this.finalDBSnapshotIdentifier;
}
/**
*
* The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to
* false.
*
*
*
* Specifying this parameter and also setting the SkipFinalShapshot parameter to true
* results in an error.
*
*
*
* Constraints:
*
*
* -
*
* Must be from 1 to 255 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* @param finalDBSnapshotIdentifier
* The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is
* set to false.
*
* Specifying this parameter and also setting the SkipFinalShapshot parameter to
* true results in an error.
*
*
*
* Constraints:
*
*
* -
*
* Must be from 1 to 255 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteDBClusterRequest withFinalDBSnapshotIdentifier(String finalDBSnapshotIdentifier) {
setFinalDBSnapshotIdentifier(finalDBSnapshotIdentifier);
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 (getDBClusterIdentifier() != null)
sb.append("DBClusterIdentifier: ").append(getDBClusterIdentifier()).append(",");
if (getSkipFinalSnapshot() != null)
sb.append("SkipFinalSnapshot: ").append(getSkipFinalSnapshot()).append(",");
if (getFinalDBSnapshotIdentifier() != null)
sb.append("FinalDBSnapshotIdentifier: ").append(getFinalDBSnapshotIdentifier());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeleteDBClusterRequest == false)
return false;
DeleteDBClusterRequest other = (DeleteDBClusterRequest) obj;
if (other.getDBClusterIdentifier() == null ^ this.getDBClusterIdentifier() == null)
return false;
if (other.getDBClusterIdentifier() != null && other.getDBClusterIdentifier().equals(this.getDBClusterIdentifier()) == false)
return false;
if (other.getSkipFinalSnapshot() == null ^ this.getSkipFinalSnapshot() == null)
return false;
if (other.getSkipFinalSnapshot() != null && other.getSkipFinalSnapshot().equals(this.getSkipFinalSnapshot()) == false)
return false;
if (other.getFinalDBSnapshotIdentifier() == null ^ this.getFinalDBSnapshotIdentifier() == null)
return false;
if (other.getFinalDBSnapshotIdentifier() != null && other.getFinalDBSnapshotIdentifier().equals(this.getFinalDBSnapshotIdentifier()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDBClusterIdentifier() == null) ? 0 : getDBClusterIdentifier().hashCode());
hashCode = prime * hashCode + ((getSkipFinalSnapshot() == null) ? 0 : getSkipFinalSnapshot().hashCode());
hashCode = prime * hashCode + ((getFinalDBSnapshotIdentifier() == null) ? 0 : getFinalDBSnapshotIdentifier().hashCode());
return hashCode;
}
@Override
public DeleteDBClusterRequest clone() {
return (DeleteDBClusterRequest) super.clone();
}
}