Interface WorkflowStepMetadata.Builder

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

  • Method Details

    • stepExecutionId

      WorkflowStepMetadata.Builder stepExecutionId(String stepExecutionId)

      A unique identifier for the workflow step, assigned at runtime.

      Parameters:
      stepExecutionId - A unique identifier for the workflow step, assigned at runtime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      WorkflowStepMetadata.Builder name(String name)

      The name of the workflow step.

      Parameters:
      name - The name of the workflow step.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      WorkflowStepMetadata.Builder description(String description)

      Description of the workflow step.

      Parameters:
      description - Description of the workflow step.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • action

      WorkflowStepMetadata.Builder action(String action)

      The step action name.

      Parameters:
      action - The step action name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      WorkflowStepMetadata.Builder status(String status)

      Runtime status for the workflow step.

      Parameters:
      status - Runtime status for the workflow step.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      WorkflowStepMetadata.Builder status(WorkflowStepExecutionStatus status)

      Runtime status for the workflow step.

      Parameters:
      status - Runtime status for the workflow step.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rollbackStatus

      WorkflowStepMetadata.Builder rollbackStatus(String rollbackStatus)

      Reports on the rollback status of the step, if applicable.

      Parameters:
      rollbackStatus - Reports on the rollback status of the step, if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rollbackStatus

      WorkflowStepMetadata.Builder rollbackStatus(WorkflowStepExecutionRollbackStatus rollbackStatus)

      Reports on the rollback status of the step, if applicable.

      Parameters:
      rollbackStatus - Reports on the rollback status of the step, if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • message

      WorkflowStepMetadata.Builder message(String message)

      Detailed output message that the workflow step provides at runtime.

      Parameters:
      message - Detailed output message that the workflow step provides at runtime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputs

      WorkflowStepMetadata.Builder inputs(String inputs)

      Input parameters that Image Builder provides for the workflow step, as a JSON-encoded string.

      Parameters:
      inputs - Input parameters that Image Builder provides for the workflow step, as a JSON-encoded string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputs

      WorkflowStepMetadata.Builder outputs(String outputs)

      The output values that the workflow step produced for this runtime instance of the workflow, as a JSON-encoded string. For example, a step that launches an instance outputs the instance ID. If the step failed, this field contains the error message.

      Parameters:
      outputs - The output values that the workflow step produced for this runtime instance of the workflow, as a JSON-encoded string. For example, a step that launches an instance outputs the instance ID. If the step failed, this field contains the error message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      WorkflowStepMetadata.Builder startTime(String startTime)

      The timestamp when the workflow step started.

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

    • endTime

      WorkflowStepMetadata.Builder endTime(String endTime)

      The timestamp when the workflow step finished.

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

    • attemptNumber

      WorkflowStepMetadata.Builder attemptNumber(Integer attemptNumber)

      The current attempt number for the workflow step. The first run is attempt one. The number increases by one for each retry.

      Parameters:
      attemptNumber - The current attempt number for the workflow step. The first run is attempt one. The number increases by one for each retry.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxAttempts

      WorkflowStepMetadata.Builder maxAttempts(Integer maxAttempts)

      The maximum number of attempts allowed for the workflow step, based on the retry configuration in the workflow document. If the step doesn't configure retries, the maximum is one attempt.

      Parameters:
      maxAttempts - The maximum number of attempts allowed for the workflow step, based on the retry configuration in the workflow document. If the step doesn't configure retries, the maximum is one attempt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.