com.amazonaws.services.elasticloadbalancing.model

Class DeregisterInstancesFromLoadBalancerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DeregisterInstancesFromLoadBalancerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DeregisterInstancesFromLoadBalancer operation.

Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.

You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.

For more information, see Deregister and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide .

See Also:

AmazonElasticLoadBalancing.deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeregisterInstancesFromLoadBalancerRequest() Default constructor for a new DeregisterInstancesFromLoadBalancerRequest object.
DeregisterInstancesFromLoadBalancerRequest(String loadBalancerName, List<Instance> instances) Constructs a new DeregisterInstancesFromLoadBalancerRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
DeregisterInstancesFromLoadBalancerRequest	clone()
boolean	equals(Object obj)
List<Instance>	getInstances() The IDs of the instances.
String	getLoadBalancerName() The name of the load balancer.
int	hashCode()
void	setInstances(Collection<Instance> instances) The IDs of the instances.
void	setLoadBalancerName(String loadBalancerName) The name of the load balancer.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeregisterInstancesFromLoadBalancerRequest	withInstances(Collection<Instance> instances) The IDs of the instances.
DeregisterInstancesFromLoadBalancerRequest	withInstances(Instance... instances) The IDs of the instances.
DeregisterInstancesFromLoadBalancerRequest	withLoadBalancerName(String loadBalancerName) The name of the load balancer.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeregisterInstancesFromLoadBalancerRequest

public DeregisterInstancesFromLoadBalancerRequest()

Default constructor for a new DeregisterInstancesFromLoadBalancerRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

DeregisterInstancesFromLoadBalancerRequest

public DeregisterInstancesFromLoadBalancerRequest(String loadBalancerName,
                                          List<Instance> instances)

Constructs a new DeregisterInstancesFromLoadBalancerRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

loadBalancerName - The name of the load balancer.

instances - The IDs of the instances.

Method Detail

getLoadBalancerName

public String getLoadBalancerName()

The name of the load balancer.

Returns:

The name of the load balancer.

setLoadBalancerName

public void setLoadBalancerName(String loadBalancerName)

The name of the load balancer.

Parameters:

loadBalancerName - The name of the load balancer.

withLoadBalancerName

public DeregisterInstancesFromLoadBalancerRequest withLoadBalancerName(String loadBalancerName)

The name of the load balancer.

Returns a reference to this object so that method calls can be chained together.

Parameters:

loadBalancerName - The name of the load balancer.

Returns:

A reference to this updated object so that method calls can be chained together.

getInstances

public List<Instance> getInstances()

The IDs of the instances.

Returns:

The IDs of the instances.

setInstances

public void setInstances(Collection<Instance> instances)

The IDs of the instances.

Parameters:

instances - The IDs of the instances.

withInstances

public DeregisterInstancesFromLoadBalancerRequest withInstances(Instance... instances)

The IDs of the instances.

NOTE: This method appends the values to the existing list (if any). Use setInstances(java.util.Collection) or withInstances(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

instances - The IDs of the instances.

Returns:

A reference to this updated object so that method calls can be chained together.

withInstances

public DeregisterInstancesFromLoadBalancerRequest withInstances(Collection<Instance> instances)

The IDs of the instances.

Returns a reference to this object so that method calls can be chained together.

Parameters:

instances - The IDs of the instances.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DeregisterInstancesFromLoadBalancerRequest clone()

Overrides:

clone in class AmazonWebServiceRequest