Interface WorkflowExecutionMetadata.Builder

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

  • Method Details

    • workflowBuildVersionArn

      WorkflowExecutionMetadata.Builder workflowBuildVersionArn(String workflowBuildVersionArn)

      The Amazon Resource Name (ARN) of the workflow resource build version that ran.

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

    • workflowExecutionId

      WorkflowExecutionMetadata.Builder workflowExecutionId(String workflowExecutionId)

      Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.

      Parameters:
      workflowExecutionId - Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      WorkflowExecutionMetadata.Builder type(String type)

      Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

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

    • type

      WorkflowExecutionMetadata.Builder type(WorkflowType type)

      Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

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

    • status

      WorkflowExecutionMetadata.Builder status(String status)

      The current runtime status for this workflow.

      Parameters:
      status - The current runtime status for this workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      WorkflowExecutionMetadata.Builder status(WorkflowExecutionStatus status)

      The current runtime status for this workflow.

      Parameters:
      status - The current runtime status for this workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • message

      WorkflowExecutionMetadata.Builder message(String message)

      The runtime output message from the workflow, if applicable.

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

    • totalStepCount

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

      WorkflowExecutionMetadata.Builder totalStepsSucceeded(Integer totalStepsSucceeded)

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

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

    • totalStepsFailed

      WorkflowExecutionMetadata.Builder totalStepsFailed(Integer totalStepsFailed)

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

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

    • totalStepsSkipped

      WorkflowExecutionMetadata.Builder totalStepsSkipped(Integer totalStepsSkipped)

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

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

    • startTime

      WorkflowExecutionMetadata.Builder startTime(String startTime)

      The timestamp when the runtime instance of this workflow started.

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

    • endTime

      WorkflowExecutionMetadata.Builder endTime(String endTime)

      The timestamp when this runtime instance of the workflow finished.

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

    • parallelGroup

      WorkflowExecutionMetadata.Builder parallelGroup(String parallelGroup)

      The name of the test group that included the test workflow resource at runtime.

      Parameters:
      parallelGroup - The name of the test group that included the test workflow resource at runtime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retried

      WorkflowExecutionMetadata.Builder retried(Boolean retried)

      Indicates whether a retry of the image build superseded this runtime instance of the workflow. When you retry a failed image build, Image Builder sets this flag to true on the original workflow executions that the retry re-ran.

      Parameters:
      retried - Indicates whether a retry of the image build superseded this runtime instance of the workflow. When you retry a failed image build, Image Builder sets this flag to true on the original workflow executions that the retry re-ran.
      Returns:
      Returns a reference to this object so that method calls can be chained together.