com.amazonaws.services.ec2.model

Class DescribeHostsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeHostsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeHostsRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeHostsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeHostsRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeHostsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeHostsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Request<DescribeHostsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilter() The filters.
List<String>	getHostIds() The IDs of the Dedicated Hosts.
Integer	getMaxResults() The maximum number of results to return for the request in a single page.
String	getNextToken() The token to use to retrieve the next page of results.
int	hashCode()
void	setFilter(Collection<Filter> filter) The filters.
void	setHostIds(Collection<String> hostIds) The IDs of the Dedicated Hosts.
void	setMaxResults(Integer maxResults) The maximum number of results to return for the request in a single page.
void	setNextToken(String nextToken) The token to use to retrieve the next page of results.
String	toString() Returns a string representation of this object.
DescribeHostsRequest	withFilter(Collection<Filter> filter) The filters.
DescribeHostsRequest	withFilter(Filter... filter) The filters.
DescribeHostsRequest	withHostIds(Collection<String> hostIds) The IDs of the Dedicated Hosts.
DescribeHostsRequest	withHostIds(String... hostIds) The IDs of the Dedicated Hosts.
DescribeHostsRequest	withMaxResults(Integer maxResults) The maximum number of results to return for the request in a single page.
DescribeHostsRequest	withNextToken(String nextToken) The token to use to retrieve the next page of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeHostsRequest

public DescribeHostsRequest()

Method Detail

getFilter

public List<Filter> getFilter()

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.

Returns:

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.

setFilter

public void setFilter(Collection<Filter> 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.

Parameters:

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.

withFilter

public DescribeHostsRequest withFilter(Filter... 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 setFilter(java.util.Collection) or withFilter(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

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

withFilter

public DescribeHostsRequest withFilter(Collection<Filter> 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.

Parameters:

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.

Returns:

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

getHostIds

public List<String> getHostIds()

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Returns:

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

setHostIds

public void setHostIds(Collection<String> hostIds)

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Parameters:

hostIds - The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

withHostIds

public DescribeHostsRequest withHostIds(String... 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 setHostIds(java.util.Collection) or withHostIds(java.util.Collection) if you want to override the existing values.

Parameters:

hostIds - The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Returns:

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

withHostIds

public DescribeHostsRequest withHostIds(Collection<String> hostIds)

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Parameters:

hostIds - The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Returns:

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

setMaxResults

public void setMaxResults(Integer 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.

Parameters:

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.

getMaxResults

public Integer getMaxResults()

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.

Returns:

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.

withMaxResults

public DescribeHostsRequest withMaxResults(Integer 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.

Parameters:

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.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The token to use to retrieve the next page of results.

Parameters:

nextToken - The token to use to retrieve the next page of results.

getNextToken

public String getNextToken()

The token to use to retrieve the next page of results.

Returns:

The token to use to retrieve the next page of results.

withNextToken

public DescribeHostsRequest withNextToken(String nextToken)

The token to use to retrieve the next page of results.

Parameters:

nextToken - The token to use to retrieve the next page of results.

Returns:

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

getDryRunRequest

public Request<DescribeHostsRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeHostsRequest>

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeHostsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()