DescribeHostsRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.DescribeHostsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class DescribeHostsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
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

Constructor Summary

Constructors
Constructor and Description

DescribeHostsRequest()

Constructors
Constructor and Description
`DescribeHostsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<Filter>`	`getFilter()` One or more filters.
`java.util.List<java.lang.String>`	`getHostIds()` The IDs of the Dedicated hosts.
`java.lang.Integer`	`getMaxResults()` The maximum number of results to return for the request in a single page.
`java.lang.String`	`getNextToken()` The token to retrieve the next page of results.
`int`	`hashCode()`
`void`	`setFilter(java.util.Collection<Filter> filter)` One or more filters.
`void`	`setHostIds(java.util.Collection<java.lang.String> hostIds)` The IDs of the Dedicated hosts.
`void`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of results to return for the request in a single page.
`void`	`setNextToken(java.lang.String nextToken)` The token to retrieve the next page of results.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeHostsRequest`	`withFilter(java.util.Collection<Filter> filter)` One or more filters.
`DescribeHostsRequest`	`withFilter(Filter... filter)` One or more filters.
`DescribeHostsRequest`	`withHostIds(java.util.Collection<java.lang.String> hostIds)` The IDs of the Dedicated hosts.
`DescribeHostsRequest`	`withHostIds(java.lang.String... hostIds)` The IDs of the Dedicated hosts.
`DescribeHostsRequest`	`withMaxResults(java.lang.Integer maxResults)` The maximum number of results to return for the request in a single page.
`DescribeHostsRequest`	`withNextToken(java.lang.String nextToken)` The token to retrieve the next page of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeHostsRequest
```
public DescribeHostsRequest()
```
- Method Detail
  - getHostIds
```
public java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.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.
  - withHostIds
```
public DescribeHostsRequest withHostIds(java.util.Collection<java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.util.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(java.util.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.
    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(java.util.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 java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class DescribeHostsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeHostsRequest

Method Detail

getHostIds

setHostIds

withHostIds

withHostIds

getNextToken

setNextToken

withNextToken

getMaxResults

setMaxResults

withMaxResults

getFilter

setFilter

withFilter

withFilter

toString

hashCode

equals