DescribeHostsRequest (AWS SDK for Java

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeHostsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`List<SdkField<?>>`	`sdkFields()`
`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
overrideConfiguration

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.
    - 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.
    Returns:
    One or more 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.
  - 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 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 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
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class DescribeHostsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

filter

hostIds

maxResults

nextToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields