com.amazonaws.services.ec2.model.DescribeHostsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeHostsRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeHostsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The filters.
*
*
* -
*
* auto-placement - Whether auto-placement is enabled or disabled (on | off).
*
*
* -
*
* availability-zone - The Availability Zone of the host.
*
*
* -
*
* client-token - The idempotency token that you provided when you allocated the host.
*
*
* -
*
* host-reservation-id - The ID of the reservation assigned to this host.
*
*
* -
*
* instance-type - The instance type size that the Dedicated Host is configured to support.
*
*
* -
*
* state - The allocation state of the Dedicated Host (available |
* under-assessment | permanent-failure | released |
* released-permanent-failure).
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filter;
/**
*
* The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
*
*/
private com.amazonaws.internal.SdkInternalList hostIds;
/**
*
* 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 receive an error.
*
*
* You cannot specify this parameter and the host IDs parameter in the same request.
*
*/
private Integer maxResults;
/**
*
* The token to use to retrieve the next page of results.
*
*/
private String nextToken;
/**
*
* The filters.
*
*
* -
*
* auto-placement - Whether auto-placement is enabled or disabled (on | off).
*
*
* -
*
* availability-zone - The Availability Zone of the host.
*
*
* -
*
* client-token - The idempotency token that you provided when you allocated the host.
*
*
* -
*
* host-reservation-id - The ID of the reservation assigned to this host.
*
*
* -
*
* instance-type - The instance type size that the Dedicated Host is configured to support.
*
*
* -
*
* state - The allocation state of the Dedicated Host (available |
* under-assessment | permanent-failure | released |
* released-permanent-failure).
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
*
*
* @return The filters.
*
* -
*
* auto-placement - Whether auto-placement is enabled or disabled (on |
* off).
*
*
* -
*
* availability-zone - The Availability Zone of the host.
*
*
* -
*
* client-token - The idempotency token that you provided when you allocated the host.
*
*
* -
*
* host-reservation-id - The ID of the reservation assigned to this host.
*
*
* -
*
* instance-type - The instance type size that the Dedicated Host is configured to support.
*
*
* -
*
* state - The allocation state of the Dedicated Host (available |
* under-assessment | permanent-failure | released |
* released-permanent-failure).
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
*/
public java.util.List getFilter() {
if (filter == null) {
filter = new com.amazonaws.internal.SdkInternalList();
}
return filter;
}
/**
*
* The filters.
*
*
* -
*
* auto-placement - Whether auto-placement is enabled or disabled (on | off).
*
*
* -
*
* availability-zone - The Availability Zone of the host.
*
*
* -
*
* client-token - The idempotency token that you provided when you allocated the host.
*
*
* -
*
* host-reservation-id - The ID of the reservation assigned to this host.
*
*
* -
*
* instance-type - The instance type size that the Dedicated Host is configured to support.
*
*
* -
*
* state - The allocation state of the Dedicated Host (available |
* under-assessment | permanent-failure | released |
* released-permanent-failure).
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
*
*
* @param filter
* The filters.
*
* -
*
* auto-placement - Whether auto-placement is enabled or disabled (on |
* off).
*
*
* -
*
* availability-zone - The Availability Zone of the host.
*
*
* -
*
* client-token - The idempotency token that you provided when you allocated the host.
*
*
* -
*
* host-reservation-id - The ID of the reservation assigned to this host.
*
*
* -
*
* instance-type - The instance type size that the Dedicated Host is configured to support.
*
*
* -
*
* state - The allocation state of the Dedicated Host (available |
* under-assessment | permanent-failure | released |
* released-permanent-failure).
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
*/
public void setFilter(java.util.Collection filter) {
if (filter == null) {
this.filter = null;
return;
}
this.filter = new com.amazonaws.internal.SdkInternalList(filter);
}
/**
*
* The filters.
*
*
* -
*
* auto-placement - Whether auto-placement is enabled or disabled (on | off).
*
*
* -
*
* availability-zone - The Availability Zone of the host.
*
*
* -
*
* client-token - The idempotency token that you provided when you allocated the host.
*
*
* -
*
* host-reservation-id - The ID of the reservation assigned to this host.
*
*
* -
*
* instance-type - The instance type size that the Dedicated Host is configured to support.
*
*
* -
*
* state - The allocation state of the Dedicated Host (available |
* under-assessment | permanent-failure | released |
* released-permanent-failure).
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
*
*
* 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.
*
*
* @param filter
* The filters.
*
* -
*
* auto-placement - Whether auto-placement is enabled or disabled (on |
* off).
*
*
* -
*
* availability-zone - The Availability Zone of the host.
*
*
* -
*
* client-token - The idempotency token that you provided when you allocated the host.
*
*
* -
*
* host-reservation-id - The ID of the reservation assigned to this host.
*
*
* -
*
* instance-type - The instance type size that the Dedicated Host is configured to support.
*
*
* -
*
* state - The allocation state of the Dedicated Host (available |
* under-assessment | permanent-failure | released |
* released-permanent-failure).
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeHostsRequest withFilter(Filter... filter) {
if (this.filter == null) {
setFilter(new com.amazonaws.internal.SdkInternalList(filter.length));
}
for (Filter ele : filter) {
this.filter.add(ele);
}
return this;
}
/**
*
* The filters.
*
*
* -
*
* auto-placement - Whether auto-placement is enabled or disabled (on | off).
*
*
* -
*
* availability-zone - The Availability Zone of the host.
*
*
* -
*
* client-token - The idempotency token that you provided when you allocated the host.
*
*
* -
*
* host-reservation-id - The ID of the reservation assigned to this host.
*
*
* -
*
* instance-type - The instance type size that the Dedicated Host is configured to support.
*
*
* -
*
* state - The allocation state of the Dedicated Host (available |
* under-assessment | permanent-failure | released |
* released-permanent-failure).
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
*
*
* @param filter
* The filters.
*
* -
*
* auto-placement - Whether auto-placement is enabled or disabled (on |
* off).
*
*
* -
*
* availability-zone - The Availability Zone of the host.
*
*
* -
*
* client-token - The idempotency token that you provided when you allocated the host.
*
*
* -
*
* host-reservation-id - The ID of the reservation assigned to this host.
*
*
* -
*
* instance-type - The instance type size that the Dedicated Host is configured to support.
*
*
* -
*
* state - The allocation state of the Dedicated Host (available |
* under-assessment | permanent-failure | released |
* released-permanent-failure).
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeHostsRequest withFilter(java.util.Collection filter) {
setFilter(filter);
return this;
}
/**
*
* 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.SdkInternalList();
}
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;
}
this.hostIds = new com.amazonaws.internal.SdkInternalList(hostIds);
}
/**
*
* 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.
*
*
* @param hostIds
* The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeHostsRequest withHostIds(String... hostIds) {
if (this.hostIds == null) {
setHostIds(new com.amazonaws.internal.SdkInternalList(hostIds.length));
}
for (String ele : hostIds) {
this.hostIds.add(ele);
}
return this;
}
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeHostsRequest withHostIds(java.util.Collection hostIds) {
setHostIds(hostIds);
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 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 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 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 receive an error.
*
* You cannot specify this parameter and the host IDs parameter in the same request.
*/
public Integer getMaxResults() {
return this.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 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 receive an error.
*
* You cannot specify this parameter and the host IDs parameter in the same request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeHostsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The token to use to retrieve the next page of results.
*
*
* @param nextToken
* The token to use to retrieve the next page of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token to use to retrieve the next page of results.
*
*
* @return The token to use to retrieve the next page of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token to use to retrieve the next page of results.
*
*
* @param nextToken
* The token to use to retrieve the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeHostsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new DescribeHostsRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFilter() != null)
sb.append("Filter: ").append(getFilter()).append(",");
if (getHostIds() != null)
sb.append("HostIds: ").append(getHostIds()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@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.getFilter() == null ^ this.getFilter() == null)
return false;
if (other.getFilter() != null && other.getFilter().equals(this.getFilter()) == false)
return false;
if (other.getHostIds() == null ^ this.getHostIds() == null)
return false;
if (other.getHostIds() != null && other.getHostIds().equals(this.getHostIds()) == 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.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFilter() == null) ? 0 : getFilter().hashCode());
hashCode = prime * hashCode + ((getHostIds() == null) ? 0 : getHostIds().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribeHostsRequest clone() {
return (DescribeHostsRequest) super.clone();
}
}