com.amazonaws.services.elasticloadbalancing.model
Class DeregisterInstancesFromLoadBalancerRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerRequest

public class DeregisterInstancesFromLoadBalancerRequest
extends AmazonWebServiceRequest

Container for the parameters to the DeregisterInstancesFromLoadBalancer operation.

Deregisters instances from the LoadBalancer. Once the instance is deregistered, it will stop receiving traffic from the LoadBalancer.

In order to successfully call this API, the same account credentials as those used to create the LoadBalancer must be provided.

See Also:
AmazonElasticLoadBalancing.deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest)

Constructor Summary
DeregisterInstancesFromLoadBalancerRequest()
          Default constructor for a new DeregisterInstancesFromLoadBalancerRequest object.
DeregisterInstancesFromLoadBalancerRequest(String loadBalancerName, List<Instance> instances)
          Constructs a new DeregisterInstancesFromLoadBalancerRequest object.
 
Method Summary
 boolean equals(Object obj)
           
 List<Instance> getInstances()
          A list of EC2 instance IDs consisting of all instances to be deregistered.
 String getLoadBalancerName()
          The name associated with the LoadBalancer.
 int hashCode()
           
 void setInstances(Collection<Instance> instances)
          A list of EC2 instance IDs consisting of all instances to be deregistered.
 void setLoadBalancerName(String loadBalancerName)
          The name associated with the LoadBalancer.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 DeregisterInstancesFromLoadBalancerRequest withInstances(Collection<Instance> instances)
          A list of EC2 instance IDs consisting of all instances to be deregistered.
 DeregisterInstancesFromLoadBalancerRequest withInstances(Instance... instances)
          A list of EC2 instance IDs consisting of all instances to be deregistered.
 DeregisterInstancesFromLoadBalancerRequest withLoadBalancerName(String loadBalancerName)
          The name associated with the LoadBalancer.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, setRequestCredentials
 
Methods inherited from class java.lang.Object
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 associated with the LoadBalancer. The name must be unique within the client AWS account.
instances - A list of EC2 instance IDs consisting of all instances to be deregistered.
Method Detail

getLoadBalancerName

public String getLoadBalancerName()
The name associated with the LoadBalancer. The name must be unique within the client AWS account.

Returns:
The name associated with the LoadBalancer. The name must be unique within the client AWS account.

setLoadBalancerName

public void setLoadBalancerName(String loadBalancerName)
The name associated with the LoadBalancer. The name must be unique within the client AWS account.

Parameters:
loadBalancerName - The name associated with the LoadBalancer. The name must be unique within the client AWS account.

withLoadBalancerName

public DeregisterInstancesFromLoadBalancerRequest withLoadBalancerName(String 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.

Parameters:
loadBalancerName - The name associated with the LoadBalancer. The name must be unique within the client AWS account.
Returns:
A reference to this updated object so that method calls can be chained together.

getInstances

public List<Instance> getInstances()
A list of EC2 instance IDs consisting of all instances to be deregistered.

Returns:
A list of EC2 instance IDs consisting of all instances to be deregistered.

setInstances

public void setInstances(Collection<Instance> instances)
A list of EC2 instance IDs consisting of all instances to be deregistered.

Parameters:
instances - A list of EC2 instance IDs consisting of all instances to be deregistered.

withInstances

public DeregisterInstancesFromLoadBalancerRequest withInstances(Instance... instances)
A list of EC2 instance IDs consisting of all instances to be deregistered.

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

Parameters:
instances - A list of EC2 instance IDs consisting of all instances to be deregistered.
Returns:
A reference to this updated object so that method calls can be chained together.

withInstances

public DeregisterInstancesFromLoadBalancerRequest withInstances(Collection<Instance> instances)
A list of EC2 instance IDs consisting of all instances to be deregistered.

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

Parameters:
instances - A list of EC2 instance IDs consisting of all instances to be deregistered.
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


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.