Package ai.extend.resources.workflowrun.types

Class WorkflowRunCancelResponseWorkflowRun.Builder

java.lang.Object

ai.extend.resources.workflowrun.types.WorkflowRunCancelResponseWorkflowRun.Builder

All Implemented Interfaces:

WorkflowRunCancelResponseWorkflowRun._FinalStage, WorkflowRunCancelResponseWorkflowRun.IdStage, WorkflowRunCancelResponseWorkflowRun.InitialRunAtStage, WorkflowRunCancelResponseWorkflowRun.NameStage, WorkflowRunCancelResponseWorkflowRun.ObjectStage, WorkflowRunCancelResponseWorkflowRun.ReviewedStage, WorkflowRunCancelResponseWorkflowRun.UrlStage, WorkflowRunCancelResponseWorkflowRun.WorkflowStage

Enclosing class:

WorkflowRunCancelResponseWorkflowRun

public static final class WorkflowRunCancelResponseWorkflowRun.Builder
extends java.lang.Object
implements WorkflowRunCancelResponseWorkflowRun.ObjectStage, WorkflowRunCancelResponseWorkflowRun.IdStage, WorkflowRunCancelResponseWorkflowRun.NameStage, WorkflowRunCancelResponseWorkflowRun.UrlStage, WorkflowRunCancelResponseWorkflowRun.InitialRunAtStage, WorkflowRunCancelResponseWorkflowRun.ReviewedStage, WorkflowRunCancelResponseWorkflowRun.WorkflowStage, WorkflowRunCancelResponseWorkflowRun._FinalStage

Method Summary

Modifier and Type	Method	Description
WorkflowRunCancelResponseWorkflowRun._FinalStage	addAllFiles(java.util.List<File> files)
WorkflowRunCancelResponseWorkflowRun._FinalStage	addAllOutputs(java.util.List<ProcessorRun> outputs)
WorkflowRunCancelResponseWorkflowRun._FinalStage	addAllStepRuns(java.util.List<StepRun> stepRuns)	An array of WorkflowStepRun objects.
WorkflowRunCancelResponseWorkflowRun._FinalStage	addFiles(File files)
WorkflowRunCancelResponseWorkflowRun._FinalStage	addOutputs(ProcessorRun outputs)
WorkflowRunCancelResponseWorkflowRun._FinalStage	addStepRuns(StepRun stepRuns)	An array of WorkflowStepRun objects.
WorkflowRunCancelResponseWorkflowRun._FinalStage	batchId(java.lang.String batchId)	The batch ID of the WorkflowRun.
WorkflowRunCancelResponseWorkflowRun._FinalStage	batchId(java.util.Optional<java.lang.String> batchId)	The batch ID of the WorkflowRun.
WorkflowRunCancelResponseWorkflowRun	build()
WorkflowRunCancelResponseWorkflowRun._FinalStage	endTime(java.time.OffsetDateTime endTime)	The time (in UTC) that the workflow finished executing.
WorkflowRunCancelResponseWorkflowRun._FinalStage	endTime(java.util.Optional<java.time.OffsetDateTime> endTime)	The time (in UTC) that the workflow finished executing.
WorkflowRunCancelResponseWorkflowRun._FinalStage	failureMessage(java.lang.String failureMessage)	A more detailed message about the failure.
WorkflowRunCancelResponseWorkflowRun._FinalStage	failureMessage(java.util.Optional<java.lang.String> failureMessage)	A more detailed message about the failure.
WorkflowRunCancelResponseWorkflowRun._FinalStage	failureReason(java.lang.String failureReason)	The reason why the workflow run failed.
WorkflowRunCancelResponseWorkflowRun._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason why the workflow run failed.
WorkflowRunCancelResponseWorkflowRun._FinalStage	files(java.util.List<File> files)
WorkflowRunCancelResponseWorkflowRun.Builder	from(WorkflowRunCancelResponseWorkflowRun other)
WorkflowRunCancelResponseWorkflowRun.NameStage	id(java.lang.String id)	The ID of the workflow run.
WorkflowRunCancelResponseWorkflowRun.ReviewedStage	initialRunAt(java.time.OffsetDateTime initialRunAt)	The time (in UTC) at which the workflow run was created.
WorkflowRunCancelResponseWorkflowRun._FinalStage	metadata(java.lang.String key, java.lang.Object value)	The metadata that was passed in when running the Workflow.
WorkflowRunCancelResponseWorkflowRun._FinalStage	metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)	The metadata that was passed in when running the Workflow.
WorkflowRunCancelResponseWorkflowRun.UrlStage	name(java.lang.String name)	The name of the workflow run.
WorkflowRunCancelResponseWorkflowRun.IdStage	object(java.lang.String object)	The type of response.
WorkflowRunCancelResponseWorkflowRun._FinalStage	outputs(java.util.List<ProcessorRun> outputs)
WorkflowRunCancelResponseWorkflowRun._FinalStage	putAllMetadata(java.util.Map<java.lang.String,java.lang.Object> metadata)	The metadata that was passed in when running the Workflow.
WorkflowRunCancelResponseWorkflowRun._FinalStage	rejectionNote(java.lang.String rejectionNote)	A note that is added if a workflow run is rejected.
WorkflowRunCancelResponseWorkflowRun._FinalStage	rejectionNote(java.util.Optional<java.lang.String> rejectionNote)	A note that is added if a workflow run is rejected.
WorkflowRunCancelResponseWorkflowRun.WorkflowStage	reviewed(boolean reviewed)	Whether the workflow run has been reviewed.
WorkflowRunCancelResponseWorkflowRun._FinalStage	reviewedAt(java.time.OffsetDateTime reviewedAt)	The time (in UTC) at which the workflow run was reviewed.
WorkflowRunCancelResponseWorkflowRun._FinalStage	reviewedAt(java.util.Optional<java.time.OffsetDateTime> reviewedAt)	The time (in UTC) at which the workflow run was reviewed.
WorkflowRunCancelResponseWorkflowRun._FinalStage	reviewedBy(java.lang.String reviewedBy)	The email address of the person who reviewed the workflow run.
WorkflowRunCancelResponseWorkflowRun._FinalStage	reviewedBy(java.util.Optional<java.lang.String> reviewedBy)	The email address of the person who reviewed the workflow run.
WorkflowRunCancelResponseWorkflowRun._FinalStage	startTime(java.time.OffsetDateTime startTime)	The time (in UTC) at which the workflow run started executing.
WorkflowRunCancelResponseWorkflowRun._FinalStage	startTime(java.util.Optional<java.time.OffsetDateTime> startTime)	The time (in UTC) at which the workflow run started executing.
WorkflowRunCancelResponseWorkflowRun._FinalStage	status(java.lang.String status)
WorkflowRunCancelResponseWorkflowRun._FinalStage	status(java.util.Optional<java.lang.String> status)
WorkflowRunCancelResponseWorkflowRun._FinalStage	stepRuns(java.util.List<StepRun> stepRuns)	An array of WorkflowStepRun objects.
WorkflowRunCancelResponseWorkflowRun.InitialRunAtStage	url(java.lang.String url)	A URL to view this workflow run in the Extend UI.
WorkflowRunCancelResponseWorkflowRun._FinalStage	usage(WorkflowRunCredits usage)
WorkflowRunCancelResponseWorkflowRun._FinalStage	usage(java.util.Optional<WorkflowRunCredits> usage)
WorkflowRunCancelResponseWorkflowRun._FinalStage	workflow(Workflow workflow)

Methods inherited from class java.lang.Object

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

Method Detail

from

public WorkflowRunCancelResponseWorkflowRun.Builder from(WorkflowRunCancelResponseWorkflowRun other)

Specified by:

from in interface WorkflowRunCancelResponseWorkflowRun.ObjectStage

object

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

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

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

Specified by:

object in interface WorkflowRunCancelResponseWorkflowRun.ObjectStage

Returns:

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

id

public WorkflowRunCancelResponseWorkflowRun.NameStage id(@NotNull
                                                         java.lang.String id)

The ID of the workflow run.

Example: "workflow_run_xKm9pNv3qWsY_jL2tR5Dh"

The ID of the workflow run.

Example: "workflow_run_xKm9pNv3qWsY_jL2tR5Dh"

Specified by:

id in interface WorkflowRunCancelResponseWorkflowRun.IdStage

Returns:

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

name

public WorkflowRunCancelResponseWorkflowRun.UrlStage name(@NotNull
                                                          java.lang.String name)

The name of the workflow run.

Example: "myFirstFile.pdf"

The name of the workflow run.

Example: "myFirstFile.pdf"

Specified by:

name in interface WorkflowRunCancelResponseWorkflowRun.NameStage

Returns:

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

url

public WorkflowRunCancelResponseWorkflowRun.InitialRunAtStage url(@NotNull
                                                                  java.lang.String url)

A URL to view this workflow run in the Extend UI.

Example: "https://dashboard.extend.ai/workflows/workflow_Bk9mNp2qWs5_xL8vR4tYh?workflowRunId=workflow_run_Zj3nMx7ZPd9f4c2WQ_kAg"

A URL to view this workflow run in the Extend UI.

Example: "https://dashboard.extend.ai/workflows/workflow_Bk9mNp2qWs5_xL8vR4tYh?workflowRunId=workflow_run_Zj3nMx7ZPd9f4c2WQ_kAg"

Specified by:

url in interface WorkflowRunCancelResponseWorkflowRun.UrlStage

Returns:

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

initialRunAt

public WorkflowRunCancelResponseWorkflowRun.ReviewedStage initialRunAt(@NotNull
                                                                       java.time.OffsetDateTime initialRunAt)

The time (in UTC) at which the workflow run was created. Will follow the RFC 3339 format.

Example: "2025-04-28T17:01:39.285Z"

The time (in UTC) at which the workflow run was created. Will follow the RFC 3339 format.

Example: "2025-04-28T17:01:39.285Z"

Specified by:

initialRunAt in interface WorkflowRunCancelResponseWorkflowRun.InitialRunAtStage

Returns:

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

reviewed

public WorkflowRunCancelResponseWorkflowRun.WorkflowStage reviewed(boolean reviewed)

Whether the workflow run has been reviewed.

Whether the workflow run has been reviewed.

Specified by:

reviewed in interface WorkflowRunCancelResponseWorkflowRun.ReviewedStage

Returns:

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

workflow

public WorkflowRunCancelResponseWorkflowRun._FinalStage workflow(@NotNull
                                                                 Workflow workflow)

Specified by:

workflow in interface WorkflowRunCancelResponseWorkflowRun.WorkflowStage

usage

public WorkflowRunCancelResponseWorkflowRun._FinalStage usage(WorkflowRunCredits usage)

Specified by:

usage in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

usage

public WorkflowRunCancelResponseWorkflowRun._FinalStage usage(java.util.Optional<WorkflowRunCredits> usage)

Specified by:

usage in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

addAllStepRuns

public WorkflowRunCancelResponseWorkflowRun._FinalStage addAllStepRuns(java.util.List<StepRun> stepRuns)

An array of WorkflowStepRun objects. Each WorkflowStepRun represents a single run of a WorkflowStep and contains details about the step and the run's output.

Note: This field currently supports External Data Validation and Rule Validation step types. Document processor run outputs are included in the outputs field.

Specified by:

addAllStepRuns in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

Returns:

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

addStepRuns

public WorkflowRunCancelResponseWorkflowRun._FinalStage addStepRuns(StepRun stepRuns)

An array of WorkflowStepRun objects. Each WorkflowStepRun represents a single run of a WorkflowStep and contains details about the step and the run's output.

Note: This field currently supports External Data Validation and Rule Validation step types. Document processor run outputs are included in the outputs field.

Specified by:

addStepRuns in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

Returns:

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

stepRuns

public WorkflowRunCancelResponseWorkflowRun._FinalStage stepRuns(java.util.List<StepRun> stepRuns)

An array of WorkflowStepRun objects. Each WorkflowStepRun represents a single run of a WorkflowStep and contains details about the step and the run's output.

Note: This field currently supports External Data Validation and Rule Validation step types. Document processor run outputs are included in the outputs field.

Specified by:

stepRuns in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

addAllOutputs

public WorkflowRunCancelResponseWorkflowRun._FinalStage addAllOutputs(java.util.List<ProcessorRun> outputs)

Specified by:

addAllOutputs in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

addOutputs

public WorkflowRunCancelResponseWorkflowRun._FinalStage addOutputs(ProcessorRun outputs)

Specified by:

addOutputs in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

outputs

public WorkflowRunCancelResponseWorkflowRun._FinalStage outputs(java.util.List<ProcessorRun> outputs)

Specified by:

outputs in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

endTime

public WorkflowRunCancelResponseWorkflowRun._FinalStage endTime(java.time.OffsetDateTime endTime)

The time (in UTC) that the workflow finished executing. Will follow the RFC 3339 format. Will not be included if the workflow run has not finished executing.

Example: "2024-03-21T15:35:00Z"

Specified by:

endTime in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

Returns:

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

endTime

public WorkflowRunCancelResponseWorkflowRun._FinalStage endTime(java.util.Optional<java.time.OffsetDateTime> endTime)

The time (in UTC) that the workflow finished executing. Will follow the RFC 3339 format. Will not be included if the workflow run has not finished executing.

Example: "2024-03-21T15:35:00Z"

Specified by:

endTime in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

startTime

public WorkflowRunCancelResponseWorkflowRun._FinalStage startTime(java.time.OffsetDateTime startTime)

The time (in UTC) at which the workflow run started executing. This will always be after the initialRunAt time. Will follow the RFC 3339 format. Will not be included if the workflow run has not started executing.

Example: "2024-03-21T15:30:00Z"

Specified by:

startTime in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

Returns:

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

startTime

public WorkflowRunCancelResponseWorkflowRun._FinalStage startTime(java.util.Optional<java.time.OffsetDateTime> startTime)

The time (in UTC) at which the workflow run started executing. This will always be after the initialRunAt time. Will follow the RFC 3339 format. Will not be included if the workflow run has not started executing.

Example: "2024-03-21T15:30:00Z"

Specified by:

startTime in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

reviewedAt

public WorkflowRunCancelResponseWorkflowRun._FinalStage reviewedAt(java.time.OffsetDateTime reviewedAt)

The time (in UTC) at which the workflow run was reviewed. Will follow the RFC 3339 format. Will not be included if the workflow run has not been reviewed.

Example: "2024-03-21T16:45:00Z"

Specified by:

reviewedAt in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

Returns:

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

reviewedAt

public WorkflowRunCancelResponseWorkflowRun._FinalStage reviewedAt(java.util.Optional<java.time.OffsetDateTime> reviewedAt)

The time (in UTC) at which the workflow run was reviewed. Will follow the RFC 3339 format. Will not be included if the workflow run has not been reviewed.

Example: "2024-03-21T16:45:00Z"

Specified by:

reviewedAt in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

rejectionNote

public WorkflowRunCancelResponseWorkflowRun._FinalStage rejectionNote(java.lang.String rejectionNote)

A note that is added if a workflow run is rejected.

Example: "Invalid invoice format"

Specified by:

rejectionNote in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

Returns:

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

rejectionNote

public WorkflowRunCancelResponseWorkflowRun._FinalStage rejectionNote(java.util.Optional<java.lang.String> rejectionNote)

A note that is added if a workflow run is rejected.

Example: "Invalid invoice format"

Specified by:

rejectionNote in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

reviewedBy

public WorkflowRunCancelResponseWorkflowRun._FinalStage reviewedBy(java.lang.String reviewedBy)

The email address of the person who reviewed the workflow run. Will not be included if the workflow run has not been reviewed.

Example: "jane.doe@example.com"

Specified by:

reviewedBy in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

Returns:

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

reviewedBy

public WorkflowRunCancelResponseWorkflowRun._FinalStage reviewedBy(java.util.Optional<java.lang.String> reviewedBy)

The email address of the person who reviewed the workflow run. Will not be included if the workflow run has not been reviewed.

Example: "jane.doe@example.com"

Specified by:

reviewedBy in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

failureMessage

public WorkflowRunCancelResponseWorkflowRun._FinalStage failureMessage(java.lang.String failureMessage)

A more detailed message about the failure. Will only be included if the workflow run status is "FAILED".

Specified by:

failureMessage in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

Returns:

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

failureMessage

public WorkflowRunCancelResponseWorkflowRun._FinalStage failureMessage(java.util.Optional<java.lang.String> failureMessage)

A more detailed message about the failure. Will only be included if the workflow run status is "FAILED".

Specified by:

failureMessage in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

failureReason

public WorkflowRunCancelResponseWorkflowRun._FinalStage failureReason(java.lang.String failureReason)

The reason why the workflow run failed. Will only be included if the workflow run status is "FAILED".

Specified by:

failureReason in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

Returns:

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

failureReason

public WorkflowRunCancelResponseWorkflowRun._FinalStage failureReason(java.util.Optional<java.lang.String> failureReason)

The reason why the workflow run failed. Will only be included if the workflow run status is "FAILED".

Specified by:

failureReason in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

addAllFiles

public WorkflowRunCancelResponseWorkflowRun._FinalStage addAllFiles(java.util.List<File> files)

Specified by:

addAllFiles in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

addFiles

public WorkflowRunCancelResponseWorkflowRun._FinalStage addFiles(File files)

Specified by:

addFiles in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

files

public WorkflowRunCancelResponseWorkflowRun._FinalStage files(java.util.List<File> files)

Specified by:

files in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

batchId

public WorkflowRunCancelResponseWorkflowRun._FinalStage batchId(java.lang.String batchId)

The batch ID of the WorkflowRun. If this WorkflowRun was created as part of a batch of files, all runs in that batch will have the same batch ID.

Example: "batch_7Ws31-F5"

Specified by:

batchId in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

Returns:

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

batchId

public WorkflowRunCancelResponseWorkflowRun._FinalStage batchId(java.util.Optional<java.lang.String> batchId)

The batch ID of the WorkflowRun. If this WorkflowRun was created as part of a batch of files, all runs in that batch will have the same batch ID.

Example: "batch_7Ws31-F5"

Specified by:

batchId in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

metadata

public WorkflowRunCancelResponseWorkflowRun._FinalStage metadata(java.lang.String key,
                                                                 java.lang.Object value)

The metadata that was passed in when running the Workflow.

Specified by:

metadata in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

Returns:

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

putAllMetadata

public WorkflowRunCancelResponseWorkflowRun._FinalStage putAllMetadata(java.util.Map<java.lang.String,java.lang.Object> metadata)

The metadata that was passed in when running the Workflow.

Specified by:

putAllMetadata in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

Returns:

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

metadata

public WorkflowRunCancelResponseWorkflowRun._FinalStage metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)

The metadata that was passed in when running the Workflow.

Specified by:

metadata in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

status

public WorkflowRunCancelResponseWorkflowRun._FinalStage status(java.lang.String status)

Specified by:

status in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

status

public WorkflowRunCancelResponseWorkflowRun._FinalStage status(java.util.Optional<java.lang.String> status)

Specified by:

status in interface WorkflowRunCancelResponseWorkflowRun._FinalStage

build

public WorkflowRunCancelResponseWorkflowRun build()

Specified by:

build in interface WorkflowRunCancelResponseWorkflowRun._FinalStage