software.amazon.awssdk.services.ec2.model

Class DescribeHostsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.DescribeHostsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeHostsRequest.Builder,DescribeHostsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeHostsRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeHostsRequest.Builder,DescribeHostsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeHostsRequest.Builder

Method Summary

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() Returns true if the Filter property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasHostIds() Returns true if the HostIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasFilter

public boolean hasFilter()

Returns true if the Filter property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

filter

public 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.

You can use hasFilter() to see if a value was sent in this field.

Returns:

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.

hasHostIds

public boolean hasHostIds()

Returns true if the HostIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

hostIds

public 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.

You can use hasHostIds() to see if a value was sent in this field.

Returns:

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

maxResults

public 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.

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 receive an error.

You cannot specify this parameter and the host IDs parameter in the same request.

nextToken

public String nextToken()

The token to use to retrieve the next page of results.

Returns:

The token to use to retrieve the next page of results.

toBuilder

public DescribeHostsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeHostsRequest.Builder,DescribeHostsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeHostsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeHostsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo