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:

ToCopyableBuilder<DescribeHostsRequest.Builder,DescribeHostsRequest>

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

Contains the parameters for DescribeHosts.

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)
List<Filter>	filter() One or more filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
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 retrieve the next page of results.
static Class<? extends DescribeHostsRequest.Builder>	serializableBuilderClass()
DescribeHostsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

filter

public List<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 assigned to 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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 assigned to 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.

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.

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 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; 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

public String nextToken()

The token to retrieve the next page of results.

Returns:

The token to retrieve the next page of results.

toBuilder

public DescribeHostsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeHostsRequest.Builder,DescribeHostsRequest>

Specified by:

toBuilder in class EC2Request

Returns:

a builder for type T

builder

public static DescribeHostsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value