com.amazonaws.services.ec2.model

Class DescribeHostsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeHostsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeHostsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the 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 state released .

See Also:

AmazonEC2.describeHosts(DescribeHostsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeHostsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeHostsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<Filter>	getFilter() One or more 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 retrieve the next page of results.
int	hashCode()
void	setFilter(Collection<Filter> filter) One or more 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 retrieve the next page of results.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeHostsRequest	withFilter(Collection<Filter> filter) One or more filters.
DescribeHostsRequest	withFilter(Filter... filter) One or more 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 retrieve the next page of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeHostsRequest

public DescribeHostsRequest()

Method Detail

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.

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

Parameters:

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

Returns:

A reference to this updated 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.

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

The token to retrieve the next page of results.

Returns:

The token to retrieve the next page of results.

setNextToken

public void setNextToken(String nextToken)

The token to retrieve the next page of results.

Parameters:

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

withNextToken

public DescribeHostsRequest withNextToken(String nextToken)

The token to retrieve the next page of results.

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

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 will 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 will receive an error. You cannot specify this parameter and the host IDs parameter in the same request.

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 will 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 will 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 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.

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 will receive an error. You cannot specify this parameter and the host IDs parameter in the same request.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilter

public List<Filter> getFilter()

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:

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.

setFilter

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

Parameters:

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.

withFilter

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

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.

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

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilter

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

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

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeHostsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()