Package ai.extend.resources.workflowrun.requests

Class WorkflowRunCreateRequest

java.lang.Object

ai.extend.resources.workflowrun.requests.WorkflowRunCreateRequest

public final class WorkflowRunCreateRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkflowRunCreateRequest._FinalStage
static class	WorkflowRunCreateRequest.Builder
static interface	WorkflowRunCreateRequest.WorkflowIdStage

Method Summary

Modifier and Type	Method	Description
static WorkflowRunCreateRequest.WorkflowIdStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<java.util.List<WorkflowRunFileInput>>	getFiles()
java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>	getMetadata()
java.util.Optional<java.lang.Integer>	getPriority()
java.util.Optional<java.util.List<java.lang.String>>	getRawTexts()
java.util.Optional<java.lang.String>	getVersion()
java.lang.String	getWorkflowId()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getWorkflowId

public java.lang.String getWorkflowId()

Returns:

The ID of the workflow to run.

Example: "workflow_BMdfq_yWM3sT-ZzvCnA3f"

getFiles

public java.util.Optional<java.util.List<WorkflowRunFileInput>> getFiles()

Returns:

An array of files to process through the workflow. Either the files array or rawTexts array must be provided. Supported file types can be found here. There is a limit if 50 files that can be processed at once using this endpoint. If you wish to process more at a time, consider using the Batch Run Workflow endpoint.

getRawTexts

public java.util.Optional<java.util.List<java.lang.String>> getRawTexts()

Returns:

An array of raw strings. Can be used in place of files when passing raw data. The raw data will be converted to .txt files and run through the workflow. If the data follows a specific format, it is recommended to use the files parameter instead. Either files or rawTexts must be provided.

getVersion

public java.util.Optional<java.lang.String> getVersion()

Returns:

An optional version of the workflow that files will be run through. This number can be found when viewing the workflow on the Extend platform. When a version number is not supplied, the most recent published version of the workflow will be used. If no published versions exist, the draft version will be used. To run the "draft" version of a workflow, use "draft" as the version.

Examples:

• "3" - Run version 3 of the workflow
• "draft" - Run the draft version of the workflow

getPriority

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

Returns:

An optional value used to determine the relative order of WorkflowRuns when rate limiting is in effect. Lower values will be prioritized before higher values.

getMetadata

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

Returns:

A optional metadata object that can be assigned to a specific WorkflowRun to help identify it. It will be returned in the response and webhooks. You can place any arbitrary key : value pairs in this object.

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 WorkflowRunCreateRequest.WorkflowIdStage builder()