Package ai.extend.resources.workflowrun

Class RawWorkflowRunClient

java.lang.Object

ai.extend.resources.workflowrun.RawWorkflowRunClient

public class RawWorkflowRunClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawWorkflowRunClient(ClientOptions clientOptions)

Method Summary

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

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

RawWorkflowRunClient

public RawWorkflowRunClient(ClientOptions clientOptions)

Method Detail

list

public ExtendClientHttpResponse<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 ExtendClientHttpResponse<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 ExtendClientHttpResponse<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 ExtendClientHttpResponse<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 ExtendClientHttpResponse<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 ExtendClientHttpResponse<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 ExtendClientHttpResponse<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 ExtendClientHttpResponse<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 ExtendClientHttpResponse<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 ExtendClientHttpResponse<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 ExtendClientHttpResponse<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 ExtendClientHttpResponse<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 ExtendClientHttpResponse<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 ExtendClientHttpResponse<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.