Package ai.extend.types

Class StepRun.Builder

java.lang.Object

ai.extend.types.StepRun.Builder

All Implemented Interfaces:

StepRun._FinalStage, StepRun.IdStage, StepRun.ObjectStage, StepRun.StatusStage, StepRun.StepStage

Enclosing class:

StepRun

public static final class StepRun.Builder
extends java.lang.Object
implements StepRun.ObjectStage, StepRun.IdStage, StepRun.StatusStage, StepRun.StepStage, StepRun._FinalStage

Method Summary

Modifier and Type	Method	Description
StepRun	build()
StepRun.Builder	from(StepRun other)
StepRun.StatusStage	id(java.lang.String id)	The ID of the workflow step run.
StepRun.IdStage	object(java.lang.String object)	The type of response.
StepRun._FinalStage	output(StepRunOutput output)	The output of the WorkflowStepRun.
StepRun._FinalStage	output(java.util.Optional<StepRunOutput> output)	The output of the WorkflowStepRun.
StepRun.StepStage	status(StepRunStatus status)	The status of the workflow step run:
StepRun._FinalStage	step(StepRunStep step)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public StepRun.Builder from(StepRun other)

Specified by:

from in interface StepRun.ObjectStage

object

public StepRun.IdStage object(@NotNull
                              java.lang.String object)

The type of response. In this case, it will always be "workflow_step_run".

The type of response. In this case, it will always be "workflow_step_run".

Specified by:

object in interface StepRun.ObjectStage

Returns:

Reference to this so that method calls can be chained together.

id

public StepRun.StatusStage id(@NotNull
                              java.lang.String id)

The ID of the workflow step run.

Example: "workflow_step_run_xKm9pNv3qWsY_jL2tR5Dh"

The ID of the workflow step run.

Example: "workflow_step_run_xKm9pNv3qWsY_jL2tR5Dh"

Specified by:

id in interface StepRun.IdStage

Returns:

Reference to this so that method calls can be chained together.

status

public StepRun.StepStage status(@NotNull
                                StepRunStatus status)

The status of the workflow step run:

• "PENDING" - The step run is waiting to be executed
• "PROCESSING" - The step run is currently executing
• "PROCESSED" - The step run completed successfully
• "FAILED" - The step run encountered an error

The status of the workflow step run:

• "PENDING" - The step run is waiting to be executed
• "PROCESSING" - The step run is currently executing
• "PROCESSED" - The step run completed successfully
• "FAILED" - The step run encountered an error

Specified by:

status in interface StepRun.StatusStage

Returns:

Reference to this so that method calls can be chained together.

step

public StepRun._FinalStage step(@NotNull
                                StepRunStep step)

Specified by:

step in interface StepRun.StepStage

output

public StepRun._FinalStage output(StepRunOutput output)

The output of the WorkflowStepRun. The shape of the output depends on the type of the WorkflowStep in the step field:

• For "EXTERNAL_DATA_VALIDATION" steps - The output will be the same object that was returned by the external endpoint configured for this step
• For "RULE_VALIDATION" steps - See the below shape:

Specified by:

output in interface StepRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

output

public StepRun._FinalStage output(java.util.Optional<StepRunOutput> output)

The output of the WorkflowStepRun. The shape of the output depends on the type of the WorkflowStep in the step field:

• For "EXTERNAL_DATA_VALIDATION" steps - The output will be the same object that was returned by the external endpoint configured for this step
• For "RULE_VALIDATION" steps - See the below shape:

Specified by:

output in interface StepRun._FinalStage

build

public StepRun build()

Specified by:

build in interface StepRun._FinalStage