Package ai.extend.types

Interface WorkflowRun._FinalStage

All Known Implementing Classes:

WorkflowRun.Builder

Enclosing class:

WorkflowRun

public static interface WorkflowRun._FinalStage

Method Summary

Modifier and Type	Method	Description
WorkflowRun._FinalStage	addAllFiles(java.util.List<FileSummary> files)
WorkflowRun._FinalStage	addAllStepRuns(java.util.List<StepRun> stepRuns)
WorkflowRun._FinalStage	addFiles(FileSummary files)
WorkflowRun._FinalStage	addStepRuns(StepRun stepRuns)
WorkflowRun._FinalStage	batchId(Nullable<java.lang.String> batchId)
WorkflowRun._FinalStage	batchId(java.lang.String batchId)
WorkflowRun._FinalStage	batchId(java.util.Optional<java.lang.String> batchId)	The batch ID of the WorkflowRun.
WorkflowRun	build()
WorkflowRun._FinalStage	endTime(Nullable<java.time.OffsetDateTime> endTime)
WorkflowRun._FinalStage	endTime(java.time.OffsetDateTime endTime)
WorkflowRun._FinalStage	endTime(java.util.Optional<java.time.OffsetDateTime> endTime)	The time (in UTC) that the workflow finished executing.
WorkflowRun._FinalStage	failureMessage(Nullable<java.lang.String> failureMessage)
WorkflowRun._FinalStage	failureMessage(java.lang.String failureMessage)
WorkflowRun._FinalStage	failureMessage(java.util.Optional<java.lang.String> failureMessage)	A more detailed message about the failure.
WorkflowRun._FinalStage	failureReason(Nullable<java.lang.String> failureReason)
WorkflowRun._FinalStage	failureReason(java.lang.String failureReason)
WorkflowRun._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason why the workflow run failed.
WorkflowRun._FinalStage	files(java.util.List<FileSummary> files)
WorkflowRun._FinalStage	initialRunAt(Nullable<java.time.OffsetDateTime> initialRunAt)
WorkflowRun._FinalStage	initialRunAt(java.time.OffsetDateTime initialRunAt)
WorkflowRun._FinalStage	initialRunAt(java.util.Optional<java.time.OffsetDateTime> initialRunAt)	The time (in UTC) at which the workflow run was created.
WorkflowRun._FinalStage	metadata(java.lang.String key, java.lang.Object value)
WorkflowRun._FinalStage	metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)	The metadata that was passed in when running the Workflow.
WorkflowRun._FinalStage	putAllMetadata(java.util.Map<java.lang.String,java.lang.Object> metadata)
WorkflowRun._FinalStage	rejectionNote(Nullable<java.lang.String> rejectionNote)
WorkflowRun._FinalStage	rejectionNote(java.lang.String rejectionNote)
WorkflowRun._FinalStage	rejectionNote(java.util.Optional<java.lang.String> rejectionNote)	A note that is added if a workflow run is rejected.
WorkflowRun._FinalStage	reviewedAt(Nullable<java.time.OffsetDateTime> reviewedAt)
WorkflowRun._FinalStage	reviewedAt(java.time.OffsetDateTime reviewedAt)
WorkflowRun._FinalStage	reviewedAt(java.util.Optional<java.time.OffsetDateTime> reviewedAt)	The time (in UTC) at which the workflow run was reviewed.
WorkflowRun._FinalStage	reviewedByUser(Nullable<java.lang.String> reviewedByUser)
WorkflowRun._FinalStage	reviewedByUser(java.lang.String reviewedByUser)
WorkflowRun._FinalStage	reviewedByUser(java.util.Optional<java.lang.String> reviewedByUser)	The email address of the person who reviewed the workflow run.
WorkflowRun._FinalStage	startTime(Nullable<java.time.OffsetDateTime> startTime)
WorkflowRun._FinalStage	startTime(java.time.OffsetDateTime startTime)
WorkflowRun._FinalStage	startTime(java.util.Optional<java.time.OffsetDateTime> startTime)	The time (in UTC) at which the workflow run started executing.
WorkflowRun._FinalStage	stepRuns(java.util.List<StepRun> stepRuns)	An array of WorkflowStepRun objects.
WorkflowRun._FinalStage	usage(Nullable<RunUsage> usage)
WorkflowRun._FinalStage	usage(RunUsage usage)
WorkflowRun._FinalStage	usage(java.util.Optional<RunUsage> usage)	Usage credits consumed by this workflow run, including a breakdown of every contributing child run.

Method Detail

build

WorkflowRun build()

metadata

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

The metadata that was passed in when running the Workflow.

putAllMetadata

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

metadata

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

batchId

WorkflowRun._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"

batchId

WorkflowRun._FinalStage batchId(java.lang.String batchId)

batchId

WorkflowRun._FinalStage batchId(Nullable<java.lang.String> batchId)

files

WorkflowRun._FinalStage files(java.util.List<FileSummary> files)

addFiles

WorkflowRun._FinalStage addFiles(FileSummary files)

addAllFiles

WorkflowRun._FinalStage addAllFiles(java.util.List<FileSummary> files)

failureReason

WorkflowRun._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".

failureReason

WorkflowRun._FinalStage failureReason(java.lang.String failureReason)

failureReason

WorkflowRun._FinalStage failureReason(Nullable<java.lang.String> failureReason)

failureMessage

WorkflowRun._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".

failureMessage

WorkflowRun._FinalStage failureMessage(java.lang.String failureMessage)

failureMessage

WorkflowRun._FinalStage failureMessage(Nullable<java.lang.String> failureMessage)

initialRunAt

WorkflowRun._FinalStage initialRunAt(java.util.Optional<java.time.OffsetDateTime> initialRunAt)

The time (in UTC) at which the workflow run was created. Will follow the RFC 3339 format. Will be null if the run hasn't started yet.

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

initialRunAt

WorkflowRun._FinalStage initialRunAt(java.time.OffsetDateTime initialRunAt)

initialRunAt

WorkflowRun._FinalStage initialRunAt(Nullable<java.time.OffsetDateTime> initialRunAt)

reviewedByUser

WorkflowRun._FinalStage reviewedByUser(java.util.Optional<java.lang.String> reviewedByUser)

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

Example: "jane.doe@example.com"

reviewedByUser

WorkflowRun._FinalStage reviewedByUser(java.lang.String reviewedByUser)

reviewedByUser

WorkflowRun._FinalStage reviewedByUser(Nullable<java.lang.String> reviewedByUser)

rejectionNote

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

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

Example: "Invalid invoice format"

rejectionNote

WorkflowRun._FinalStage rejectionNote(java.lang.String rejectionNote)

rejectionNote

WorkflowRun._FinalStage rejectionNote(Nullable<java.lang.String> rejectionNote)

reviewedAt

WorkflowRun._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 be null if the workflow run has not been reviewed.

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

reviewedAt

WorkflowRun._FinalStage reviewedAt(java.time.OffsetDateTime reviewedAt)

reviewedAt

WorkflowRun._FinalStage reviewedAt(Nullable<java.time.OffsetDateTime> reviewedAt)

startTime

WorkflowRun._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 be null if the workflow run has not started executing.

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

startTime

WorkflowRun._FinalStage startTime(java.time.OffsetDateTime startTime)

startTime

WorkflowRun._FinalStage startTime(Nullable<java.time.OffsetDateTime> startTime)

endTime

WorkflowRun._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 be null if the workflow run has not finished executing.

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

endTime

WorkflowRun._FinalStage endTime(java.time.OffsetDateTime endTime)

endTime

WorkflowRun._FinalStage endTime(Nullable<java.time.OffsetDateTime> endTime)

stepRuns

WorkflowRun._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's execution and result.

addStepRuns

WorkflowRun._FinalStage addStepRuns(StepRun stepRuns)

addAllStepRuns

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

usage

WorkflowRun._FinalStage usage(java.util.Optional<RunUsage> usage)

Usage credits consumed by this workflow run, including a breakdown of every contributing child run.

Availability: Will not be returned for runs created before October 7, 2025 or for customers on legacy billing systems.

usage

WorkflowRun._FinalStage usage(RunUsage usage)

usage

WorkflowRun._FinalStage usage(Nullable<RunUsage> usage)