com.amazonaws.services.elasticache.model.DecreaseReplicaCountRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticache 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.elasticache.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DecreaseReplicaCountRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The id of the replication group from which you want to remove replica nodes.
*
*/
private String replicationGroupId;
/**
*
* The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster mode
* disabled) replication groups, this is the number of replica nodes in the replication group. For Redis OSS
* (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's
* node groups.
*
*
* The minimum number of replicas in a shard or replication group is:
*
*
* -
*
* Redis OSS (cluster mode disabled)
*
*
* -
*
* If Multi-AZ is enabled: 1
*
*
* -
*
* If Multi-AZ is not enabled: 0
*
*
*
*
* -
*
* Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node
* fails)
*
*
*
*/
private Integer newReplicaCount;
/**
*
* A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS (cluster
* mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount,
* NodeGroupId, and PreferredAvailabilityZones.
*
*/
private com.amazonaws.internal.SdkInternalList replicaConfiguration;
/**
*
* A list of the node ids to remove from the replication group or node group (shard).
*
*/
private com.amazonaws.internal.SdkInternalList replicasToRemove;
/**
*
* If True, the number of replica nodes is decreased immediately. ApplyImmediately=False
* is not currently supported.
*
*/
private Boolean applyImmediately;
/**
*
* The id of the replication group from which you want to remove replica nodes.
*
*
* @param replicationGroupId
* The id of the replication group from which you want to remove replica nodes.
*/
public void setReplicationGroupId(String replicationGroupId) {
this.replicationGroupId = replicationGroupId;
}
/**
*
* The id of the replication group from which you want to remove replica nodes.
*
*
* @return The id of the replication group from which you want to remove replica nodes.
*/
public String getReplicationGroupId() {
return this.replicationGroupId;
}
/**
*
* The id of the replication group from which you want to remove replica nodes.
*
*
* @param replicationGroupId
* The id of the replication group from which you want to remove replica nodes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DecreaseReplicaCountRequest withReplicationGroupId(String replicationGroupId) {
setReplicationGroupId(replicationGroupId);
return this;
}
/**
*
* The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster mode
* disabled) replication groups, this is the number of replica nodes in the replication group. For Redis OSS
* (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's
* node groups.
*
*
* The minimum number of replicas in a shard or replication group is:
*
*
* -
*
* Redis OSS (cluster mode disabled)
*
*
* -
*
* If Multi-AZ is enabled: 1
*
*
* -
*
* If Multi-AZ is not enabled: 0
*
*
*
*
* -
*
* Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node
* fails)
*
*
*
*
* @param newReplicaCount
* The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster mode
* disabled) replication groups, this is the number of replica nodes in the replication group. For Redis OSS
* (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication
* group's node groups.
*
* The minimum number of replicas in a shard or replication group is:
*
*
* -
*
* Redis OSS (cluster mode disabled)
*
*
* -
*
* If Multi-AZ is enabled: 1
*
*
* -
*
* If Multi-AZ is not enabled: 0
*
*
*
*
* -
*
* Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary
* node fails)
*
*
*/
public void setNewReplicaCount(Integer newReplicaCount) {
this.newReplicaCount = newReplicaCount;
}
/**
*
* The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster mode
* disabled) replication groups, this is the number of replica nodes in the replication group. For Redis OSS
* (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's
* node groups.
*
*
* The minimum number of replicas in a shard or replication group is:
*
*
* -
*
* Redis OSS (cluster mode disabled)
*
*
* -
*
* If Multi-AZ is enabled: 1
*
*
* -
*
* If Multi-AZ is not enabled: 0
*
*
*
*
* -
*
* Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node
* fails)
*
*
*
*
* @return The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster
* mode disabled) replication groups, this is the number of replica nodes in the replication group. For
* Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the
* replication group's node groups.
*
* The minimum number of replicas in a shard or replication group is:
*
*
* -
*
* Redis OSS (cluster mode disabled)
*
*
* -
*
* If Multi-AZ is enabled: 1
*
*
* -
*
* If Multi-AZ is not enabled: 0
*
*
*
*
* -
*
* Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary
* node fails)
*
*
*/
public Integer getNewReplicaCount() {
return this.newReplicaCount;
}
/**
*
* The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster mode
* disabled) replication groups, this is the number of replica nodes in the replication group. For Redis OSS
* (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's
* node groups.
*
*
* The minimum number of replicas in a shard or replication group is:
*
*
* -
*
* Redis OSS (cluster mode disabled)
*
*
* -
*
* If Multi-AZ is enabled: 1
*
*
* -
*
* If Multi-AZ is not enabled: 0
*
*
*
*
* -
*
* Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node
* fails)
*
*
*
*
* @param newReplicaCount
* The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster mode
* disabled) replication groups, this is the number of replica nodes in the replication group. For Redis OSS
* (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication
* group's node groups.
*
* The minimum number of replicas in a shard or replication group is:
*
*
* -
*
* Redis OSS (cluster mode disabled)
*
*
* -
*
* If Multi-AZ is enabled: 1
*
*
* -
*
* If Multi-AZ is not enabled: 0
*
*
*
*
* -
*
* Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary
* node fails)
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DecreaseReplicaCountRequest withNewReplicaCount(Integer newReplicaCount) {
setNewReplicaCount(newReplicaCount);
return this;
}
/**
*
* A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS (cluster
* mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount,
* NodeGroupId, and PreferredAvailabilityZones.
*
*
* @return A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS
* (cluster mode enabled) replication group. The ConfigureShard has three members:
* NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
*/
public java.util.List getReplicaConfiguration() {
if (replicaConfiguration == null) {
replicaConfiguration = new com.amazonaws.internal.SdkInternalList();
}
return replicaConfiguration;
}
/**
*
* A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS (cluster
* mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount,
* NodeGroupId, and PreferredAvailabilityZones.
*
*
* @param replicaConfiguration
* A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS
* (cluster mode enabled) replication group. The ConfigureShard has three members:
* NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
*/
public void setReplicaConfiguration(java.util.Collection replicaConfiguration) {
if (replicaConfiguration == null) {
this.replicaConfiguration = null;
return;
}
this.replicaConfiguration = new com.amazonaws.internal.SdkInternalList(replicaConfiguration);
}
/**
*
* A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS (cluster
* mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount,
* NodeGroupId, and PreferredAvailabilityZones.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setReplicaConfiguration(java.util.Collection)} or {@link #withReplicaConfiguration(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param replicaConfiguration
* A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS
* (cluster mode enabled) replication group. The ConfigureShard has three members:
* NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DecreaseReplicaCountRequest withReplicaConfiguration(ConfigureShard... replicaConfiguration) {
if (this.replicaConfiguration == null) {
setReplicaConfiguration(new com.amazonaws.internal.SdkInternalList(replicaConfiguration.length));
}
for (ConfigureShard ele : replicaConfiguration) {
this.replicaConfiguration.add(ele);
}
return this;
}
/**
*
* A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS (cluster
* mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount,
* NodeGroupId, and PreferredAvailabilityZones.
*
*
* @param replicaConfiguration
* A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS
* (cluster mode enabled) replication group. The ConfigureShard has three members:
* NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DecreaseReplicaCountRequest withReplicaConfiguration(java.util.Collection replicaConfiguration) {
setReplicaConfiguration(replicaConfiguration);
return this;
}
/**
*
* A list of the node ids to remove from the replication group or node group (shard).
*
*
* @return A list of the node ids to remove from the replication group or node group (shard).
*/
public java.util.List getReplicasToRemove() {
if (replicasToRemove == null) {
replicasToRemove = new com.amazonaws.internal.SdkInternalList();
}
return replicasToRemove;
}
/**
*
* A list of the node ids to remove from the replication group or node group (shard).
*
*
* @param replicasToRemove
* A list of the node ids to remove from the replication group or node group (shard).
*/
public void setReplicasToRemove(java.util.Collection replicasToRemove) {
if (replicasToRemove == null) {
this.replicasToRemove = null;
return;
}
this.replicasToRemove = new com.amazonaws.internal.SdkInternalList(replicasToRemove);
}
/**
*
* A list of the node ids to remove from the replication group or node group (shard).
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setReplicasToRemove(java.util.Collection)} or {@link #withReplicasToRemove(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param replicasToRemove
* A list of the node ids to remove from the replication group or node group (shard).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DecreaseReplicaCountRequest withReplicasToRemove(String... replicasToRemove) {
if (this.replicasToRemove == null) {
setReplicasToRemove(new com.amazonaws.internal.SdkInternalList(replicasToRemove.length));
}
for (String ele : replicasToRemove) {
this.replicasToRemove.add(ele);
}
return this;
}
/**
*
* A list of the node ids to remove from the replication group or node group (shard).
*
*
* @param replicasToRemove
* A list of the node ids to remove from the replication group or node group (shard).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DecreaseReplicaCountRequest withReplicasToRemove(java.util.Collection replicasToRemove) {
setReplicasToRemove(replicasToRemove);
return this;
}
/**
*
* If True, the number of replica nodes is decreased immediately. ApplyImmediately=False
* is not currently supported.
*
*
* @param applyImmediately
* If True, the number of replica nodes is decreased immediately.
* ApplyImmediately=False is not currently supported.
*/
public void setApplyImmediately(Boolean applyImmediately) {
this.applyImmediately = applyImmediately;
}
/**
*
* If True, the number of replica nodes is decreased immediately. ApplyImmediately=False
* is not currently supported.
*
*
* @return If True, the number of replica nodes is decreased immediately.
* ApplyImmediately=False is not currently supported.
*/
public Boolean getApplyImmediately() {
return this.applyImmediately;
}
/**
*
* If True, the number of replica nodes is decreased immediately. ApplyImmediately=False
* is not currently supported.
*
*
* @param applyImmediately
* If True, the number of replica nodes is decreased immediately.
* ApplyImmediately=False is not currently supported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DecreaseReplicaCountRequest withApplyImmediately(Boolean applyImmediately) {
setApplyImmediately(applyImmediately);
return this;
}
/**
*
* If True, the number of replica nodes is decreased immediately. ApplyImmediately=False
* is not currently supported.
*
*
* @return If True, the number of replica nodes is decreased immediately.
* ApplyImmediately=False is not currently supported.
*/
public Boolean isApplyImmediately() {
return this.applyImmediately;
}
/**
* 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 (getReplicationGroupId() != null)
sb.append("ReplicationGroupId: ").append(getReplicationGroupId()).append(",");
if (getNewReplicaCount() != null)
sb.append("NewReplicaCount: ").append(getNewReplicaCount()).append(",");
if (getReplicaConfiguration() != null)
sb.append("ReplicaConfiguration: ").append(getReplicaConfiguration()).append(",");
if (getReplicasToRemove() != null)
sb.append("ReplicasToRemove: ").append(getReplicasToRemove()).append(",");
if (getApplyImmediately() != null)
sb.append("ApplyImmediately: ").append(getApplyImmediately());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DecreaseReplicaCountRequest == false)
return false;
DecreaseReplicaCountRequest other = (DecreaseReplicaCountRequest) obj;
if (other.getReplicationGroupId() == null ^ this.getReplicationGroupId() == null)
return false;
if (other.getReplicationGroupId() != null && other.getReplicationGroupId().equals(this.getReplicationGroupId()) == false)
return false;
if (other.getNewReplicaCount() == null ^ this.getNewReplicaCount() == null)
return false;
if (other.getNewReplicaCount() != null && other.getNewReplicaCount().equals(this.getNewReplicaCount()) == false)
return false;
if (other.getReplicaConfiguration() == null ^ this.getReplicaConfiguration() == null)
return false;
if (other.getReplicaConfiguration() != null && other.getReplicaConfiguration().equals(this.getReplicaConfiguration()) == false)
return false;
if (other.getReplicasToRemove() == null ^ this.getReplicasToRemove() == null)
return false;
if (other.getReplicasToRemove() != null && other.getReplicasToRemove().equals(this.getReplicasToRemove()) == false)
return false;
if (other.getApplyImmediately() == null ^ this.getApplyImmediately() == null)
return false;
if (other.getApplyImmediately() != null && other.getApplyImmediately().equals(this.getApplyImmediately()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getReplicationGroupId() == null) ? 0 : getReplicationGroupId().hashCode());
hashCode = prime * hashCode + ((getNewReplicaCount() == null) ? 0 : getNewReplicaCount().hashCode());
hashCode = prime * hashCode + ((getReplicaConfiguration() == null) ? 0 : getReplicaConfiguration().hashCode());
hashCode = prime * hashCode + ((getReplicasToRemove() == null) ? 0 : getReplicasToRemove().hashCode());
hashCode = prime * hashCode + ((getApplyImmediately() == null) ? 0 : getApplyImmediately().hashCode());
return hashCode;
}
@Override
public DecreaseReplicaCountRequest clone() {
return (DecreaseReplicaCountRequest) super.clone();
}
}