com.amazonaws.services.elasticloadbalancing.model.DisableAvailabilityZonesForLoadBalancerRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2011 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.elasticloadbalancing.model;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancing#disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest) DisableAvailabilityZonesForLoadBalancer operation}.
*
* Removes the specified EC2 Availability Zones from the set of
* configured Availability Zones for the LoadBalancer.
*
*
* There must be at least one Availability Zone registered with a
* LoadBalancer at all times. A client cannot remove all the Availability
* Zones from a LoadBalancer. Once an Availability Zone is removed, all
* the instances registered with the LoadBalancer that are in the removed
* Availability Zone go into the OutOfService state. Upon Availability
* Zone removal, the LoadBalancer attempts to equally balance the traffic
* among its remaining usable Availability Zones. Trying to remove an
* Availability Zone that was not associated with the LoadBalancer does
* nothing.
*
*
* NOTE: In order for this call to be successful, the client must
* have created the LoadBalancer. The client must provide the same
* account credentials as those that were used to create the
* LoadBalancer.
*
*
* @see com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancing#disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest)
*/
public class DisableAvailabilityZonesForLoadBalancerRequest extends AmazonWebServiceRequest {
/**
* The name associated with the LoadBalancer. The name must be unique
* within the client AWS account.
*/
private String loadBalancerName;
/**
* A list of Availability Zones to be removed from the LoadBalancer.
* There must be at least one Availability Zone registered with a
* LoadBalancer at all times. The client cannot remove all the
* Availability Zones from a LoadBalancer. Specified Availability Zones
* must be in the same Region.
*/
private java.util.List availabilityZones;
/**
* Default constructor for a new DisableAvailabilityZonesForLoadBalancerRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public DisableAvailabilityZonesForLoadBalancerRequest() {}
/**
* Constructs a new DisableAvailabilityZonesForLoadBalancerRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param loadBalancerName The name associated with the LoadBalancer. The
* name must be unique within the client AWS account.
* @param availabilityZones A list of Availability Zones to be removed
* from the LoadBalancer. There must be at least one Availability
* Zone registered with a LoadBalancer at all times. The client cannot
* remove all the Availability Zones from a LoadBalancer. Specified
* Availability Zones must be in the same Region.
*/
public DisableAvailabilityZonesForLoadBalancerRequest(String loadBalancerName, java.util.List availabilityZones) {
this.loadBalancerName = loadBalancerName;
this.availabilityZones = availabilityZones;
}
/**
* The name associated with the LoadBalancer. The name must be unique
* within the client AWS account.
*
* @return The name associated with the LoadBalancer. The name must be unique
* within the client AWS account.
*/
public String getLoadBalancerName() {
return loadBalancerName;
}
/**
* The name associated with the LoadBalancer. The name must be unique
* within the client AWS account.
*
* @param loadBalancerName The name associated with the LoadBalancer. The name must be unique
* within the client AWS account.
*/
public void setLoadBalancerName(String loadBalancerName) {
this.loadBalancerName = loadBalancerName;
}
/**
* The name associated with the LoadBalancer. The name must be unique
* within the client AWS account.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param loadBalancerName The name associated with the LoadBalancer. The name must be unique
* within the client AWS account.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DisableAvailabilityZonesForLoadBalancerRequest withLoadBalancerName(String loadBalancerName) {
this.loadBalancerName = loadBalancerName;
return this;
}
/**
* A list of Availability Zones to be removed from the LoadBalancer.
* There must be at least one Availability Zone registered with a
* LoadBalancer at all times. The client cannot remove all the
* Availability Zones from a LoadBalancer. Specified Availability Zones
* must be in the same Region.
*
* @return A list of Availability Zones to be removed from the LoadBalancer.
* There must be at least one Availability Zone registered with a
* LoadBalancer at all times. The client cannot remove all the
* Availability Zones from a LoadBalancer. Specified Availability Zones
* must be in the same Region.
*/
public java.util.List getAvailabilityZones() {
if (availabilityZones == null) {
availabilityZones = new java.util.ArrayList();
}
return availabilityZones;
}
/**
* A list of Availability Zones to be removed from the LoadBalancer.
* There must be at least one Availability Zone registered with a
* LoadBalancer at all times. The client cannot remove all the
* Availability Zones from a LoadBalancer. Specified Availability Zones
* must be in the same Region.
*
* @param availabilityZones A list of Availability Zones to be removed from the LoadBalancer.
* There must be at least one Availability Zone registered with a
* LoadBalancer at all times. The client cannot remove all the
* Availability Zones from a LoadBalancer. Specified Availability Zones
* must be in the same Region.
*/
public void setAvailabilityZones(java.util.Collection availabilityZones) {
java.util.List availabilityZonesCopy = new java.util.ArrayList();
if (availabilityZones != null) {
availabilityZonesCopy.addAll(availabilityZones);
}
this.availabilityZones = availabilityZonesCopy;
}
/**
* A list of Availability Zones to be removed from the LoadBalancer.
* There must be at least one Availability Zone registered with a
* LoadBalancer at all times. The client cannot remove all the
* Availability Zones from a LoadBalancer. Specified Availability Zones
* must be in the same Region.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param availabilityZones A list of Availability Zones to be removed from the LoadBalancer.
* There must be at least one Availability Zone registered with a
* LoadBalancer at all times. The client cannot remove all the
* Availability Zones from a LoadBalancer. Specified Availability Zones
* must be in the same Region.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DisableAvailabilityZonesForLoadBalancerRequest withAvailabilityZones(String... availabilityZones) {
for (String value : availabilityZones) {
getAvailabilityZones().add(value);
}
return this;
}
/**
* A list of Availability Zones to be removed from the LoadBalancer.
* There must be at least one Availability Zone registered with a
* LoadBalancer at all times. The client cannot remove all the
* Availability Zones from a LoadBalancer. Specified Availability Zones
* must be in the same Region.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param availabilityZones A list of Availability Zones to be removed from the LoadBalancer.
* There must be at least one Availability Zone registered with a
* LoadBalancer at all times. The client cannot remove all the
* Availability Zones from a LoadBalancer. Specified Availability Zones
* must be in the same Region.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DisableAvailabilityZonesForLoadBalancerRequest withAvailabilityZones(java.util.Collection availabilityZones) {
java.util.List availabilityZonesCopy = new java.util.ArrayList();
if (availabilityZones != null) {
availabilityZonesCopy.addAll(availabilityZones);
}
this.availabilityZones = availabilityZonesCopy;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
sb.append("LoadBalancerName: " + loadBalancerName + ", ");
sb.append("AvailabilityZones: " + availabilityZones + ", ");
sb.append("}");
return sb.toString();
}
}