Package ai.extend.resources.batchworkflowrun.requests

Class BatchWorkflowRunCreateRequest.Builder

java.lang.Object

ai.extend.resources.batchworkflowrun.requests.BatchWorkflowRunCreateRequest.Builder

All Implemented Interfaces:

BatchWorkflowRunCreateRequest._FinalStage, BatchWorkflowRunCreateRequest.WorkflowIdStage

Enclosing class:

BatchWorkflowRunCreateRequest

public static final class BatchWorkflowRunCreateRequest.Builder
extends java.lang.Object
implements BatchWorkflowRunCreateRequest.WorkflowIdStage, BatchWorkflowRunCreateRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
BatchWorkflowRunCreateRequest._FinalStage	addAllInputs(java.util.List<BatchWorkflowRunCreateRequestInputsItem> inputs)	An array of input objects to be processed by the workflow.
BatchWorkflowRunCreateRequest._FinalStage	addInputs(BatchWorkflowRunCreateRequestInputsItem inputs)	An array of input objects to be processed by the workflow.
BatchWorkflowRunCreateRequest	build()
BatchWorkflowRunCreateRequest.Builder	from(BatchWorkflowRunCreateRequest other)
BatchWorkflowRunCreateRequest._FinalStage	inputs(java.util.List<BatchWorkflowRunCreateRequestInputsItem> inputs)	An array of input objects to be processed by the workflow.
BatchWorkflowRunCreateRequest._FinalStage	version(java.lang.String version)	An optional version of the workflow to use.
BatchWorkflowRunCreateRequest._FinalStage	version(java.util.Optional<java.lang.String> version)	An optional version of the workflow to use.
BatchWorkflowRunCreateRequest._FinalStage	workflowId(java.lang.String workflowId)	The ID of the workflow to run.

Methods inherited from class java.lang.Object

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

Method Detail

from

public BatchWorkflowRunCreateRequest.Builder from(BatchWorkflowRunCreateRequest other)

Specified by:

from in interface BatchWorkflowRunCreateRequest.WorkflowIdStage

workflowId

public BatchWorkflowRunCreateRequest._FinalStage workflowId(@NotNull
                                                            java.lang.String workflowId)

The ID of the workflow to run. This ID will start with "workflow_". This ID can be found viewing the workflow on the Extend platform.

Example: "workflow_BMdfq_yWM3sT-ZzvCnA3f"

The ID of the workflow to run. This ID will start with "workflow_". This ID can be found viewing the workflow on the Extend platform.

Example: "workflow_BMdfq_yWM3sT-ZzvCnA3f"

Specified by:

workflowId in interface BatchWorkflowRunCreateRequest.WorkflowIdStage

Returns:

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

addAllInputs

public BatchWorkflowRunCreateRequest._FinalStage addAllInputs(java.util.List<BatchWorkflowRunCreateRequestInputsItem> inputs)

An array of input objects to be processed by the workflow. Each object represents a single workflow run to be created. The array must contain at least 1 input and at most 1000 inputs.

Specified by:

addAllInputs in interface BatchWorkflowRunCreateRequest._FinalStage

Returns:

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

addInputs

public BatchWorkflowRunCreateRequest._FinalStage addInputs(BatchWorkflowRunCreateRequestInputsItem inputs)

An array of input objects to be processed by the workflow. Each object represents a single workflow run to be created. The array must contain at least 1 input and at most 1000 inputs.

Specified by:

addInputs in interface BatchWorkflowRunCreateRequest._FinalStage

Returns:

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

inputs

public BatchWorkflowRunCreateRequest._FinalStage inputs(java.util.List<BatchWorkflowRunCreateRequestInputsItem> inputs)

An array of input objects to be processed by the workflow. Each object represents a single workflow run to be created. The array must contain at least 1 input and at most 1000 inputs.

Specified by:

inputs in interface BatchWorkflowRunCreateRequest._FinalStage

version

public BatchWorkflowRunCreateRequest._FinalStage version(java.lang.String version)

An optional version of the workflow to use. This can be a specific version number (e.g., "1", "2") found on the Extend platform, or "draft" to use the current unpublished draft version. When a version is not supplied, the latest deployed version of the workflow will be used. If no deployed version exists, the draft version will be used.

Specified by:

version in interface BatchWorkflowRunCreateRequest._FinalStage

Returns:

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

version

public BatchWorkflowRunCreateRequest._FinalStage version(java.util.Optional<java.lang.String> version)

An optional version of the workflow to use. This can be a specific version number (e.g., "1", "2") found on the Extend platform, or "draft" to use the current unpublished draft version. When a version is not supplied, the latest deployed version of the workflow will be used. If no deployed version exists, the draft version will be used.

Specified by:

version in interface BatchWorkflowRunCreateRequest._FinalStage

build

public BatchWorkflowRunCreateRequest build()

Specified by:

build in interface BatchWorkflowRunCreateRequest._FinalStage