Package ai.extend.resources.workflowruns.requests

Class WorkflowRunsListRequest.Builder

java.lang.Object

ai.extend.resources.workflowruns.requests.WorkflowRunsListRequest.Builder

Enclosing class:

WorkflowRunsListRequest

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

Method Summary

Modifier and Type	Method	Description
WorkflowRunsListRequest.Builder	batchId(java.lang.String batchId)
WorkflowRunsListRequest.Builder	batchId(java.util.Optional<java.lang.String> batchId)	Filters workflow runs by the batch ID.
WorkflowRunsListRequest	build()
WorkflowRunsListRequest.Builder	extendWorkspaceId(java.lang.String extendWorkspaceId)
WorkflowRunsListRequest.Builder	extendWorkspaceId(java.util.Optional<java.lang.String> extendWorkspaceId)	The workspace ID to target.
WorkflowRunsListRequest.Builder	fileNameContains(java.lang.String fileNameContains)
WorkflowRunsListRequest.Builder	fileNameContains(java.util.Optional<java.lang.String> fileNameContains)	Filters runs by the name of the file.
WorkflowRunsListRequest.Builder	from(WorkflowRunsListRequest other)
WorkflowRunsListRequest.Builder	maxPageSize(java.lang.Integer maxPageSize)
WorkflowRunsListRequest.Builder	maxPageSize(java.util.Optional<java.lang.Integer> maxPageSize)
WorkflowRunsListRequest.Builder	nextPageToken(java.lang.String nextPageToken)
WorkflowRunsListRequest.Builder	nextPageToken(java.util.Optional<java.lang.String> nextPageToken)
WorkflowRunsListRequest.Builder	sortBy(SortBy sortBy)
WorkflowRunsListRequest.Builder	sortBy(java.util.Optional<SortBy> sortBy)
WorkflowRunsListRequest.Builder	sortDir(SortDir sortDir)
WorkflowRunsListRequest.Builder	sortDir(java.util.Optional<SortDir> sortDir)
WorkflowRunsListRequest.Builder	status(WorkflowRunStatus status)
WorkflowRunsListRequest.Builder	status(java.util.Optional<WorkflowRunStatus> status)
WorkflowRunsListRequest.Builder	workflowId(java.lang.String workflowId)
WorkflowRunsListRequest.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 WorkflowRunsListRequest.Builder from(WorkflowRunsListRequest other)

extendWorkspaceId

public WorkflowRunsListRequest.Builder extendWorkspaceId(java.util.Optional<java.lang.String> extendWorkspaceId)

The workspace ID to target. Required when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See Authentication for details on API key scopes.

extendWorkspaceId

public WorkflowRunsListRequest.Builder extendWorkspaceId(java.lang.String extendWorkspaceId)

status

public WorkflowRunsListRequest.Builder status(java.util.Optional<WorkflowRunStatus> status)

status

public WorkflowRunsListRequest.Builder status(WorkflowRunStatus status)

workflowId

public WorkflowRunsListRequest.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 WorkflowRunsListRequest.Builder workflowId(java.lang.String workflowId)

batchId

public WorkflowRunsListRequest.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 WorkflowRunsListRequest.Builder batchId(java.lang.String batchId)

fileNameContains

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

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

Example: "invoice"

fileNameContains

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

sortBy

public WorkflowRunsListRequest.Builder sortBy(java.util.Optional<SortBy> sortBy)

sortBy

public WorkflowRunsListRequest.Builder sortBy(SortBy sortBy)

sortDir

public WorkflowRunsListRequest.Builder sortDir(java.util.Optional<SortDir> sortDir)

sortDir

public WorkflowRunsListRequest.Builder sortDir(SortDir sortDir)

nextPageToken

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

nextPageToken

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

maxPageSize

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

maxPageSize

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

build

public WorkflowRunsListRequest build()