com.amazonaws.services.ec2.model.DescribeHostsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2010-2015 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.ec2.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeHosts(DescribeHostsRequest) DescribeHosts operation}.
*
* Describes one or more of your Dedicated hosts.
*
*
* The results describe only the Dedicated hosts in the region you're
* currently using. All listed instances consume capacity on your
* Dedicated host. Dedicated hosts that have recently been released will
* be listed with the status "released".
*
*
* @see com.amazonaws.services.ec2.AmazonEC2#describeHosts(DescribeHostsRequest)
*/
public class DescribeHostsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable {
/**
* The IDs of the Dedicated hosts. The IDs are used for targeted instance
* launches.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag hostIds;
/**
* The token to retrieve the next page of results.
*/
private String nextToken;
/**
* The maximum number of results to return for the request in a single
* page. The remaining results can be seen by sending another request
* with the returned nextToken value. This value can be
* between 5 and 500; if maxResults is given a larger value
* than 500, you will receive an error. You cannot specify this parameter
* and the host IDs parameter in the same request.
*/
private Integer maxResults;
/**
* One or more filters. instance-type - The
* instance type size that the Dedicated host is configured to
* support.
auto-placement - Whether
* auto-placement is enabled or disabled (on |
* off).
host-reservation-id - The
* ID of the reservation associated with this host.
client-token - The idempotency token you provided
* when you launched the instance
state- The
* allocation state of the Dedicated host (available |
* under-assessment | permanent-failure |
* released | released-permanent-failure).
availability-zone - The Availability Zone of the
* host.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag filter;
/**
* The IDs of the Dedicated hosts. The IDs are used for targeted instance
* launches.
*
* @return The IDs of the Dedicated hosts. The IDs are used for targeted instance
* launches.
*/
public java.util.List getHostIds() {
if (hostIds == null) {
hostIds = new com.amazonaws.internal.ListWithAutoConstructFlag();
hostIds.setAutoConstruct(true);
}
return hostIds;
}
/**
* The IDs of the Dedicated hosts. The IDs are used for targeted instance
* launches.
*
* @param hostIds The IDs of the Dedicated hosts. The IDs are used for targeted instance
* launches.
*/
public void setHostIds(java.util.Collection hostIds) {
if (hostIds == null) {
this.hostIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag hostIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(hostIds.size());
hostIdsCopy.addAll(hostIds);
this.hostIds = hostIdsCopy;
}
/**
* The IDs of the Dedicated hosts. The IDs are used for targeted instance
* launches.
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setHostIds(java.util.Collection)} or {@link
* #withHostIds(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.
*
* @param hostIds The IDs of the Dedicated hosts. The IDs are used for targeted instance
* launches.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeHostsRequest withHostIds(String... hostIds) {
if (getHostIds() == null) setHostIds(new java.util.ArrayList(hostIds.length));
for (String value : hostIds) {
getHostIds().add(value);
}
return this;
}
/**
* The IDs of the Dedicated hosts. The IDs are used for targeted instance
* launches.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param hostIds The IDs of the Dedicated hosts. The IDs are used for targeted instance
* launches.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeHostsRequest withHostIds(java.util.Collection hostIds) {
if (hostIds == null) {
this.hostIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag hostIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(hostIds.size());
hostIdsCopy.addAll(hostIds);
this.hostIds = hostIdsCopy;
}
return this;
}
/**
* The token to retrieve the next page of results.
*
* @return The token to retrieve the next page of results.
*/
public String getNextToken() {
return nextToken;
}
/**
* The token to retrieve the next page of results.
*
* @param nextToken The token to retrieve the next page of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
* The token to retrieve the next page of results.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param nextToken The token to retrieve the next page of results.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeHostsRequest withNextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
/**
* The maximum number of results to return for the request in a single
* page. The remaining results can be seen by sending another request
* with the returned nextToken value. This value can be
* between 5 and 500; if maxResults is given a larger value
* than 500, you will receive an error. You cannot specify this parameter
* and the host IDs parameter in the same request.
*
* @return The maximum number of results to return for the request in a single
* page. The remaining results can be seen by sending another request
* with the returned nextToken value. This value can be
* between 5 and 500; if maxResults is given a larger value
* than 500, you will receive an error. You cannot specify this parameter
* and the host IDs parameter in the same request.
*/
public Integer getMaxResults() {
return maxResults;
}
/**
* The maximum number of results to return for the request in a single
* page. The remaining results can be seen by sending another request
* with the returned nextToken value. This value can be
* between 5 and 500; if maxResults is given a larger value
* than 500, you will receive an error. You cannot specify this parameter
* and the host IDs parameter in the same request.
*
* @param maxResults The maximum number of results to return for the request in a single
* page. The remaining results can be seen by sending another request
* with the returned nextToken value. This value can be
* between 5 and 500; if maxResults is given a larger value
* than 500, you will receive an error. You cannot specify this parameter
* and the host IDs parameter in the same request.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
* The maximum number of results to return for the request in a single
* page. The remaining results can be seen by sending another request
* with the returned nextToken value. This value can be
* between 5 and 500; if maxResults is given a larger value
* than 500, you will receive an error. You cannot specify this parameter
* and the host IDs parameter in the same request.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param maxResults The maximum number of results to return for the request in a single
* page. The remaining results can be seen by sending another request
* with the returned nextToken value. This value can be
* between 5 and 500; if maxResults is given a larger value
* than 500, you will receive an error. You cannot specify this parameter
* and the host IDs parameter in the same request.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeHostsRequest withMaxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
/**
* One or more filters.
instance-type - The
* instance type size that the Dedicated host is configured to
* support.
auto-placement - Whether
* auto-placement is enabled or disabled (on |
* off).
host-reservation-id - The
* ID of the reservation associated with this host.
client-token - The idempotency token you provided
* when you launched the instance
state- The
* allocation state of the Dedicated host (available |
* under-assessment | permanent-failure |
* released | released-permanent-failure).
availability-zone - The Availability Zone of the
* host.
*
* @return One or more filters. instance-type - The
* instance type size that the Dedicated host is configured to
* support.
auto-placement - Whether
* auto-placement is enabled or disabled (on |
* off).
host-reservation-id - The
* ID of the reservation associated with this host.
client-token - The idempotency token you provided
* when you launched the instance
state- The
* allocation state of the Dedicated host (available |
* under-assessment | permanent-failure |
* released | released-permanent-failure).
availability-zone - The Availability Zone of the
* host.
*/
public java.util.List getFilter() {
if (filter == null) {
filter = new com.amazonaws.internal.ListWithAutoConstructFlag();
filter.setAutoConstruct(true);
}
return filter;
}
/**
* One or more filters. instance-type - The
* instance type size that the Dedicated host is configured to
* support.
auto-placement - Whether
* auto-placement is enabled or disabled (on |
* off).
host-reservation-id - The
* ID of the reservation associated with this host.
client-token - The idempotency token you provided
* when you launched the instance
state- The
* allocation state of the Dedicated host (available |
* under-assessment | permanent-failure |
* released | released-permanent-failure).
availability-zone - The Availability Zone of the
* host.
*
* @param filter One or more filters. instance-type - The
* instance type size that the Dedicated host is configured to
* support.
auto-placement - Whether
* auto-placement is enabled or disabled (on |
* off).
host-reservation-id - The
* ID of the reservation associated with this host.
client-token - The idempotency token you provided
* when you launched the instance
state- The
* allocation state of the Dedicated host (available |
* under-assessment | permanent-failure |
* released | released-permanent-failure).
availability-zone - The Availability Zone of the
* host.
*/
public void setFilter(java.util.Collection filter) {
if (filter == null) {
this.filter = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag filterCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filter.size());
filterCopy.addAll(filter);
this.filter = filterCopy;
}
/**
* One or more filters. instance-type - The
* instance type size that the Dedicated host is configured to
* support.
auto-placement - Whether
* auto-placement is enabled or disabled (on |
* off).
host-reservation-id - The
* ID of the reservation associated with this host.
client-token - The idempotency token you provided
* when you launched the instance
state- The
* allocation state of the Dedicated host (available |
* under-assessment | permanent-failure |
* released | released-permanent-failure).
availability-zone - The Availability Zone of the
* host.
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setFilter(java.util.Collection)} or {@link
* #withFilter(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.
*
* @param filter One or more filters.
instance-type - The
* instance type size that the Dedicated host is configured to
* support.
auto-placement - Whether
* auto-placement is enabled or disabled (on |
* off).
host-reservation-id - The
* ID of the reservation associated with this host.
client-token - The idempotency token you provided
* when you launched the instance
state- The
* allocation state of the Dedicated host (available |
* under-assessment | permanent-failure |
* released | released-permanent-failure).
availability-zone - The Availability Zone of the
* host.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeHostsRequest withFilter(Filter... filter) {
if (getFilter() == null) setFilter(new java.util.ArrayList(filter.length));
for (Filter value : filter) {
getFilter().add(value);
}
return this;
}
/**
* One or more filters. instance-type - The
* instance type size that the Dedicated host is configured to
* support.
auto-placement - Whether
* auto-placement is enabled or disabled (on |
* off).
host-reservation-id - The
* ID of the reservation associated with this host.
client-token - The idempotency token you provided
* when you launched the instance
state- The
* allocation state of the Dedicated host (available |
* under-assessment | permanent-failure |
* released | released-permanent-failure).
availability-zone - The Availability Zone of the
* host.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filter One or more filters.
instance-type - The
* instance type size that the Dedicated host is configured to
* support.
auto-placement - Whether
* auto-placement is enabled or disabled (on |
* off).
host-reservation-id - The
* ID of the reservation associated with this host.
client-token - The idempotency token you provided
* when you launched the instance
state- The
* allocation state of the Dedicated host (available |
* under-assessment | permanent-failure |
* released | released-permanent-failure).
availability-zone - The Availability Zone of the
* host.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeHostsRequest withFilter(java.util.Collection filter) {
if (filter == null) {
this.filter = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag filterCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filter.size());
filterCopy.addAll(filter);
this.filter = filterCopy;
}
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 (getHostIds() != null) sb.append("HostIds: " + getHostIds() + ",");
if (getNextToken() != null) sb.append("NextToken: " + getNextToken() + ",");
if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults() + ",");
if (getFilter() != null) sb.append("Filter: " + getFilter() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getHostIds() == null) ? 0 : getHostIds().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getFilter() == null) ? 0 : getFilter().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeHostsRequest == false) return false;
DescribeHostsRequest other = (DescribeHostsRequest)obj;
if (other.getHostIds() == null ^ this.getHostIds() == null) return false;
if (other.getHostIds() != null && other.getHostIds().equals(this.getHostIds()) == false) return false;
if (other.getNextToken() == null ^ this.getNextToken() == null) return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false;
if (other.getFilter() == null ^ this.getFilter() == null) return false;
if (other.getFilter() != null && other.getFilter().equals(this.getFilter()) == false) return false;
return true;
}
@Override
public DescribeHostsRequest clone() {
return (DescribeHostsRequest) super.clone();
}
}