Package software.amazon.awssdk.services.outposts.model

Interface GetCapacityTaskResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetCapacityTaskResponse.Builder,GetCapacityTaskResponse>, OutpostsResponse.Builder, SdkBuilder<GetCapacityTaskResponse.Builder,GetCapacityTaskResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetCapacityTaskResponse

public static interface GetCapacityTaskResponse.Builder
extends OutpostsResponse.Builder, SdkPojo, CopyableBuilder<GetCapacityTaskResponse.Builder,GetCapacityTaskResponse>

Method Summary

Modifier and Type	Method	Description
GetCapacityTaskResponse.Builder	capacityTaskId(String capacityTaskId)	ID of the capacity task.
GetCapacityTaskResponse.Builder	capacityTaskStatus(String capacityTaskStatus)	Status of the capacity task.
GetCapacityTaskResponse.Builder	capacityTaskStatus(CapacityTaskStatus capacityTaskStatus)	Status of the capacity task.
GetCapacityTaskResponse.Builder	completionDate(Instant completionDate)	The date the capacity task ran successfully.
GetCapacityTaskResponse.Builder	creationDate(Instant creationDate)	The date the capacity task was created.
GetCapacityTaskResponse.Builder	dryRun(Boolean dryRun)	Performs a dry run to determine if you are above or below instance capacity.
default GetCapacityTaskResponse.Builder	failed(Consumer<CapacityTaskFailure.Builder> failed)	Reason why the capacity task failed.
GetCapacityTaskResponse.Builder	failed(CapacityTaskFailure failed)	Reason why the capacity task failed.
GetCapacityTaskResponse.Builder	lastModifiedDate(Instant lastModifiedDate)	The date the capacity task was last modified.
GetCapacityTaskResponse.Builder	orderId(String orderId)	ID of the Amazon Web Services Outposts order associated with the specified capacity task.
GetCapacityTaskResponse.Builder	outpostId(String outpostId)	ID of the Outpost associated with the specified capacity task.
GetCapacityTaskResponse.Builder	requestedInstancePools(Collection<InstanceTypeCapacity> requestedInstancePools)	List of instance pools requested in the capacity task.
GetCapacityTaskResponse.Builder	requestedInstancePools(Consumer<InstanceTypeCapacity.Builder>... requestedInstancePools)	List of instance pools requested in the capacity task.
GetCapacityTaskResponse.Builder	requestedInstancePools(InstanceTypeCapacity... requestedInstancePools)	List of instance pools requested in the capacity task.

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

copy

Methods inherited from interface software.amazon.awssdk.services.outposts.model.OutpostsResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

capacityTaskId

GetCapacityTaskResponse.Builder capacityTaskId(String capacityTaskId)

ID of the capacity task.

Parameters:

capacityTaskId - ID of the capacity task.

Returns:

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

outpostId

GetCapacityTaskResponse.Builder outpostId(String outpostId)

ID of the Outpost associated with the specified capacity task.

Parameters:

outpostId - ID of the Outpost associated with the specified capacity task.

Returns:

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

orderId

GetCapacityTaskResponse.Builder orderId(String orderId)

ID of the Amazon Web Services Outposts order associated with the specified capacity task.

Parameters:

orderId - ID of the Amazon Web Services Outposts order associated with the specified capacity task.

Returns:

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

requestedInstancePools

GetCapacityTaskResponse.Builder requestedInstancePools(Collection<InstanceTypeCapacity> requestedInstancePools)

List of instance pools requested in the capacity task.

Parameters:

requestedInstancePools - List of instance pools requested in the capacity task.

Returns:

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

requestedInstancePools

GetCapacityTaskResponse.Builder requestedInstancePools(InstanceTypeCapacity... requestedInstancePools)

List of instance pools requested in the capacity task.

Parameters:

requestedInstancePools - List of instance pools requested in the capacity task.

Returns:

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

requestedInstancePools

GetCapacityTaskResponse.Builder requestedInstancePools(Consumer<InstanceTypeCapacity.Builder>... requestedInstancePools)

List of instance pools requested in the capacity task.

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

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

Parameters:

requestedInstancePools - a consumer that will call methods on InstanceTypeCapacity.Builder

Returns:

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

See Also:

#requestedInstancePools(java.util.Collection)

dryRun

GetCapacityTaskResponse.Builder dryRun(Boolean dryRun)

Performs a dry run to determine if you are above or below instance capacity.

Parameters:

dryRun - Performs a dry run to determine if you are above or below instance capacity.

Returns:

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

capacityTaskStatus

GetCapacityTaskResponse.Builder capacityTaskStatus(String capacityTaskStatus)

Status of the capacity task.

A capacity task can have one of the following statuses:

• REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.

• IN_PROGRESS - The capacity task is running and cannot be cancelled.

• WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.

Parameters:

capacityTaskStatus - Status of the capacity task.

A capacity task can have one of the following statuses:

• REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.

• IN_PROGRESS - The capacity task is running and cannot be cancelled.

• WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.

Returns:

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

See Also:

CapacityTaskStatus, CapacityTaskStatus

capacityTaskStatus

GetCapacityTaskResponse.Builder capacityTaskStatus(CapacityTaskStatus capacityTaskStatus)

Status of the capacity task.

A capacity task can have one of the following statuses:

• REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.

• IN_PROGRESS - The capacity task is running and cannot be cancelled.

• WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.

Parameters:

capacityTaskStatus - Status of the capacity task.

A capacity task can have one of the following statuses:

• REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.

• IN_PROGRESS - The capacity task is running and cannot be cancelled.

• WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.

Returns:

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

See Also:

CapacityTaskStatus, CapacityTaskStatus

failed

GetCapacityTaskResponse.Builder failed(CapacityTaskFailure failed)

Reason why the capacity task failed.

Parameters:

failed - Reason why the capacity task failed.

Returns:

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

failed

default GetCapacityTaskResponse.Builder failed(Consumer<CapacityTaskFailure.Builder> failed)

Reason why the capacity task failed.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failed(CapacityTaskFailure).

Parameters:

failed - a consumer that will call methods on CapacityTaskFailure.Builder

Returns:

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

See Also:

failed(CapacityTaskFailure)

creationDate

GetCapacityTaskResponse.Builder creationDate(Instant creationDate)

The date the capacity task was created.

Parameters:

creationDate - The date the capacity task was created.

Returns:

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

completionDate

GetCapacityTaskResponse.Builder completionDate(Instant completionDate)

The date the capacity task ran successfully.

Parameters:

completionDate - The date the capacity task ran successfully.

Returns:

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

lastModifiedDate

GetCapacityTaskResponse.Builder lastModifiedDate(Instant lastModifiedDate)

The date the capacity task was last modified.

Parameters:

lastModifiedDate - The date the capacity task was last modified.

Returns:

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