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

Interface StartCapacityTaskResponse.Builder

All Superinterfaces:

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

Enclosing class:

StartCapacityTaskResponse

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

Method Summary

Modifier and Type	Method	Description
StartCapacityTaskResponse.Builder	capacityTaskId(String capacityTaskId)	ID of the capacity task that you want to start.
StartCapacityTaskResponse.Builder	capacityTaskStatus(String capacityTaskStatus)	Status of the specified capacity task.
StartCapacityTaskResponse.Builder	capacityTaskStatus(CapacityTaskStatus capacityTaskStatus)	Status of the specified capacity task.
StartCapacityTaskResponse.Builder	completionDate(Instant completionDate)	Date that the specified capacity task ran successfully.
StartCapacityTaskResponse.Builder	creationDate(Instant creationDate)	Date that the specified capacity task was created.
StartCapacityTaskResponse.Builder	dryRun(Boolean dryRun)	Results of the dry run showing if the specified capacity task is above or below the available instance capacity.
default StartCapacityTaskResponse.Builder	failed(Consumer<CapacityTaskFailure.Builder> failed)	Reason that the specified capacity task failed.
StartCapacityTaskResponse.Builder	failed(CapacityTaskFailure failed)	Reason that the specified capacity task failed.
default StartCapacityTaskResponse.Builder	instancesToExclude(Consumer<InstancesToExclude.Builder> instancesToExclude)	User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.
StartCapacityTaskResponse.Builder	instancesToExclude(InstancesToExclude instancesToExclude)	User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.
StartCapacityTaskResponse.Builder	lastModifiedDate(Instant lastModifiedDate)	Date that the specified capacity task was last modified.
StartCapacityTaskResponse.Builder	orderId(String orderId)	ID of the Amazon Web Services Outposts order of the host associated with the capacity task.
StartCapacityTaskResponse.Builder	outpostId(String outpostId)	ID of the Outpost associated with the capacity task.
StartCapacityTaskResponse.Builder	requestedInstancePools(Collection<InstanceTypeCapacity> requestedInstancePools)	List of the instance pools requested in the specified capacity task.
StartCapacityTaskResponse.Builder	requestedInstancePools(Consumer<InstanceTypeCapacity.Builder>... requestedInstancePools)	List of the instance pools requested in the specified capacity task.
StartCapacityTaskResponse.Builder	requestedInstancePools(InstanceTypeCapacity... requestedInstancePools)	List of the instance pools requested in the specified capacity task.
StartCapacityTaskResponse.Builder	taskActionOnBlockingInstances(String taskActionOnBlockingInstances)	User-specified option in case an instance is blocking the capacity task from running.
StartCapacityTaskResponse.Builder	taskActionOnBlockingInstances(TaskActionOnBlockingInstances taskActionOnBlockingInstances)	User-specified option in case an instance is blocking the capacity task from running.

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, sdkFieldNameToField, sdkFields

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

sdkHttpResponse, sdkHttpResponse

Method Detail

capacityTaskId

StartCapacityTaskResponse.Builder capacityTaskId(String capacityTaskId)

ID of the capacity task that you want to start.

Parameters:

capacityTaskId - ID of the capacity task that you want to start.

Returns:

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

outpostId

StartCapacityTaskResponse.Builder outpostId(String outpostId)

ID of the Outpost associated with the capacity task.

Parameters:

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

Returns:

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

orderId

StartCapacityTaskResponse.Builder orderId(String orderId)

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

Parameters:

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

Returns:

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

requestedInstancePools

StartCapacityTaskResponse.Builder requestedInstancePools(Collection<InstanceTypeCapacity> requestedInstancePools)

List of the instance pools requested in the specified capacity task.

Parameters:

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

Returns:

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

requestedInstancePools

StartCapacityTaskResponse.Builder requestedInstancePools(InstanceTypeCapacity... requestedInstancePools)

List of the instance pools requested in the specified capacity task.

Parameters:

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

Returns:

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

requestedInstancePools

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

List of the instance pools requested in the specified 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)

instancesToExclude

StartCapacityTaskResponse.Builder instancesToExclude(InstancesToExclude instancesToExclude)

User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.

Parameters:

instancesToExclude - User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.

Returns:

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

instancesToExclude

default StartCapacityTaskResponse.Builder instancesToExclude(Consumer<InstancesToExclude.Builder> instancesToExclude)

User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.

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

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

Parameters:

instancesToExclude - a consumer that will call methods on InstancesToExclude.Builder

Returns:

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

See Also:

instancesToExclude(InstancesToExclude)

dryRun

StartCapacityTaskResponse.Builder dryRun(Boolean dryRun)

Results of the dry run showing if the specified capacity task is above or below the available instance capacity.

Parameters:

dryRun - Results of the dry run showing if the specified capacity task is above or below the available instance capacity.

Returns:

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

capacityTaskStatus

StartCapacityTaskResponse.Builder capacityTaskStatus(String capacityTaskStatus)

Status of the specified capacity task.

Parameters:

capacityTaskStatus - Status of the specified capacity task.

Returns:

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

See Also:

CapacityTaskStatus, CapacityTaskStatus

capacityTaskStatus

StartCapacityTaskResponse.Builder capacityTaskStatus(CapacityTaskStatus capacityTaskStatus)

Status of the specified capacity task.

Parameters:

capacityTaskStatus - Status of the specified capacity task.

Returns:

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

See Also:

CapacityTaskStatus, CapacityTaskStatus

failed

StartCapacityTaskResponse.Builder failed(CapacityTaskFailure failed)

Reason that the specified capacity task failed.

Parameters:

failed - Reason that the specified capacity task failed.

Returns:

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

failed

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

Reason that the specified 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

StartCapacityTaskResponse.Builder creationDate(Instant creationDate)

Date that the specified capacity task was created.

Parameters:

creationDate - Date that the specified capacity task was created.

Returns:

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

completionDate

StartCapacityTaskResponse.Builder completionDate(Instant completionDate)

Date that the specified capacity task ran successfully.

Parameters:

completionDate - Date that the specified capacity task ran successfully.

Returns:

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

lastModifiedDate

StartCapacityTaskResponse.Builder lastModifiedDate(Instant lastModifiedDate)

Date that the specified capacity task was last modified.

Parameters:

lastModifiedDate - Date that the specified capacity task was last modified.

Returns:

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

taskActionOnBlockingInstances

StartCapacityTaskResponse.Builder taskActionOnBlockingInstances(String taskActionOnBlockingInstances)

User-specified option in case an instance is blocking the capacity task from running.

• WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

• FAIL_TASK - The capacity task fails.

Parameters:

taskActionOnBlockingInstances - User-specified option in case an instance is blocking the capacity task from running.

• WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

• FAIL_TASK - The capacity task fails.

Returns:

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

See Also:

TaskActionOnBlockingInstances, TaskActionOnBlockingInstances

taskActionOnBlockingInstances

StartCapacityTaskResponse.Builder taskActionOnBlockingInstances(TaskActionOnBlockingInstances taskActionOnBlockingInstances)

User-specified option in case an instance is blocking the capacity task from running.

• WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

• FAIL_TASK - The capacity task fails.

Parameters:

taskActionOnBlockingInstances - User-specified option in case an instance is blocking the capacity task from running.

• WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

• FAIL_TASK - The capacity task fails.

Returns:

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

See Also:

TaskActionOnBlockingInstances, TaskActionOnBlockingInstances