Interface WorkflowRunCancelResponseWorkflowRun._FinalStage
-
- All Known Implementing Classes:
WorkflowRunCancelResponseWorkflowRun.Builder
- Enclosing class:
- WorkflowRunCancelResponseWorkflowRun
public static interface WorkflowRunCancelResponseWorkflowRun._FinalStage
-
-
Method Summary
-
-
-
Method Detail
-
build
WorkflowRunCancelResponseWorkflowRun build()
-
status
WorkflowRunCancelResponseWorkflowRun._FinalStage status(java.util.Optional<java.lang.String> status)
-
status
WorkflowRunCancelResponseWorkflowRun._FinalStage status(java.lang.String status)
-
metadata
WorkflowRunCancelResponseWorkflowRun._FinalStage metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)
The metadata that was passed in when running the Workflow.
-
putAllMetadata
WorkflowRunCancelResponseWorkflowRun._FinalStage putAllMetadata(java.util.Map<java.lang.String,java.lang.Object> metadata)
-
metadata
WorkflowRunCancelResponseWorkflowRun._FinalStage metadata(java.lang.String key, java.lang.Object value)
-
batchId
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"
-
batchId
WorkflowRunCancelResponseWorkflowRun._FinalStage batchId(java.lang.String batchId)
-
files
WorkflowRunCancelResponseWorkflowRun._FinalStage files(java.util.List<File> files)
-
addFiles
WorkflowRunCancelResponseWorkflowRun._FinalStage addFiles(File files)
-
addAllFiles
WorkflowRunCancelResponseWorkflowRun._FinalStage addAllFiles(java.util.List<File> files)
-
failureReason
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".
-
failureReason
WorkflowRunCancelResponseWorkflowRun._FinalStage failureReason(java.lang.String failureReason)
-
failureMessage
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".
-
failureMessage
WorkflowRunCancelResponseWorkflowRun._FinalStage failureMessage(java.lang.String failureMessage)
-
reviewedBy
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"
-
reviewedBy
WorkflowRunCancelResponseWorkflowRun._FinalStage reviewedBy(java.lang.String reviewedBy)
-
rejectionNote
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"
-
rejectionNote
WorkflowRunCancelResponseWorkflowRun._FinalStage rejectionNote(java.lang.String rejectionNote)
-
reviewedAt
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"
-
reviewedAt
WorkflowRunCancelResponseWorkflowRun._FinalStage reviewedAt(java.time.OffsetDateTime reviewedAt)
-
startTime
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
initialRunAttime. Will follow the RFC 3339 format. Will not be included if the workflow run has not started executing.Example:
"2024-03-21T15:30:00Z"
-
startTime
WorkflowRunCancelResponseWorkflowRun._FinalStage startTime(java.time.OffsetDateTime startTime)
-
endTime
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"
-
endTime
WorkflowRunCancelResponseWorkflowRun._FinalStage endTime(java.time.OffsetDateTime endTime)
-
outputs
WorkflowRunCancelResponseWorkflowRun._FinalStage outputs(java.util.List<ProcessorRun> outputs)
-
addOutputs
WorkflowRunCancelResponseWorkflowRun._FinalStage addOutputs(ProcessorRun outputs)
-
addAllOutputs
WorkflowRunCancelResponseWorkflowRun._FinalStage addAllOutputs(java.util.List<ProcessorRun> outputs)
-
stepRuns
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.
-
addStepRuns
WorkflowRunCancelResponseWorkflowRun._FinalStage addStepRuns(StepRun stepRuns)
-
addAllStepRuns
WorkflowRunCancelResponseWorkflowRun._FinalStage addAllStepRuns(java.util.List<StepRun> stepRuns)
-
usage
WorkflowRunCancelResponseWorkflowRun._FinalStage usage(java.util.Optional<WorkflowRunCredits> usage)
-
usage
WorkflowRunCancelResponseWorkflowRun._FinalStage usage(WorkflowRunCredits usage)
-
-