Interface GetWorkflowStepExecutionResponse.Builder

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

  • Method Details

    • requestId

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

    • stepExecutionId

      GetWorkflowStepExecutionResponse.Builder stepExecutionId(String stepExecutionId)

      The unique identifier for the runtime instance of the workflow step that you specified in the request.

      Parameters:
      stepExecutionId - The unique identifier for the runtime instance of the workflow step that you specified in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowBuildVersionArn

      GetWorkflowStepExecutionResponse.Builder workflowBuildVersionArn(String workflowBuildVersionArn)

      The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.

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

    • workflowExecutionId

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

      GetWorkflowStepExecutionResponse.Builder imageBuildVersionArn(String imageBuildVersionArn)

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

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

    • name

      GetWorkflowStepExecutionResponse.Builder name(String name)

      The name of the specified runtime instance of the workflow step.

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

    • description

      GetWorkflowStepExecutionResponse.Builder description(String description)

      Describes the specified workflow step.

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

    • action

      GetWorkflowStepExecutionResponse.Builder action(String action)

      The name of the action that the specified step performs.

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

    • status

      GetWorkflowStepExecutionResponse.Builder status(String status)

      The current status for the specified runtime instance of the workflow step.

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

    • status

      GetWorkflowStepExecutionResponse.Builder status(WorkflowStepExecutionStatus status)

      The current status for the specified runtime instance of the workflow step.

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

    • rollbackStatus

      GetWorkflowStepExecutionResponse.Builder rollbackStatus(String rollbackStatus)

      Reports on the rollback status of the specified runtime instance of the workflow step, if applicable. Rollback runs when the workflow execution fails, and undoes the work that completed steps performed.

      Parameters:
      rollbackStatus - Reports on the rollback status of the specified runtime instance of the workflow step, if applicable. Rollback runs when the workflow execution fails, and undoes the work that completed steps performed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rollbackStatus

      GetWorkflowStepExecutionResponse.Builder rollbackStatus(WorkflowStepExecutionRollbackStatus rollbackStatus)

      Reports on the rollback status of the specified runtime instance of the workflow step, if applicable. Rollback runs when the workflow execution fails, and undoes the work that completed steps performed.

      Parameters:
      rollbackStatus - Reports on the rollback status of the specified runtime instance of the workflow step, if applicable. Rollback runs when the workflow execution fails, and undoes the work that completed steps performed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • message

      GetWorkflowStepExecutionResponse.Builder message(String message)

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

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

    • inputs

      GetWorkflowStepExecutionResponse.Builder inputs(String inputs)

      Input parameters that Image Builder provided for the specified runtime instance of the workflow step, as a JSON-encoded string.

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

    • outputs

      GetWorkflowStepExecutionResponse.Builder outputs(String outputs)

      The output values that the specified runtime instance of the workflow step produced, 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 specified runtime instance of the workflow step produced, 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

      GetWorkflowStepExecutionResponse.Builder startTime(String startTime)

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

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

    • endTime

      GetWorkflowStepExecutionResponse.Builder endTime(String endTime)

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

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

    • onFailure

      GetWorkflowStepExecutionResponse.Builder onFailure(String onFailure)

      The action that the workflow takes if this step fails, as configured in the workflow document. Abort fails the workflow and rolls back completed steps. Continue proceeds to the next step. If the step doesn't set a value, it defaults to Abort.

      Parameters:
      onFailure - The action that the workflow takes if this step fails, as configured in the workflow document. Abort fails the workflow and rolls back completed steps. Continue proceeds to the next step. If the step doesn't set a value, it defaults to Abort.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeoutSeconds

      GetWorkflowStepExecutionResponse.Builder timeoutSeconds(Integer timeoutSeconds)

      The maximum duration in seconds for this step to complete its action. If the workflow document doesn't set a timeout for the step, Image Builder applies the default timeout for the step's action. This field returns that value.

      Parameters:
      timeoutSeconds - The maximum duration in seconds for this step to complete its action. If the workflow document doesn't set a timeout for the step, Image Builder applies the default timeout for the step's action. This field returns that value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attemptNumber

      GetWorkflowStepExecutionResponse.Builder attemptNumber(Integer attemptNumber)

      The current attempt number for the specified runtime instance of 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 specified runtime instance of 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

      GetWorkflowStepExecutionResponse.Builder maxAttempts(Integer maxAttempts)

      The maximum number of attempts allowed for the specified runtime instance of 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 specified runtime instance of 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.