@Generated(value="software.amazon.awssdk:codegen") public final class DescribeHostsRequest extends Ec2Request implements ToCopyableBuilder<DescribeHostsRequest.Builder,DescribeHostsRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeHostsRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static DescribeHostsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
List<Filter> |
filter()
The filters.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasFilter()
For responses, this returns true if the service returned a value for the Filter property.
|
int |
hashCode() |
boolean |
hasHostIds()
For responses, this returns true if the service returned a value for the HostIds property.
|
List<String> |
hostIds()
The IDs of the Dedicated Hosts.
|
Integer |
maxResults()
The maximum number of results to return for the request in a single page.
|
String |
nextToken()
The token to use to retrieve the next page of results.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeHostsRequest.Builder> |
serializableBuilderClass() |
DescribeHostsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasFilter()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Filter> filter()
The filters.
auto-placement - Whether auto-placement is enabled or disabled (on | off).
availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you allocated the host.
host-reservation-id - The ID of the reservation assigned to this host.
instance-type - The instance type size that the Dedicated Host is configured to support.
state - The allocation state of the Dedicated Host (available |
under-assessment | permanent-failure | released |
released-permanent-failure).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasFilter() method.
auto-placement - Whether auto-placement is enabled or disabled (on |
off).
availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you allocated the host.
host-reservation-id - The ID of the reservation assigned to this host.
instance-type - The instance type size that the Dedicated Host is configured to support.
state - The allocation state of the Dedicated Host (available |
under-assessment | permanent-failure | released |
released-permanent-failure).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
assigned a tag with a specific key, regardless of the tag value.
public final boolean hasHostIds()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<String> hostIds()
The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasHostIds() method.
public final 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 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 receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
public final String nextToken()
The token to use to retrieve the next page of results.
public DescribeHostsRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeHostsRequest.Builder,DescribeHostsRequest>toBuilder in class Ec2Requestpublic static DescribeHostsRequest.Builder builder()
public static Class<? extends DescribeHostsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.