Package software.amazon.awssdk.services.ec2.model

Class DescribeHostReservationOfferingsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeHostReservationOfferingsRequest.Builder,DescribeHostReservationOfferingsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeHostReservationOfferingsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeHostReservationOfferingsRequest.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()
Integer	maxDuration()	This is the maximum duration of the reservation to purchase, specified in seconds.
Integer	maxResults()	The maximum number of results to return for the request in a single page.
Integer	minDuration()	This is the minimum duration of the reservation you'd like to purchase, specified in seconds.
String	nextToken()	The token to use to retrieve the next page of results.
String	offeringId()	The ID of the reservation offering.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeHostReservationOfferingsRequest.Builder>	serializableBuilderClass()
DescribeHostReservationOfferingsRequest.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()

For responses, this returns true if the service returned a value for the Filter property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

filter

public final List<Filter> filter()

The filters.

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

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

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.

Returns:

The filters.

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

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

maxDuration

public final Integer maxDuration()

This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.

Returns:

This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.

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.

minDuration

public final Integer minDuration()

This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.

Returns:

This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.

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.

offeringId

public final String offeringId()

The ID of the reservation offering.

Returns:

The ID of the reservation offering.

toBuilder

public DescribeHostReservationOfferingsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeHostReservationOfferingsRequest.Builder,DescribeHostReservationOfferingsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeHostReservationOfferingsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeHostReservationOfferingsRequest.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