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	equals(Object obj)
List<Filter>	filters() One or more filters.
List<String>	fleetIds() The ID of the EC2 Fleets.
<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()
Integer	maxResults() The maximum number of results to return in a single call.
String	nextToken() The token for the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeFleetsRequest.Builder>	serializableBuilderClass()
DescribeFleetsRequest.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

maxResults

public Integer maxResults()

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

public String nextToken()

The token for the next set of results.

Returns:

The token for the next set of results.

fleetIds

public List<String> fleetIds()

The ID of the EC2 Fleets.

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

Returns:

The ID of the EC2 Fleets.

filters

public List<Filter> filters()

One or more 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.

Returns:

One or more 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()

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

Specified by:

toBuilder in class Ec2Request

Returns:

a builder for type T

builder

public static DescribeFleetsRequest.Builder builder()

serializableBuilderClass

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