Class DescribeHostsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.ec2.model.DescribeHostsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<DescribeHostsRequest>
,Serializable
,Cloneable
public class DescribeHostsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeHostsRequest>
Contains the parameters for DescribeHosts.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeHostsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeHostsRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Request<DescribeHostsRequest>
getDryRunRequest()
This method is intended for internal use only.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(Filter... filter)
One or more filters.DescribeHostsRequest
withFilter(Collection<Filter> filter)
One or more filters.DescribeHostsRequest
withHostIds(String... hostIds)
The IDs of the Dedicated hosts.DescribeHostsRequest
withHostIds(Collection<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
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
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)
orwithHostIds(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.
-
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.
-
getNextToken
public String getNextToken()
The token to retrieve the next page of results.
- Returns:
- The token to retrieve the next page of results.
-
withNextToken
public DescribeHostsRequest withNextToken(String nextToken)
The token to retrieve the next page of results.
- Parameters:
nextToken
- The token to retrieve the next page of results.- 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; ifmaxResults
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 returnednextToken
value. This value can be between 5 and 500; ifmaxResults
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.
-
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; ifmaxResults
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; ifmaxResults
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; ifmaxResults
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 returnednextToken
value. This value can be between 5 and 500; ifmaxResults
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:
- Returns a reference to this 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)
orwithFilter(java.util.Collection)
if you want to override the existing values.- 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:
- Returns a reference to this 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.
- 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:
- 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 interfaceDryRunSupportedRequest<DescribeHostsRequest>
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-