software.amazon.awssdk.services.rds.model.FailoverDbClusterRequest Maven / Gradle / Ivy
Show all versions of rds Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.rds.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class FailoverDbClusterRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField DB_CLUSTER_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBClusterIdentifier").getter(getter(FailoverDbClusterRequest::dbClusterIdentifier))
.setter(setter(Builder::dbClusterIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBClusterIdentifier").build())
.build();
private static final SdkField TARGET_DB_INSTANCE_IDENTIFIER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("TargetDBInstanceIdentifier")
.getter(getter(FailoverDbClusterRequest::targetDBInstanceIdentifier))
.setter(setter(Builder::targetDBInstanceIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetDBInstanceIdentifier").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DB_CLUSTER_IDENTIFIER_FIELD,
TARGET_DB_INSTANCE_IDENTIFIER_FIELD));
private final String dbClusterIdentifier;
private final String targetDBInstanceIdentifier;
private FailoverDbClusterRequest(BuilderImpl builder) {
super(builder);
this.dbClusterIdentifier = builder.dbClusterIdentifier;
this.targetDBInstanceIdentifier = builder.targetDBInstanceIdentifier;
}
/**
*
* The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DB cluster.
*
*
*
*
* @return The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DB cluster.
*
*
*/
public final String dbClusterIdentifier() {
return dbClusterIdentifier;
}
/**
*
* The name of the DB instance to promote to the primary DB instance.
*
*
* Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for
* example mydbcluster-replica1
.
*
*
* This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
*
*
* @return The name of the DB instance to promote to the primary DB instance.
*
* Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB
* cluster, for example mydbcluster-replica1
.
*
*
* This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
*/
public final String targetDBInstanceIdentifier() {
return targetDBInstanceIdentifier;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(dbClusterIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(targetDBInstanceIdentifier());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof FailoverDbClusterRequest)) {
return false;
}
FailoverDbClusterRequest other = (FailoverDbClusterRequest) obj;
return Objects.equals(dbClusterIdentifier(), other.dbClusterIdentifier())
&& Objects.equals(targetDBInstanceIdentifier(), other.targetDBInstanceIdentifier());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("FailoverDbClusterRequest").add("DBClusterIdentifier", dbClusterIdentifier())
.add("TargetDBInstanceIdentifier", targetDBInstanceIdentifier()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBClusterIdentifier":
return Optional.ofNullable(clazz.cast(dbClusterIdentifier()));
case "TargetDBInstanceIdentifier":
return Optional.ofNullable(clazz.cast(targetDBInstanceIdentifier()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DB cluster.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbClusterIdentifier(String dbClusterIdentifier);
/**
*
* The name of the DB instance to promote to the primary DB instance.
*
*
* Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,
* for example mydbcluster-replica1
.
*
*
* This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
*
*
* @param targetDBInstanceIdentifier
* The name of the DB instance to promote to the primary DB instance.
*
* Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB
* cluster, for example mydbcluster-replica1
.
*
*
* This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetDBInstanceIdentifier(String targetDBInstanceIdentifier);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String dbClusterIdentifier;
private String targetDBInstanceIdentifier;
private BuilderImpl() {
}
private BuilderImpl(FailoverDbClusterRequest model) {
super(model);
dbClusterIdentifier(model.dbClusterIdentifier);
targetDBInstanceIdentifier(model.targetDBInstanceIdentifier);
}
public final String getDbClusterIdentifier() {
return dbClusterIdentifier;
}
public final void setDbClusterIdentifier(String dbClusterIdentifier) {
this.dbClusterIdentifier = dbClusterIdentifier;
}
@Override
public final Builder dbClusterIdentifier(String dbClusterIdentifier) {
this.dbClusterIdentifier = dbClusterIdentifier;
return this;
}
public final String getTargetDBInstanceIdentifier() {
return targetDBInstanceIdentifier;
}
public final void setTargetDBInstanceIdentifier(String targetDBInstanceIdentifier) {
this.targetDBInstanceIdentifier = targetDBInstanceIdentifier;
}
@Override
public final Builder targetDBInstanceIdentifier(String targetDBInstanceIdentifier) {
this.targetDBInstanceIdentifier = targetDBInstanceIdentifier;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public FailoverDbClusterRequest build() {
return new FailoverDbClusterRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}