Package ai.extend.resources.workflowruns.requests

Class WorkflowRunsCreateRequest

java.lang.Object

ai.extend.resources.workflowruns.requests.WorkflowRunsCreateRequest

public final class WorkflowRunsCreateRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkflowRunsCreateRequest._FinalStage
static class	WorkflowRunsCreateRequest.Builder
static interface	WorkflowRunsCreateRequest.WorkflowStage

Method Summary

Modifier and Type	Method	Description
static WorkflowRunsCreateRequest.WorkflowStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<WorkflowRunsCreateRequestFile>	getFile()
java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>	getMetadata()
java.util.Optional<java.util.List<WorkflowRunsCreateRequestOutputsItem>>	getOutputs()
java.util.Optional<WorkflowRunPackage>	getPackage()
java.util.Optional<java.lang.Integer>	getPriority()
java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>	getSecrets()
WorkflowReference	getWorkflow()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getWorkflow

public WorkflowReference getWorkflow()

getFile

public java.util.Optional<WorkflowRunsCreateRequestFile> getFile()

Returns:

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.

getPackage

public java.util.Optional<WorkflowRunPackage> getPackage()

Returns:

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

getOutputs

public java.util.Optional<java.util.List<WorkflowRunsCreateRequestOutputsItem>> getOutputs()

Returns:

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.

getPriority

public java.util.Optional<java.lang.Integer> getPriority()

getMetadata

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

getSecrets

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

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 WorkflowRunsCreateRequest.WorkflowStage builder()