software.amazon.awssdk.services.ec2.model

Interface DescribeFleetsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeFleetsRequest.Builder,DescribeFleetsRequest>, Ec2Request.Builder, SdkBuilder<DescribeFleetsRequest.Builder,DescribeFleetsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeFleetsRequest

public static interface DescribeFleetsRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeFleetsRequest.Builder,DescribeFleetsRequest>

Method Summary

Modifier and Type	Method and Description
DescribeFleetsRequest.Builder	dryRun(Boolean dryRun) Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
DescribeFleetsRequest.Builder	filters(Collection<Filter> filters) The filters.
DescribeFleetsRequest.Builder	filters(Consumer<Filter.Builder>... filters) The filters.
DescribeFleetsRequest.Builder	filters(Filter... filters) The filters.
DescribeFleetsRequest.Builder	fleetIds(Collection<String> fleetIds) The IDs of the EC2 Fleets.
DescribeFleetsRequest.Builder	fleetIds(String... fleetIds) The IDs of the EC2 Fleets.
DescribeFleetsRequest.Builder	maxResults(Integer maxResults) The maximum number of items to return for this request.
DescribeFleetsRequest.Builder	nextToken(String nextToken) The token returned from a previous paginated request.
DescribeFleetsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeFleetsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

dryRun

DescribeFleetsRequest.Builder dryRun(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

maxResults

DescribeFleetsRequest.Builder maxResults(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

nextToken

DescribeFleetsRequest.Builder nextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

fleetIds

DescribeFleetsRequest.Builder fleetIds(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

fleetIds

DescribeFleetsRequest.Builder fleetIds(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeFleetsRequest.Builder filters(Collection<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 ).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeFleetsRequest.Builder filters(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 ).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeFleetsRequest.Builder filters(Consumer<Filter.Builder>... 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 ).

This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on Filter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#filters(java.util.Collection)

overrideConfiguration

DescribeFleetsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeFleetsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder