com.amazonaws.services.autoscaling.model.DescribeAutoScalingInstancesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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.autoscaling.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.autoscaling.AmazonAutoScaling#describeAutoScalingInstances(DescribeAutoScalingInstancesRequest) DescribeAutoScalingInstances operation}.
*
* Returns a description of each Auto Scaling instance in the
* InstanceIds list. If a list is not provided, the service
* returns the full details of all instances up to a maximum of 50. By
* default, the service returns a list of 20 items.
*
*
* This action supports pagination by returning a token if there are
* more pages to retrieve. To get the next page, call this action again
* with the returned token as the NextToken parameter.
*
*
* @see com.amazonaws.services.autoscaling.AmazonAutoScaling#describeAutoScalingInstances(DescribeAutoScalingInstancesRequest)
*/
public class DescribeAutoScalingInstancesRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The list of Auto Scaling instances to describe. If this list is
* omitted, all auto scaling instances are described. The list of
* requested instances cannot contain more than 50 items. If unknown
* instances are requested, they are ignored with no error.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag instanceIds;
/**
* The maximum number of Auto Scaling instances to be described with each
* call.
*
* Constraints:
* Range: 1 - 50
*/
private Integer maxRecords;
/**
* The token returned by a previous call to indicate that there is more
* data available.
*
* Constraints:
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*/
private String nextToken;
/**
* The list of Auto Scaling instances to describe. If this list is
* omitted, all auto scaling instances are described. The list of
* requested instances cannot contain more than 50 items. If unknown
* instances are requested, they are ignored with no error.
*
* @return The list of Auto Scaling instances to describe. If this list is
* omitted, all auto scaling instances are described. The list of
* requested instances cannot contain more than 50 items. If unknown
* instances are requested, they are ignored with no error.
*/
public java.util.List getInstanceIds() {
if (instanceIds == null) {
instanceIds = new com.amazonaws.internal.ListWithAutoConstructFlag();
instanceIds.setAutoConstruct(true);
}
return instanceIds;
}
/**
* The list of Auto Scaling instances to describe. If this list is
* omitted, all auto scaling instances are described. The list of
* requested instances cannot contain more than 50 items. If unknown
* instances are requested, they are ignored with no error.
*
* @param instanceIds The list of Auto Scaling instances to describe. If this list is
* omitted, all auto scaling instances are described. The list of
* requested instances cannot contain more than 50 items. If unknown
* instances are requested, they are ignored with no error.
*/
public void setInstanceIds(java.util.Collection instanceIds) {
if (instanceIds == null) {
this.instanceIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag instanceIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(instanceIds.size());
instanceIdsCopy.addAll(instanceIds);
this.instanceIds = instanceIdsCopy;
}
/**
* The list of Auto Scaling instances to describe. If this list is
* omitted, all auto scaling instances are described. The list of
* requested instances cannot contain more than 50 items. If unknown
* instances are requested, they are ignored with no error.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param instanceIds The list of Auto Scaling instances to describe. If this list is
* omitted, all auto scaling instances are described. The list of
* requested instances cannot contain more than 50 items. If unknown
* instances are requested, they are ignored with no error.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAutoScalingInstancesRequest withInstanceIds(String... instanceIds) {
if (getInstanceIds() == null) setInstanceIds(new java.util.ArrayList(instanceIds.length));
for (String value : instanceIds) {
getInstanceIds().add(value);
}
return this;
}
/**
* The list of Auto Scaling instances to describe. If this list is
* omitted, all auto scaling instances are described. The list of
* requested instances cannot contain more than 50 items. If unknown
* instances are requested, they are ignored with no error.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param instanceIds The list of Auto Scaling instances to describe. If this list is
* omitted, all auto scaling instances are described. The list of
* requested instances cannot contain more than 50 items. If unknown
* instances are requested, they are ignored with no error.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAutoScalingInstancesRequest withInstanceIds(java.util.Collection instanceIds) {
if (instanceIds == null) {
this.instanceIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag instanceIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(instanceIds.size());
instanceIdsCopy.addAll(instanceIds);
this.instanceIds = instanceIdsCopy;
}
return this;
}
/**
* The maximum number of Auto Scaling instances to be described with each
* call.
*
* Constraints:
* Range: 1 - 50
*
* @return The maximum number of Auto Scaling instances to be described with each
* call.
*/
public Integer getMaxRecords() {
return maxRecords;
}
/**
* The maximum number of Auto Scaling instances to be described with each
* call.
*
* Constraints:
* Range: 1 - 50
*
* @param maxRecords The maximum number of Auto Scaling instances to be described with each
* call.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
* The maximum number of Auto Scaling instances to be described with each
* call.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 1 - 50
*
* @param maxRecords The maximum number of Auto Scaling instances to be described with each
* call.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAutoScalingInstancesRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
/**
* The token returned by a previous call to indicate that there is more
* data available.
*
* Constraints:
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @return The token returned by a previous call to indicate that there is more
* data available.
*/
public String getNextToken() {
return nextToken;
}
/**
* The token returned by a previous call to indicate that there is more
* data available.
*
* Constraints:
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param nextToken The token returned by a previous call to indicate that there is more
* data available.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
* The token returned by a previous call to indicate that there is more
* data available.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param nextToken The token returned by a previous call to indicate that there is more
* data available.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAutoScalingInstancesRequest withNextToken(String nextToken) {
this.nextToken = nextToken;
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("{");
if (getInstanceIds() != null) sb.append("InstanceIds: " + getInstanceIds() + ",");
if (getMaxRecords() != null) sb.append("MaxRecords: " + getMaxRecords() + ",");
if (getNextToken() != null) sb.append("NextToken: " + getNextToken() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInstanceIds() == null) ? 0 : getInstanceIds().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeAutoScalingInstancesRequest == false) return false;
DescribeAutoScalingInstancesRequest other = (DescribeAutoScalingInstancesRequest)obj;
if (other.getInstanceIds() == null ^ this.getInstanceIds() == null) return false;
if (other.getInstanceIds() != null && other.getInstanceIds().equals(this.getInstanceIds()) == false) return false;
if (other.getMaxRecords() == null ^ this.getMaxRecords() == null) return false;
if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == false) return false;
if (other.getNextToken() == null ^ this.getNextToken() == null) return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false;
return true;
}
}