Package ai.extend.resources.workflowrun.requests

Class WorkflowRunListRequest.Builder

java.lang.Object

ai.extend.resources.workflowrun.requests.WorkflowRunListRequest.Builder

Enclosing class:

WorkflowRunListRequest

public static final class WorkflowRunListRequest.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
WorkflowRunListRequest.Builder	batchId(java.lang.String batchId)
WorkflowRunListRequest.Builder	batchId(java.util.Optional<java.lang.String> batchId)	Filters workflow runs by the batch ID.
WorkflowRunListRequest	build()
WorkflowRunListRequest.Builder	fileNameContains(java.lang.String fileNameContains)
WorkflowRunListRequest.Builder	fileNameContains(java.util.Optional<java.lang.String> fileNameContains)	Filters workflow runs by the name of the file.
WorkflowRunListRequest.Builder	from(WorkflowRunListRequest other)
WorkflowRunListRequest.Builder	maxPageSize(java.lang.Integer maxPageSize)
WorkflowRunListRequest.Builder	maxPageSize(java.util.Optional<java.lang.Integer> maxPageSize)
WorkflowRunListRequest.Builder	nextPageToken(java.lang.String nextPageToken)
WorkflowRunListRequest.Builder	nextPageToken(java.util.Optional<java.lang.String> nextPageToken)
WorkflowRunListRequest.Builder	sortBy(SortByEnum sortBy)
WorkflowRunListRequest.Builder	sortBy(java.util.Optional<SortByEnum> sortBy)	Sorts the workflow runs by the given field.
WorkflowRunListRequest.Builder	sortDir(SortDirEnum sortDir)
WorkflowRunListRequest.Builder	sortDir(java.util.Optional<SortDirEnum> sortDir)	Sorts the workflow runs in ascending or descending order.
WorkflowRunListRequest.Builder	status(WorkflowStatus status)
WorkflowRunListRequest.Builder	status(java.util.Optional<WorkflowStatus> status)	Filters workflow runs by their status.
WorkflowRunListRequest.Builder	workflowId(java.lang.String workflowId)
WorkflowRunListRequest.Builder	workflowId(java.util.Optional<java.lang.String> workflowId)	Filters workflow runs by the workflow ID.

Methods inherited from class java.lang.Object

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

Method Detail

from

public WorkflowRunListRequest.Builder from(WorkflowRunListRequest other)

status

public WorkflowRunListRequest.Builder status(java.util.Optional<WorkflowStatus> status)

Filters workflow runs by their status. If not provided, no filter is applied.

The status of a workflow run:

• "PENDING" - The workflow run has not started yet
• "PROCESSING" - The workflow run is in progress
• "NEEDS_REVIEW" - The workflow run requires manual review
• "REJECTED" - The workflow run was rejected during manual review
• "PROCESSED" - The workflow run completed successfully
• "FAILED" - The workflow run encountered an error
• "CANCELLED" - The workflow run was cancelled
• "CANCELLING" - The workflow run is being cancelled

status

public WorkflowRunListRequest.Builder status(WorkflowStatus status)

workflowId

public WorkflowRunListRequest.Builder workflowId(java.util.Optional<java.lang.String> workflowId)

Filters workflow runs by the workflow ID. If not provided, runs for all workflows are returned.

Example: "workflow_BMdfq_yWM3sT-ZzvCnA3f"

workflowId

public WorkflowRunListRequest.Builder workflowId(java.lang.String workflowId)

batchId

public WorkflowRunListRequest.Builder batchId(java.util.Optional<java.lang.String> batchId)

Filters workflow runs by the batch ID. This is useful for fetching all runs for a given batch created via the Batch Run Workflow endpoint.

Example: "batch_7Ws31-F5"

batchId

public WorkflowRunListRequest.Builder batchId(java.lang.String batchId)

fileNameContains

public WorkflowRunListRequest.Builder fileNameContains(java.util.Optional<java.lang.String> fileNameContains)

Filters workflow runs by the name of the file. Only returns workflow runs where the file name contains this string.

Example: "invoice"

fileNameContains

public WorkflowRunListRequest.Builder fileNameContains(java.lang.String fileNameContains)

sortBy

public WorkflowRunListRequest.Builder sortBy(java.util.Optional<SortByEnum> sortBy)

Sorts the workflow runs by the given field.

sortBy

public WorkflowRunListRequest.Builder sortBy(SortByEnum sortBy)

sortDir

public WorkflowRunListRequest.Builder sortDir(java.util.Optional<SortDirEnum> sortDir)

Sorts the workflow runs in ascending or descending order. Ascending order means the earliest workflow run is returned first.

sortDir

public WorkflowRunListRequest.Builder sortDir(SortDirEnum sortDir)

nextPageToken

public WorkflowRunListRequest.Builder nextPageToken(java.util.Optional<java.lang.String> nextPageToken)

nextPageToken

public WorkflowRunListRequest.Builder nextPageToken(java.lang.String nextPageToken)

maxPageSize

public WorkflowRunListRequest.Builder maxPageSize(java.util.Optional<java.lang.Integer> maxPageSize)

maxPageSize

public WorkflowRunListRequest.Builder maxPageSize(java.lang.Integer maxPageSize)

build

public WorkflowRunListRequest build()