Class DescribeHostsRequest
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<DescribeHostsRequest>
,Serializable
,Cloneable
Contains the parameters for DescribeHosts.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
This method is intended for internal use only.One or more filters.The IDs of the Dedicated hosts.The maximum number of results to return for the request in a single page.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.toString()
Returns a string representation of this object; useful for testing and debugging.withFilter
(Filter... filter) One or more filters.withFilter
(Collection<Filter> filter) One or more filters.withHostIds
(String... hostIds) The IDs of the Dedicated hosts.withHostIds
(Collection<String> hostIds) The IDs of the Dedicated hosts.withMaxResults
(Integer maxResults) The maximum number of results to return for the request in a single page.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
-
Constructor Details
-
DescribeHostsRequest
public DescribeHostsRequest()
-
-
Method Details
-
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
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
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
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
The token to retrieve the next page of results.
- Parameters:
nextToken
- The token to retrieve the next page of results.
-
getNextToken
The token to retrieve the next page of results.
- Returns:
- The token to retrieve the next page of results.
-
withNextToken
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-