com.amazonaws.services.elasticloadbalancing.model.DescribeInstanceHealthRequest 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#describeInstanceHealth(DescribeInstanceHealthRequest) DescribeInstanceHealth operation}.
*
* Returns the current state of the instances of the specified
* LoadBalancer. If no instances are specified, the state of all the
* instances for the LoadBalancer is returned.
*
*
* NOTE: The client must have created the specified input
* LoadBalancer in order to retrieve this information; the client must
* provide the same account credentials as those that were used to create
* the LoadBalancer.
*
*
* @see com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancing#describeInstanceHealth(DescribeInstanceHealthRequest)
*/
public class DescribeInstanceHealthRequest extends AmazonWebServiceRequest {
/**
* The name associated with the LoadBalancer. The name must be unique
* within the client AWS account.
*/
private String loadBalancerName;
/**
* A list of instance IDs whose states are being queried.
*/
private java.util.List instances;
/**
* Default constructor for a new DescribeInstanceHealthRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public DescribeInstanceHealthRequest() {}
/**
* Constructs a new DescribeInstanceHealthRequest 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.
*/
public DescribeInstanceHealthRequest(String loadBalancerName) {
this.loadBalancerName = loadBalancerName;
}
/**
* 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 DescribeInstanceHealthRequest withLoadBalancerName(String loadBalancerName) {
this.loadBalancerName = loadBalancerName;
return this;
}
/**
* A list of instance IDs whose states are being queried.
*
* @return A list of instance IDs whose states are being queried.
*/
public java.util.List getInstances() {
if (instances == null) {
instances = new java.util.ArrayList();
}
return instances;
}
/**
* A list of instance IDs whose states are being queried.
*
* @param instances A list of instance IDs whose states are being queried.
*/
public void setInstances(java.util.Collection instances) {
java.util.List instancesCopy = new java.util.ArrayList();
if (instances != null) {
instancesCopy.addAll(instances);
}
this.instances = instancesCopy;
}
/**
* A list of instance IDs whose states are being queried.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param instances A list of instance IDs whose states are being queried.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeInstanceHealthRequest withInstances(Instance... instances) {
for (Instance value : instances) {
getInstances().add(value);
}
return this;
}
/**
* A list of instance IDs whose states are being queried.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param instances A list of instance IDs whose states are being queried.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeInstanceHealthRequest withInstances(java.util.Collection instances) {
java.util.List instancesCopy = new java.util.ArrayList();
if (instances != null) {
instancesCopy.addAll(instances);
}
this.instances = instancesCopy;
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("Instances: " + instances + ", ");
sb.append("}");
return sb.toString();
}
}