com.amazonaws.services.docdb.model.FailoverDBClusterRequest 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 FailoverDBCluster.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class FailoverDBClusterRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A cluster identifier to force a failover for. This parameter is not case sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
*
*/
private String dBClusterIdentifier;
/**
*
* The name of the instance to promote to the primary instance.
*
*
* You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example,
* mydbcluster-replica1.
*
*/
private String targetDBInstanceIdentifier;
/**
*
* A cluster identifier to force a failover for. This parameter is not case sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
*
*
* @param dBClusterIdentifier
* A cluster identifier to force a failover for. This parameter is not case sensitive.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
*/
public void setDBClusterIdentifier(String dBClusterIdentifier) {
this.dBClusterIdentifier = dBClusterIdentifier;
}
/**
*
* A cluster identifier to force a failover for. This parameter is not case sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
*
*
* @return A cluster identifier to force a failover for. This parameter is not case sensitive.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
*/
public String getDBClusterIdentifier() {
return this.dBClusterIdentifier;
}
/**
*
* A cluster identifier to force a failover for. This parameter is not case sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
*
*
* @param dBClusterIdentifier
* A cluster identifier to force a failover for. This parameter is not case sensitive.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBCluster.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FailoverDBClusterRequest withDBClusterIdentifier(String dBClusterIdentifier) {
setDBClusterIdentifier(dBClusterIdentifier);
return this;
}
/**
*
* The name of the instance to promote to the primary instance.
*
*
* You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example,
* mydbcluster-replica1.
*
*
* @param targetDBInstanceIdentifier
* The name of the instance to promote to the primary instance.
*
* You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example,
* mydbcluster-replica1.
*/
public void setTargetDBInstanceIdentifier(String targetDBInstanceIdentifier) {
this.targetDBInstanceIdentifier = targetDBInstanceIdentifier;
}
/**
*
* The name of the instance to promote to the primary instance.
*
*
* You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example,
* mydbcluster-replica1.
*
*
* @return The name of the instance to promote to the primary instance.
*
* You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example,
* mydbcluster-replica1.
*/
public String getTargetDBInstanceIdentifier() {
return this.targetDBInstanceIdentifier;
}
/**
*
* The name of the instance to promote to the primary instance.
*
*
* You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example,
* mydbcluster-replica1.
*
*
* @param targetDBInstanceIdentifier
* The name of the instance to promote to the primary instance.
*
* You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example,
* mydbcluster-replica1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FailoverDBClusterRequest withTargetDBInstanceIdentifier(String targetDBInstanceIdentifier) {
setTargetDBInstanceIdentifier(targetDBInstanceIdentifier);
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 (getTargetDBInstanceIdentifier() != null)
sb.append("TargetDBInstanceIdentifier: ").append(getTargetDBInstanceIdentifier());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof FailoverDBClusterRequest == false)
return false;
FailoverDBClusterRequest other = (FailoverDBClusterRequest) obj;
if (other.getDBClusterIdentifier() == null ^ this.getDBClusterIdentifier() == null)
return false;
if (other.getDBClusterIdentifier() != null && other.getDBClusterIdentifier().equals(this.getDBClusterIdentifier()) == false)
return false;
if (other.getTargetDBInstanceIdentifier() == null ^ this.getTargetDBInstanceIdentifier() == null)
return false;
if (other.getTargetDBInstanceIdentifier() != null && other.getTargetDBInstanceIdentifier().equals(this.getTargetDBInstanceIdentifier()) == 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 + ((getTargetDBInstanceIdentifier() == null) ? 0 : getTargetDBInstanceIdentifier().hashCode());
return hashCode;
}
@Override
public FailoverDBClusterRequest clone() {
return (FailoverDBClusterRequest) super.clone();
}
}