software.amazon.awssdk.services.rds.model.PromoteReadReplicaRequest 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 PromoteReadReplicaRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField DB_INSTANCE_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBInstanceIdentifier").getter(getter(PromoteReadReplicaRequest::dbInstanceIdentifier))
.setter(setter(Builder::dbInstanceIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBInstanceIdentifier").build())
.build();
private static final SdkField BACKUP_RETENTION_PERIOD_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("BackupRetentionPeriod").getter(getter(PromoteReadReplicaRequest::backupRetentionPeriod))
.setter(setter(Builder::backupRetentionPeriod))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BackupRetentionPeriod").build())
.build();
private static final SdkField PREFERRED_BACKUP_WINDOW_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PreferredBackupWindow").getter(getter(PromoteReadReplicaRequest::preferredBackupWindow))
.setter(setter(Builder::preferredBackupWindow))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PreferredBackupWindow").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DB_INSTANCE_IDENTIFIER_FIELD,
BACKUP_RETENTION_PERIOD_FIELD, PREFERRED_BACKUP_WINDOW_FIELD));
private final String dbInstanceIdentifier;
private final Integer backupRetentionPeriod;
private final String preferredBackupWindow;
private PromoteReadReplicaRequest(BuilderImpl builder) {
super(builder);
this.dbInstanceIdentifier = builder.dbInstanceIdentifier;
this.backupRetentionPeriod = builder.backupRetentionPeriod;
this.preferredBackupWindow = builder.preferredBackupWindow;
}
/**
*
* The DB instance identifier. This value is stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing read replica DB instance.
*
*
*
*
* Example: mydbinstance
*
*
* @return The DB instance identifier. This value is stored as a lowercase string.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing read replica DB instance.
*
*
*
*
* Example: mydbinstance
*/
public final String dbInstanceIdentifier() {
return dbInstanceIdentifier;
}
/**
*
* The number of days for which automated backups are retained. Setting this parameter to a positive number enables
* backups. Setting this parameter to 0 disables automated backups.
*
*
* Default: 1
*
*
* Constraints:
*
*
* -
*
* Must be a value from 0 to 35.
*
*
* -
*
* Can't be set to 0 if the DB instance is a source to read replicas.
*
*
*
*
* @return The number of days for which automated backups are retained. Setting this parameter to a positive number
* enables backups. Setting this parameter to 0 disables automated backups.
*
* Default: 1
*
*
* Constraints:
*
*
* -
*
* Must be a value from 0 to 35.
*
*
* -
*
* Can't be set to 0 if the DB instance is a source to read replicas.
*
*
*/
public final Integer backupRetentionPeriod() {
return backupRetentionPeriod;
}
/**
*
* The daily time range during which automated backups are created if automated backups are enabled, using the
* BackupRetentionPeriod parameter.
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services
* Region. To see the time blocks available, see Adjusting the
* Preferred Maintenance Window in the Amazon RDS User Guide.
*
*
* Constraints:
*
*
* -
*
* Must be in the format hh24:mi-hh24:mi.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*
*
* @return The daily time range during which automated backups are created if automated backups are enabled, using
* the BackupRetentionPeriod parameter.
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web
* Services Region. To see the time blocks available, see
* Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
*
*
* Constraints:
*
*
* -
*
* Must be in the format hh24:mi-hh24:mi.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*/
public final String preferredBackupWindow() {
return preferredBackupWindow;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(dbInstanceIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(backupRetentionPeriod());
hashCode = 31 * hashCode + Objects.hashCode(preferredBackupWindow());
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 PromoteReadReplicaRequest)) {
return false;
}
PromoteReadReplicaRequest other = (PromoteReadReplicaRequest) obj;
return Objects.equals(dbInstanceIdentifier(), other.dbInstanceIdentifier())
&& Objects.equals(backupRetentionPeriod(), other.backupRetentionPeriod())
&& Objects.equals(preferredBackupWindow(), other.preferredBackupWindow());
}
/**
* 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("PromoteReadReplicaRequest").add("DBInstanceIdentifier", dbInstanceIdentifier())
.add("BackupRetentionPeriod", backupRetentionPeriod()).add("PreferredBackupWindow", preferredBackupWindow())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBInstanceIdentifier":
return Optional.ofNullable(clazz.cast(dbInstanceIdentifier()));
case "BackupRetentionPeriod":
return Optional.ofNullable(clazz.cast(backupRetentionPeriod()));
case "PreferredBackupWindow":
return Optional.ofNullable(clazz.cast(preferredBackupWindow()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PromoteReadReplicaRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The DB instance identifier. This value is stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing read replica DB instance.
*
*
*
*
* Example: mydbinstance
*
*
* @param dbInstanceIdentifier
* The DB instance identifier. This value is stored as a lowercase string.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing read replica DB instance.
*
*
*
*
* Example: mydbinstance
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbInstanceIdentifier(String dbInstanceIdentifier);
/**
*
* The number of days for which automated backups are retained. Setting this parameter to a positive number
* enables backups. Setting this parameter to 0 disables automated backups.
*
*
* Default: 1
*
*
* Constraints:
*
*
* -
*
* Must be a value from 0 to 35.
*
*
* -
*
* Can't be set to 0 if the DB instance is a source to read replicas.
*
*
*
*
* @param backupRetentionPeriod
* The number of days for which automated backups are retained. Setting this parameter to a positive
* number enables backups. Setting this parameter to 0 disables automated backups.
*
* Default: 1
*
*
* Constraints:
*
*
* -
*
* Must be a value from 0 to 35.
*
*
* -
*
* Can't be set to 0 if the DB instance is a source to read replicas.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder backupRetentionPeriod(Integer backupRetentionPeriod);
/**
*
* The daily time range during which automated backups are created if automated backups are enabled, using the
* BackupRetentionPeriod parameter.
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web
* Services Region. To see the time blocks available, see Adjusting
* the Preferred Maintenance Window in the Amazon RDS User Guide.
*
*
* Constraints:
*
*
* -
*
* Must be in the format hh24:mi-hh24:mi.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*
*
* @param preferredBackupWindow
* The daily time range during which automated backups are created if automated backups are enabled,
* using the BackupRetentionPeriod parameter.
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web
* Services Region. To see the time blocks available, see
* Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
*
*
* Constraints:
*
*
* -
*
* Must be in the format hh24:mi-hh24:mi.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder preferredBackupWindow(String preferredBackupWindow);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String dbInstanceIdentifier;
private Integer backupRetentionPeriod;
private String preferredBackupWindow;
private BuilderImpl() {
}
private BuilderImpl(PromoteReadReplicaRequest model) {
super(model);
dbInstanceIdentifier(model.dbInstanceIdentifier);
backupRetentionPeriod(model.backupRetentionPeriod);
preferredBackupWindow(model.preferredBackupWindow);
}
public final String getDbInstanceIdentifier() {
return dbInstanceIdentifier;
}
public final void setDbInstanceIdentifier(String dbInstanceIdentifier) {
this.dbInstanceIdentifier = dbInstanceIdentifier;
}
@Override
public final Builder dbInstanceIdentifier(String dbInstanceIdentifier) {
this.dbInstanceIdentifier = dbInstanceIdentifier;
return this;
}
public final Integer getBackupRetentionPeriod() {
return backupRetentionPeriod;
}
public final void setBackupRetentionPeriod(Integer backupRetentionPeriod) {
this.backupRetentionPeriod = backupRetentionPeriod;
}
@Override
public final Builder backupRetentionPeriod(Integer backupRetentionPeriod) {
this.backupRetentionPeriod = backupRetentionPeriod;
return this;
}
public final String getPreferredBackupWindow() {
return preferredBackupWindow;
}
public final void setPreferredBackupWindow(String preferredBackupWindow) {
this.preferredBackupWindow = preferredBackupWindow;
}
@Override
public final Builder preferredBackupWindow(String preferredBackupWindow) {
this.preferredBackupWindow = preferredBackupWindow;
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 PromoteReadReplicaRequest build() {
return new PromoteReadReplicaRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}