Package ai.extend.types

Class WorkflowReference.Builder

java.lang.Object

ai.extend.types.WorkflowReference.Builder

All Implemented Interfaces:

WorkflowReference._FinalStage, WorkflowReference.IdStage

Enclosing class:

WorkflowReference

public static final class WorkflowReference.Builder
extends java.lang.Object
implements WorkflowReference.IdStage, WorkflowReference._FinalStage

Method Summary

Modifier and Type	Method	Description
WorkflowReference	build()
WorkflowReference.Builder	from(WorkflowReference other)
WorkflowReference._FinalStage	id(java.lang.String id)	The ID of the workflow.
WorkflowReference._FinalStage	version(java.lang.String version)	An optional version of the workflow that files will be run through.
WorkflowReference._FinalStage	version(java.util.Optional<java.lang.String> version)	An optional version of the workflow that files will be run through.

Methods inherited from class java.lang.Object

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

Method Detail

from

public WorkflowReference.Builder from(WorkflowReference other)

Specified by:

from in interface WorkflowReference.IdStage

id

public WorkflowReference._FinalStage id(@NotNull
                                        java.lang.String id)

The ID of the workflow.

Example: "workflow_BMdfq_yWM3sT-ZzvCnA3f"

The ID of the workflow.

Example: "workflow_BMdfq_yWM3sT-ZzvCnA3f"

Specified by:

id in interface WorkflowReference.IdStage

Returns:

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

version

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

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

Specified by:

version in interface WorkflowReference._FinalStage

Returns:

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

version

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

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

Specified by:

version in interface WorkflowReference._FinalStage

build

public WorkflowReference build()

Specified by:

build in interface WorkflowReference._FinalStage