Package ai.extend.resources.processorrun.requests

Class ProcessorRunListRequest.Builder

java.lang.Object

ai.extend.resources.processorrun.requests.ProcessorRunListRequest.Builder

Enclosing class:

ProcessorRunListRequest

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

Method Summary

Modifier and Type	Method	Description
ProcessorRunListRequest	build()
ProcessorRunListRequest.Builder	extendWorkspaceId(java.lang.String extendWorkspaceId)
ProcessorRunListRequest.Builder	extendWorkspaceId(java.util.Optional<java.lang.String> extendWorkspaceId)	The workspace ID to target.
ProcessorRunListRequest.Builder	fileNameContains(java.lang.String fileNameContains)
ProcessorRunListRequest.Builder	fileNameContains(java.util.Optional<java.lang.String> fileNameContains)	Filters processor runs by the name of the file.
ProcessorRunListRequest.Builder	from(ProcessorRunListRequest other)
ProcessorRunListRequest.Builder	maxPageSize(java.lang.Integer maxPageSize)
ProcessorRunListRequest.Builder	maxPageSize(java.util.Optional<java.lang.Integer> maxPageSize)
ProcessorRunListRequest.Builder	nextPageToken(java.lang.String nextPageToken)
ProcessorRunListRequest.Builder	nextPageToken(java.util.Optional<java.lang.String> nextPageToken)
ProcessorRunListRequest.Builder	processorId(java.lang.String processorId)
ProcessorRunListRequest.Builder	processorId(java.util.Optional<java.lang.String> processorId)	Filters processor runs by the processor ID.
ProcessorRunListRequest.Builder	processorType(LegacyProcessorType processorType)
ProcessorRunListRequest.Builder	processorType(java.util.Optional<LegacyProcessorType> processorType)	Filters processor runs by the processor type.
ProcessorRunListRequest.Builder	sortBy(LegacySortByEnum sortBy)
ProcessorRunListRequest.Builder	sortBy(java.util.Optional<LegacySortByEnum> sortBy)	Sorts the processor runs by the given field.
ProcessorRunListRequest.Builder	sortDir(LegacySortDirEnum sortDir)
ProcessorRunListRequest.Builder	sortDir(java.util.Optional<LegacySortDirEnum> sortDir)	Sorts the processor runs in ascending or descending order.
ProcessorRunListRequest.Builder	source(ProcessorRunListRequestSource source)
ProcessorRunListRequest.Builder	source(java.util.Optional<ProcessorRunListRequestSource> source)	Filters processor runs by the source that created them.
ProcessorRunListRequest.Builder	sourceId(java.lang.String sourceId)
ProcessorRunListRequest.Builder	sourceId(java.util.Optional<java.lang.String> sourceId)	Filters processor runs by the source ID.
ProcessorRunListRequest.Builder	status(LegacyProcessorStatus status)
ProcessorRunListRequest.Builder	status(java.util.Optional<LegacyProcessorStatus> status)	Filters processor runs by their status.

Methods inherited from class java.lang.Object

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

Method Detail

from

public ProcessorRunListRequest.Builder from(ProcessorRunListRequest other)

extendWorkspaceId

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

status

public ProcessorRunListRequest.Builder status(java.util.Optional<LegacyProcessorStatus> status)

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

The status of a processor run:

• "PENDING" - The processor run has not started yet
• "PROCESSING" - The processor run is in progress
• "PROCESSED" - The processor run completed successfully
• "FAILED" - The processor run encountered an error
• "CANCELLED" - The processor run was cancelled

status

public ProcessorRunListRequest.Builder status(LegacyProcessorStatus status)

processorId

public ProcessorRunListRequest.Builder processorId(java.util.Optional<java.lang.String> processorId)

Filters processor runs by the processor ID. If not provided, runs for all processors are returned.

Example: "ex_BMdfq_yWM3sT-ZzvCnA3f"

processorId

public ProcessorRunListRequest.Builder processorId(java.lang.String processorId)

processorType

public ProcessorRunListRequest.Builder processorType(java.util.Optional<LegacyProcessorType> processorType)

Filters processor runs by the processor type. If not provided, runs for all processor types are returned.

Example: "EXTRACT"

processorType

public ProcessorRunListRequest.Builder processorType(LegacyProcessorType processorType)

sourceId

public ProcessorRunListRequest.Builder sourceId(java.util.Optional<java.lang.String> sourceId)

Filters processor runs by the source ID. The source ID corresponds to the entity that created the processor run.

Example: "workflow_run_123"

sourceId

public ProcessorRunListRequest.Builder sourceId(java.lang.String sourceId)

source

public ProcessorRunListRequest.Builder source(java.util.Optional<ProcessorRunListRequestSource> source)

Filters processor runs by the source that created them. If not provided, runs from all sources are returned.

The source of the processor run:

• "ADMIN" - Created by admin
• "BATCH_PROCESSOR_RUN" - Created from a batch processor run
• "PLAYGROUND" - Created from playground
• "WORKFLOW_CONFIGURATION" - Created from workflow configuration
• "WORKFLOW_RUN" - Created from a workflow run
• "STUDIO" - Created from Studio
• "API" - Created via API

source

public ProcessorRunListRequest.Builder source(ProcessorRunListRequestSource source)

fileNameContains

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

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

Example: "invoice"

fileNameContains

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

sortBy

public ProcessorRunListRequest.Builder sortBy(java.util.Optional<LegacySortByEnum> sortBy)

Sorts the processor runs by the given field.

sortBy

public ProcessorRunListRequest.Builder sortBy(LegacySortByEnum sortBy)

sortDir

public ProcessorRunListRequest.Builder sortDir(java.util.Optional<LegacySortDirEnum> sortDir)

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

sortDir

public ProcessorRunListRequest.Builder sortDir(LegacySortDirEnum sortDir)

nextPageToken

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

nextPageToken

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

maxPageSize

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

maxPageSize

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

build

public ProcessorRunListRequest build()