Package ai.extend.resources.workflowruns.requests

Class WorkflowRunsCreateRequest.Builder

java.lang.Object

ai.extend.resources.workflowruns.requests.WorkflowRunsCreateRequest.Builder

All Implemented Interfaces:

WorkflowRunsCreateRequest._FinalStage, WorkflowRunsCreateRequest.WorkflowStage

Enclosing class:

WorkflowRunsCreateRequest

public static final class WorkflowRunsCreateRequest.Builder
extends java.lang.Object
implements WorkflowRunsCreateRequest.WorkflowStage, WorkflowRunsCreateRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
WorkflowRunsCreateRequest	build()
WorkflowRunsCreateRequest._FinalStage	file(WorkflowRunsCreateRequestFile file)	The file to be processed.
WorkflowRunsCreateRequest._FinalStage	file(java.util.Optional<WorkflowRunsCreateRequestFile> file)	The file to be processed.
WorkflowRunsCreateRequest.Builder	from(WorkflowRunsCreateRequest other)
WorkflowRunsCreateRequest._FinalStage	metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)
WorkflowRunsCreateRequest._FinalStage	metadata(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> metadata)
WorkflowRunsCreateRequest._FinalStage	outputs(java.util.List<WorkflowRunsCreateRequestOutputsItem> outputs)	Predetermined outputs to be used for the workflow run.
WorkflowRunsCreateRequest._FinalStage	outputs(java.util.Optional<java.util.List<WorkflowRunsCreateRequestOutputsItem>> outputs)	Predetermined outputs to be used for the workflow run.
WorkflowRunsCreateRequest._FinalStage	package_(WorkflowRunPackage package_)	A set of 2–50 files to process together in a single workflow run.
WorkflowRunsCreateRequest._FinalStage	package_(java.util.Optional<WorkflowRunPackage> package_)	A set of 2–50 files to process together in a single workflow run.
WorkflowRunsCreateRequest._FinalStage	priority(java.lang.Integer priority)
WorkflowRunsCreateRequest._FinalStage	priority(java.util.Optional<java.lang.Integer> priority)
WorkflowRunsCreateRequest._FinalStage	secrets(java.util.Map<java.lang.String,java.lang.Object> secrets)
WorkflowRunsCreateRequest._FinalStage	secrets(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> secrets)
WorkflowRunsCreateRequest._FinalStage	workflow(WorkflowReference workflow)

Methods inherited from class java.lang.Object

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

Method Detail

from

public WorkflowRunsCreateRequest.Builder from(WorkflowRunsCreateRequest other)

Specified by:

from in interface WorkflowRunsCreateRequest.WorkflowStage

workflow

public WorkflowRunsCreateRequest._FinalStage workflow(@NotNull
                                                      WorkflowReference workflow)

Specified by:

workflow in interface WorkflowRunsCreateRequest.WorkflowStage

secrets

public WorkflowRunsCreateRequest._FinalStage secrets(java.util.Map<java.lang.String,java.lang.Object> secrets)

Specified by:

secrets in interface WorkflowRunsCreateRequest._FinalStage

secrets

public WorkflowRunsCreateRequest._FinalStage secrets(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> secrets)

Specified by:

secrets in interface WorkflowRunsCreateRequest._FinalStage

metadata

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

Specified by:

metadata in interface WorkflowRunsCreateRequest._FinalStage

metadata

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

Specified by:

metadata in interface WorkflowRunsCreateRequest._FinalStage

priority

public WorkflowRunsCreateRequest._FinalStage priority(java.lang.Integer priority)

Specified by:

priority in interface WorkflowRunsCreateRequest._FinalStage

priority

public WorkflowRunsCreateRequest._FinalStage priority(java.util.Optional<java.lang.Integer> priority)

Specified by:

priority in interface WorkflowRunsCreateRequest._FinalStage

outputs

public WorkflowRunsCreateRequest._FinalStage outputs(java.util.List<WorkflowRunsCreateRequestOutputsItem> outputs)

Predetermined outputs to be used for the workflow run. Generally not recommended for most use cases, however, can be useful in cases of overriding a classification in a workflow, or a subset of extraction fields when data is known. Not supported on package runs — a package run produces a single merged result across all files and cannot accept pre-supplied per-processor outputs.

Specified by:

outputs in interface WorkflowRunsCreateRequest._FinalStage

Returns:

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

outputs

public WorkflowRunsCreateRequest._FinalStage outputs(java.util.Optional<java.util.List<WorkflowRunsCreateRequestOutputsItem>> outputs)

Predetermined outputs to be used for the workflow run. Generally not recommended for most use cases, however, can be useful in cases of overriding a classification in a workflow, or a subset of extraction fields when data is known. Not supported on package runs — a package run produces a single merged result across all files and cannot accept pre-supplied per-processor outputs.

Specified by:

outputs in interface WorkflowRunsCreateRequest._FinalStage

package_

public WorkflowRunsCreateRequest._FinalStage package_(WorkflowRunPackage package_)

A set of 2–50 files to process together in a single workflow run. Mutually exclusive with file — provide one or the other.

Specified by:

package_ in interface WorkflowRunsCreateRequest._FinalStage

Returns:

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

package_

public WorkflowRunsCreateRequest._FinalStage package_(java.util.Optional<WorkflowRunPackage> package_)

A set of 2–50 files to process together in a single workflow run. Mutually exclusive with file — provide one or the other.

Specified by:

package_ in interface WorkflowRunsCreateRequest._FinalStage

file

public WorkflowRunsCreateRequest._FinalStage file(WorkflowRunsCreateRequestFile file)

The file to be processed. Supported file types can be found here. Files can be provided as a URL, an Extend file ID, or raw text. Mutually exclusive with package — provide one or the other. If you wish to process many files as independent runs, consider using the Batch Run Workflow endpoint.

Specified by:

file in interface WorkflowRunsCreateRequest._FinalStage

Returns:

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

file

public WorkflowRunsCreateRequest._FinalStage file(java.util.Optional<WorkflowRunsCreateRequestFile> file)

The file to be processed. Supported file types can be found here. Files can be provided as a URL, an Extend file ID, or raw text. Mutually exclusive with package — provide one or the other. If you wish to process many files as independent runs, consider using the Batch Run Workflow endpoint.

Specified by:

file in interface WorkflowRunsCreateRequest._FinalStage

build

public WorkflowRunsCreateRequest build()

Specified by:

build in interface WorkflowRunsCreateRequest._FinalStage