software.amazon.awssdk.services.ec2.model

Class DescribeHostReservationsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeHostReservationsRequest.Builder,DescribeHostReservationsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeHostReservationsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeHostReservationsRequest.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	hasHostReservationIdSet() Returns true if the HostReservationIdSet 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>	hostReservationIdSet() The host reservation IDs.
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 DescribeHostReservationsRequest.Builder>	serializableBuilderClass()
DescribeHostReservationsRequest.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 final 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 final List<Filter> filter()

The filters.

• instance-family - The instance family (for example, m4).

• payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

• state - The state of the reservation (payment-pending | payment-failed | active | retired).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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

• instance-family - The instance family (for example, m4).

• payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

• state - The state of the reservation (payment-pending | payment-failed | active | retired).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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

hasHostReservationIdSet

public final boolean hasHostReservationIdSet()

Returns true if the HostReservationIdSet 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.

hostReservationIdSet

public final List<String> hostReservationIdSet()

The host reservation IDs.

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

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

Returns:

The host reservation IDs.

maxResults

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.

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.

nextToken

public final 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 DescribeHostReservationsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeHostReservationsRequest.Builder,DescribeHostReservationsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeHostReservationsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo