/* * Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.ec2.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** * Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeHosts(DescribeHostsRequest) 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
.
*
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.
*/
private Integer maxResults;
/**
* 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.
*
* @param hostIds The IDs of the Dedicated hosts. The IDs are used for targeted instance
* launches.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeHostsRequest withHostIds(String... hostIds) {
if (getHostIds() == null) setHostIds(new java.util.ArrayList
* Returns a reference to this object so that method calls can be chained together.
*
* @param hostIds The IDs of the Dedicated hosts. The IDs are used for targeted instance
* launches.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeHostsRequest withHostIds(java.util.Collection
* Returns a reference to this object so that method calls can be chained together.
*
* @param nextToken The token to retrieve the next page of results.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeHostsRequest withNextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
/**
* 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
* Returns a reference to this object so that method calls can be chained together.
*
* @param 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
* Returns a reference to this object so that method calls can be chained together.
*
* @param filter One or more filters.
* Returns a reference to this object so that method calls can be chained together.
*
* @param filter One or more filters. 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.
*
* @return 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.
*/
public Integer getMaxResults() {
return 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.
*
* @param 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.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = 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.
* 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeHostsRequest withMaxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
/**
* One or more filters.
*
* @return 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 instancestate
- The
* allocation state of the Dedicated host (available
|
* under-assessment
| permanent-failure
|
* released
| released-permanent-failure
).availability-zone
- The Availability Zone of the
* host.
*/
public java.util.Listinstance-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 instancestate
- The
* allocation state of the Dedicated host (available
|
* under-assessment
| permanent-failure
|
* released
| released-permanent-failure
).availability-zone
- The Availability Zone of the
* host.
*
* @param 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 instancestate
- The
* allocation state of the Dedicated host (available
|
* under-assessment
| permanent-failure
|
* released
| released-permanent-failure
).availability-zone
- The Availability Zone of the
* host.
*/
public void setFilter(java.util.Collectioninstance-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 instancestate
- The
* allocation state of the Dedicated host (available
|
* under-assessment
| permanent-failure
|
* released
| released-permanent-failure
).availability-zone
- The Availability Zone of the
* host.
* 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 instancestate
- The
* allocation state of the Dedicated host (available
|
* under-assessment
| permanent-failure
|
* released
| released-permanent-failure
).availability-zone
- The Availability Zone of the
* host.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeHostsRequest withFilter(Filter... filter) {
if (getFilter() == null) setFilter(new java.util.ArrayListinstance-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 instancestate
- The
* allocation state of the Dedicated host (available
|
* under-assessment
| permanent-failure
|
* released
| released-permanent-failure
).availability-zone
- The Availability Zone of the
* host.
* 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 instancestate
- The
* allocation state of the Dedicated host (available
|
* under-assessment
| permanent-failure
|
* released
| released-permanent-failure
).availability-zone
- The Availability Zone of the
* host.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeHostsRequest withFilter(java.util.Collectioninstance-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 instancestate
- The
* allocation state of the Dedicated host (available
|
* under-assessment
| permanent-failure
|
* released
| released-permanent-failure
).availability-zone
- The Availability Zone of the
* host.