Package ai.extend.resources.workflowrun

Class WorkflowRunClient

java.lang.Object

ai.extend.resources.workflowrun.WorkflowRunClient

public class WorkflowRunClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
WorkflowRunClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
WorkflowRunCancelResponse	cancel(java.lang.String workflowRunId)	Cancel a running workflow run by its ID.
WorkflowRunCancelResponse	cancel(java.lang.String workflowRunId, RequestOptions requestOptions)	Cancel a running workflow run by its ID.
WorkflowRunCreateResponse	create(WorkflowRunCreateRequest request)	Run a Workflow with files.
WorkflowRunCreateResponse	create(WorkflowRunCreateRequest request, RequestOptions requestOptions)	Run a Workflow with files.
WorkflowRunDeleteResponse	delete(java.lang.String workflowRunId)	Delete a workflow run and all associated data from Extend.
WorkflowRunDeleteResponse	delete(java.lang.String workflowRunId, RequestOptions requestOptions)	Delete a workflow run and all associated data from Extend.
WorkflowRunGetResponse	get(java.lang.String workflowRunId)	Once a workflow has been run, you can check the status and output of a specific WorkflowRun.
WorkflowRunGetResponse	get(java.lang.String workflowRunId, RequestOptions requestOptions)	Once a workflow has been run, you can check the status and output of a specific WorkflowRun.
WorkflowRunListResponse	list()	List runs of a Workflow.
WorkflowRunListResponse	list(WorkflowRunListRequest request)	List runs of a Workflow.
WorkflowRunListResponse	list(WorkflowRunListRequest request, RequestOptions requestOptions)	List runs of a Workflow.
WorkflowRunUpdateResponse	update(java.lang.String workflowRunId)	You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.
WorkflowRunUpdateResponse	update(java.lang.String workflowRunId, WorkflowRunUpdateRequest request)	You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.
WorkflowRunUpdateResponse	update(java.lang.String workflowRunId, WorkflowRunUpdateRequest request, RequestOptions requestOptions)	You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.
RawWorkflowRunClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

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

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

WorkflowRunClient

public WorkflowRunClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawWorkflowRunClient withRawResponse()

Get responses with HTTP metadata like headers

list

public WorkflowRunListResponse list()

List runs of a Workflow. Workflows are sequences of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun represents a single execution of a workflow against a file.

list

public WorkflowRunListResponse list(WorkflowRunListRequest request)

List runs of a Workflow. Workflows are sequences of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun represents a single execution of a workflow against a file.

list

public WorkflowRunListResponse list(WorkflowRunListRequest request,
                                    RequestOptions requestOptions)

List runs of a Workflow. Workflows are sequences of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun represents a single execution of a workflow against a file.

create

public WorkflowRunCreateResponse create(WorkflowRunCreateRequest request)

Run a Workflow with files. A Workflow is a sequence of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun will be created for each file processed. A WorkflowRun represents a single execution of a workflow against a file.

create

public WorkflowRunCreateResponse create(WorkflowRunCreateRequest request,
                                        RequestOptions requestOptions)

Run a Workflow with files. A Workflow is a sequence of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun will be created for each file processed. A WorkflowRun represents a single execution of a workflow against a file.

get

public WorkflowRunGetResponse get(java.lang.String workflowRunId)

Once a workflow has been run, you can check the status and output of a specific WorkflowRun.

get

public WorkflowRunGetResponse get(java.lang.String workflowRunId,
                                  RequestOptions requestOptions)

Once a workflow has been run, you can check the status and output of a specific WorkflowRun.

update

public WorkflowRunUpdateResponse update(java.lang.String workflowRunId)

You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.

update

public WorkflowRunUpdateResponse update(java.lang.String workflowRunId,
                                        WorkflowRunUpdateRequest request)

You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.

update

public WorkflowRunUpdateResponse update(java.lang.String workflowRunId,
                                        WorkflowRunUpdateRequest request,
                                        RequestOptions requestOptions)

You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.

delete

public WorkflowRunDeleteResponse delete(java.lang.String workflowRunId)

Delete a workflow run and all associated data from Extend. This operation is permanent and cannot be undone.

This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.

delete

public WorkflowRunDeleteResponse delete(java.lang.String workflowRunId,
                                        RequestOptions requestOptions)

Delete a workflow run and all associated data from Extend. This operation is permanent and cannot be undone.

This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.

cancel

public WorkflowRunCancelResponse cancel(java.lang.String workflowRunId)

Cancel a running workflow run by its ID. This endpoint allows you to stop a workflow run that is currently in progress.

Note: Only workflow runs with a status of PROCESSING or PENDING can be cancelled. Workflow runs that are completed, failed, in review, rejected, or already cancelled cannot be cancelled.

cancel

public WorkflowRunCancelResponse cancel(java.lang.String workflowRunId,
                                        RequestOptions requestOptions)

Cancel a running workflow run by its ID. This endpoint allows you to stop a workflow run that is currently in progress.

Note: Only workflow runs with a status of PROCESSING or PENDING can be cancelled. Workflow runs that are completed, failed, in review, rejected, or already cancelled cannot be cancelled.