software.amazon.awssdk.services.ec2.model

Class DescribeFleetsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeFleetsRequest.Builder,DescribeFleetsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeFleetsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeFleetsRequest.Builder	builder()
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() The filters.
List<String>	fleetIds() The IDs of the EC2 Fleets.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
boolean	hasFleetIds() For responses, this returns true if the service returned a value for the FleetIds property.
int	hashCode()
Integer	maxResults() The maximum number of items to return for this request.
String	nextToken() The token returned from a previous paginated request.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeFleetsRequest.Builder>	serializableBuilderClass()
DescribeFleetsRequest.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

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.

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.

nextToken

public final String nextToken()

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

hasFleetIds

public final boolean hasFleetIds()

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

fleetIds

public final List<String> fleetIds()

The IDs of the EC2 Fleets.

If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.

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

Returns:

The IDs of the EC2 Fleets.

If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.

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()

The filters.

• activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).

• excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).

• fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).

• replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances ( true | false).

• type - The type of request (instant | request | maintain).

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:

The filters.

• activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).

• excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).

• fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).

• replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).

• type - The type of request (instant | request | maintain).

toBuilder

public DescribeFleetsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeFleetsRequest.Builder,DescribeFleetsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeFleetsRequest.Builder builder()

serializableBuilderClass

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