Package ai.extend.resources.workflowrun

Class AsyncWorkflowRunClient

java.lang.Object

ai.extend.resources.workflowrun.AsyncWorkflowRunClient

public class AsyncWorkflowRunClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncWorkflowRunClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<WorkflowRunCreateResponse>	create(WorkflowRunCreateRequest request)	Run a Workflow with files.
java.util.concurrent.CompletableFuture<WorkflowRunCreateResponse>	create(WorkflowRunCreateRequest request, RequestOptions requestOptions)	Run a Workflow with files.
java.util.concurrent.CompletableFuture<WorkflowRunDeleteResponse>	delete(java.lang.String workflowRunId)	Delete a workflow run and all associated data from Extend.
java.util.concurrent.CompletableFuture<WorkflowRunDeleteResponse>	delete(java.lang.String workflowRunId, RequestOptions requestOptions)	Delete a workflow run and all associated data from Extend.
java.util.concurrent.CompletableFuture<WorkflowRunGetResponse>	get(java.lang.String workflowRunId)	Once a workflow has been run, you can check the status and output of a specific WorkflowRun.
java.util.concurrent.CompletableFuture<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.
java.util.concurrent.CompletableFuture<WorkflowRunListResponse>	list()	List runs of a Workflow.
java.util.concurrent.CompletableFuture<WorkflowRunListResponse>	list(WorkflowRunListRequest request)	List runs of a Workflow.
java.util.concurrent.CompletableFuture<WorkflowRunListResponse>	list(WorkflowRunListRequest request, RequestOptions requestOptions)	List runs of a Workflow.
java.util.concurrent.CompletableFuture<WorkflowRunUpdateResponse>	update(java.lang.String workflowRunId)	You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.
java.util.concurrent.CompletableFuture<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.
java.util.concurrent.CompletableFuture<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.
AsyncRawWorkflowRunClient	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

AsyncWorkflowRunClient

public AsyncWorkflowRunClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public AsyncRawWorkflowRunClient withRawResponse()

Get responses with HTTP metadata like headers

list

public java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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.