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

Class DescribeCapacityReservationFleetsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCapacityReservationFleetsRequest.Builder,DescribeCapacityReservationFleetsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeCapacityReservationFleetsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeCapacityReservationFleetsRequest.Builder	builder()
List<String>	capacityReservationFleetIds()	The IDs of the Capacity Reservation Fleets to describe.
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	One or more filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCapacityReservationFleetIds()	For responses, this returns true if the service returned a value for the CapacityReservationFleetIds property.
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Integer	maxResults()	The maximum number of items to return for this request.
String	nextToken()	The token to use to retrieve the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCapacityReservationFleetsRequest.Builder>	serializableBuilderClass()
DescribeCapacityReservationFleetsRequest.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

hasCapacityReservationFleetIds

public final boolean hasCapacityReservationFleetIds()

For responses, this returns true if the service returned a value for the CapacityReservationFleetIds 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.

capacityReservationFleetIds

public final List<String> capacityReservationFleetIds()

The IDs of the Capacity Reservation Fleets to describe.

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 hasCapacityReservationFleetIds() method.

Returns:

The IDs of the Capacity Reservation Fleets to describe.

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.

maxResults

public final Integer maxResults()

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Returns:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters 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.

filters

public final List<Filter> filters()

One or more filters.

• state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).

• instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.

• tenancy - The tenancy of the Fleet (default | dedicated).

• allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.

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 hasFilters() method.

Returns:

One or more filters.

• state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).

• instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.

• tenancy - The tenancy of the Fleet (default | dedicated).

• allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.

dryRun

public final Boolean dryRun()

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

toBuilder

public DescribeCapacityReservationFleetsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCapacityReservationFleetsRequest.Builder,DescribeCapacityReservationFleetsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeCapacityReservationFleetsRequest.Builder builder()

serializableBuilderClass

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