Interface GetPlanExecutionResponse.Builder

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

  • Method Details

    • planArn

      GetPlanExecutionResponse.Builder planArn(String planArn)

      The Amazon Resource Name (ARN) of the plan.

      Parameters:
      planArn - The Amazon Resource Name (ARN) of the plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionId

      GetPlanExecutionResponse.Builder executionId(String executionId)

      The execution identifier of a plan execution.

      Parameters:
      executionId - The execution identifier of a plan execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • version

      GetPlanExecutionResponse.Builder version(String version)

      The version for the plan.

      Parameters:
      version - The version for the plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      GetPlanExecutionResponse.Builder updatedAt(Instant updatedAt)

      The timestamp when the plan execution was last updated.

      Parameters:
      updatedAt - The timestamp when the plan execution was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • comment

      GetPlanExecutionResponse.Builder comment(String comment)

      A comment included on the plan execution.

      Parameters:
      comment - A comment included on the plan execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      GetPlanExecutionResponse.Builder startTime(Instant startTime)

      The time (UTC) when the plan execution started.

      Parameters:
      startTime - The time (UTC) when the plan execution started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      GetPlanExecutionResponse.Builder endTime(Instant endTime)

      The time (UTC) when the plan execution ended.

      Parameters:
      endTime - The time (UTC) when the plan execution ended.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mode

      GetPlanExecutionResponse.Builder mode(String mode)

      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

      Parameters:
      mode - The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mode

      GetPlanExecutionResponse.Builder mode(ExecutionMode mode)

      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

      Parameters:
      mode - The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionState

      GetPlanExecutionResponse.Builder executionState(String executionState)

      The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.

      Parameters:
      executionState - The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionState

      GetPlanExecutionResponse.Builder executionState(ExecutionState executionState)

      The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.

      Parameters:
      executionState - The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionAction

      GetPlanExecutionResponse.Builder executionAction(String executionAction)

      The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.

      Parameters:
      executionAction - The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionAction

      GetPlanExecutionResponse.Builder executionAction(ExecutionAction executionAction)

      The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.

      Parameters:
      executionAction - The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionRegion

      GetPlanExecutionResponse.Builder executionRegion(String executionRegion)

      The Amazon Web Services Region for a plan execution.

      Parameters:
      executionRegion - The Amazon Web Services Region for a plan execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stepStates

      GetPlanExecutionResponse.Builder stepStates(Collection<StepState> stepStates)

      The states of the steps in the plan execution.

      Parameters:
      stepStates - The states of the steps in the plan execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stepStates

      GetPlanExecutionResponse.Builder stepStates(StepState... stepStates)

      The states of the steps in the plan execution.

      Parameters:
      stepStates - The states of the steps in the plan execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stepStates

      GetPlanExecutionResponse.Builder stepStates(Consumer<StepState.Builder>... stepStates)

      The states of the steps in the plan execution.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stepStates(List<StepState>).

      Parameters:
      stepStates - a consumer that will call methods on StepState.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • plan

      GetPlanExecutionResponse.Builder plan(Plan plan)

      The details of the Region switch plan.

      Parameters:
      plan - The details of the Region switch plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • plan

      default GetPlanExecutionResponse.Builder plan(Consumer<Plan.Builder> plan)

      The details of the Region switch plan.

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

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

      Parameters:
      plan - a consumer that will call methods on Plan.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • actualRecoveryTime

      GetPlanExecutionResponse.Builder actualRecoveryTime(String actualRecoveryTime)

      The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.

      Parameters:
      actualRecoveryTime - The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      GetPlanExecutionResponse.Builder nextToken(String nextToken)

      Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

      Parameters:
      nextToken - Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.