Interface GetWorkflowExecutionResponse.Builder

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

  • Method Details

    • requestId

      GetWorkflowExecutionResponse.Builder requestId(String requestId)

      The request ID that uniquely identifies this request.

      Parameters:
      requestId - The request ID that uniquely identifies this request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowBuildVersionArn

      GetWorkflowExecutionResponse.Builder workflowBuildVersionArn(String workflowBuildVersionArn)

      The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.

      Parameters:
      workflowBuildVersionArn - The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowExecutionId

      GetWorkflowExecutionResponse.Builder workflowExecutionId(String workflowExecutionId)

      The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

      Parameters:
      workflowExecutionId - The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageBuildVersionArn

      GetWorkflowExecutionResponse.Builder imageBuildVersionArn(String imageBuildVersionArn)

      The Amazon Resource Name (ARN) of the image build version that owns the specified runtime instance of the workflow.

      Parameters:
      imageBuildVersionArn - The Amazon Resource Name (ARN) of the image build version that owns the specified runtime instance of the workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      GetWorkflowExecutionResponse.Builder type(String type)

      The type of workflow that Image Builder ran for the specified runtime instance of the workflow.

      Parameters:
      type - The type of workflow that Image Builder ran for the specified runtime instance of the workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      GetWorkflowExecutionResponse.Builder type(WorkflowType type)

      The type of workflow that Image Builder ran for the specified runtime instance of the workflow.

      Parameters:
      type - The type of workflow that Image Builder ran for the specified runtime instance of the workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetWorkflowExecutionResponse.Builder status(String status)

      The current runtime status for the specified runtime instance of the workflow. COMPLETED, FAILED, ROLLBACK_COMPLETED, CANCELLED, and SKIPPED are terminal states.

      Parameters:
      status - The current runtime status for the specified runtime instance of the workflow. COMPLETED, FAILED, ROLLBACK_COMPLETED, CANCELLED, and SKIPPED are terminal states.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetWorkflowExecutionResponse.Builder status(WorkflowExecutionStatus status)

      The current runtime status for the specified runtime instance of the workflow. COMPLETED, FAILED, ROLLBACK_COMPLETED, CANCELLED, and SKIPPED are terminal states.

      Parameters:
      status - The current runtime status for the specified runtime instance of the workflow. COMPLETED, FAILED, ROLLBACK_COMPLETED, CANCELLED, and SKIPPED are terminal states.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • message

      GetWorkflowExecutionResponse.Builder message(String message)

      The output message from the specified runtime instance of the workflow, if applicable.

      Parameters:
      message - The output message from the specified runtime instance of the workflow, if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalStepCount

      GetWorkflowExecutionResponse.Builder totalStepCount(Integer totalStepCount)

      The total number of steps that the workflow document defines for this runtime instance of the workflow. Image Builder sets this count before any steps run. The sum of succeeded, skipped, and failed steps only reaches this total if every step finishes in one of those states.

      Parameters:
      totalStepCount - The total number of steps that the workflow document defines for this runtime instance of the workflow. Image Builder sets this count before any steps run. The sum of succeeded, skipped, and failed steps only reaches this total if every step finishes in one of those states.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalStepsSucceeded

      GetWorkflowExecutionResponse.Builder totalStepsSucceeded(Integer totalStepsSucceeded)

      A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.

      Parameters:
      totalStepsSucceeded - A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalStepsFailed

      GetWorkflowExecutionResponse.Builder totalStepsFailed(Integer totalStepsFailed)

      A runtime count for the number of steps that failed in the specified runtime instance of the workflow.

      Parameters:
      totalStepsFailed - A runtime count for the number of steps that failed in the specified runtime instance of the workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalStepsSkipped

      GetWorkflowExecutionResponse.Builder totalStepsSkipped(Integer totalStepsSkipped)

      A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.

      Parameters:
      totalStepsSkipped - A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      GetWorkflowExecutionResponse.Builder startTime(String startTime)

      The timestamp when the specified runtime instance of the workflow started.

      Parameters:
      startTime - The timestamp when the specified runtime instance of the workflow started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      GetWorkflowExecutionResponse.Builder endTime(String endTime)

      The timestamp when the specified runtime instance of the workflow finished.

      Parameters:
      endTime - The timestamp when the specified runtime instance of the workflow finished.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parallelGroup

      GetWorkflowExecutionResponse.Builder parallelGroup(String parallelGroup)

      The name of the parallel group that this runtime instance of the workflow ran in, if configured. Parallel groups apply only to test workflows.

      Parameters:
      parallelGroup - The name of the parallel group that this runtime instance of the workflow ran in, if configured. Parallel groups apply only to test workflows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.