Package ai.extend.types

Class ExtractStepRun

java.lang.Object

ai.extend.types.ExtractStepRun

All Implemented Interfaces:

IStepRunBase

public final class ExtractStepRun
extends java.lang.Object
implements IStepRunBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExtractStepRun._FinalStage
static class	ExtractStepRun.Builder
static interface	ExtractStepRun.IdStage
static interface	ExtractStepRun.StatusStage
static interface	ExtractStepRun.StepStage
static interface	ExtractStepRun.WorkflowRunIdStage

Method Summary

Modifier and Type	Method	Description
static ExtractStepRun.IdStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.List<FileSummary>	getFiles()
java.lang.String	getId()
java.lang.String	getObject()
java.util.Optional<ExtractResult>	getResult()
StepRunBaseStatus	getStatus()
ExtractStepRunStep	getStep()
java.lang.String	getWorkflowRunId()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getObject

public java.lang.String getObject()

Specified by:

getObject in interface IStepRunBase

Returns:

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

getId

public java.lang.String getId()

Specified by:

getId in interface IStepRunBase

Returns:

The ID of the workflow step run.

Example: "workflow_step_run_xKm9pNv3qWsY_jL2tR5Dh"

getWorkflowRunId

public java.lang.String getWorkflowRunId()

Specified by:

getWorkflowRunId in interface IStepRunBase

Returns:

The ID of the parent workflow run.

Example: "workflow_run_xKm9pNv3qWsY_jL2tR5Dh"

getStatus

public StepRunBaseStatus getStatus()

Specified by:

getStatus in interface IStepRunBase

Returns:

The status of the workflow step run:

• "PENDING" - The step run is waiting to be executed
• "WAITING" - The step run is waiting for a dependency to complete
• "PROCESSING" - The step run is currently executing
• "PROCESSED" - The step run completed successfully
• "FAILED" - The step run encountered an error
• "CANCELLED" - The step run was cancelled

getFiles

public java.util.List<FileSummary> getFiles()

Specified by:

getFiles in interface IStepRunBase

Returns:

The files associated with this step run.

getStep

public ExtractStepRunStep getStep()

getResult

public java.util.Optional<ExtractResult> getResult()

Returns:

The result of this extract step. Currently, result is always present for returned step runs. It is nullable to allow for future support of returning step runs with non-successful statuses.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static ExtractStepRun.IdStage builder()