Interface GetCapacityTaskResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetCapacityTaskResponse.Builder,GetCapacityTaskResponse>, OutpostsResponse.Builder, SdkBuilder<GetCapacityTaskResponse.Builder,GetCapacityTaskResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetCapacityTaskResponse
@Mutable @NotThreadSafe public static interface GetCapacityTaskResponse.Builder extends OutpostsResponse.Builder, SdkPojo, CopyableBuilder<GetCapacityTaskResponse.Builder,GetCapacityTaskResponse>

  • Method Details

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

    • assetId

      GetCapacityTaskResponse.Builder assetId(String assetId)

      The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

      Parameters:
      assetId - The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
      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<InstanceTypeCapacity>).

      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:

    • instancesToExclude

      GetCapacityTaskResponse.Builder instancesToExclude(InstancesToExclude instancesToExclude)

      Instances that the user specified they cannot stop in order to free up the capacity needed to run the capacity task.

      Parameters:
      instancesToExclude - Instances that the user specified they cannot stop 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 GetCapacityTaskResponse.Builder instancesToExclude(Consumer<InstancesToExclude.Builder> instancesToExclude)

      Instances that the user specified they cannot stop 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:

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

      • FAILED - The capacity task could not be completed.

      • COMPLETED - The capacity task has completed successfully.

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

      • CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.

      • CANCELLED - The capacity task is cancelled.

      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.

      • FAILED - The capacity task could not be completed.

      • COMPLETED - The capacity task has completed successfully.

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

      • CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.

      • CANCELLED - The capacity task is cancelled.

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

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

      • FAILED - The capacity task could not be completed.

      • COMPLETED - The capacity task has completed successfully.

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

      • CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.

      • CANCELLED - The capacity task is cancelled.

      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.

      • FAILED - The capacity task could not be completed.

      • COMPLETED - The capacity task has completed successfully.

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

      • CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.

      • CANCELLED - The capacity task is cancelled.

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

    • 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:

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

    • taskActionOnBlockingInstances

      GetCapacityTaskResponse.Builder taskActionOnBlockingInstances(String taskActionOnBlockingInstances)

      User-specified option in case an instance is blocking the capacity task from running. Shows one of the following options:

      • 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. Shows one of the following options:

      • 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

      GetCapacityTaskResponse.Builder taskActionOnBlockingInstances(TaskActionOnBlockingInstances taskActionOnBlockingInstances)

      User-specified option in case an instance is blocking the capacity task from running. Shows one of the following options:

      • 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. Shows one of the following options:

      • 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: