Package ai.extend.resources.workflowrun.requests

Class WorkflowRunListRequest

java.lang.Object

ai.extend.resources.workflowrun.requests.WorkflowRunListRequest

public final class WorkflowRunListRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkflowRunListRequest.Builder

Method Summary

Modifier and Type	Method	Description
static WorkflowRunListRequest.Builder	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<java.lang.String>	getBatchId()
java.util.Optional<java.lang.String>	getFileNameContains()
java.util.Optional<java.lang.Integer>	getMaxPageSize()
java.util.Optional<java.lang.String>	getNextPageToken()
java.util.Optional<SortByEnum>	getSortBy()
java.util.Optional<SortDirEnum>	getSortDir()
java.util.Optional<WorkflowStatus>	getStatus()
java.util.Optional<java.lang.String>	getWorkflowId()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getStatus

public java.util.Optional<WorkflowStatus> getStatus()

Returns:

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

getWorkflowId

public java.util.Optional<java.lang.String> getWorkflowId()

Returns:

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

Example: "workflow_BMdfq_yWM3sT-ZzvCnA3f"

getBatchId

public java.util.Optional<java.lang.String> getBatchId()

Returns:

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"

getFileNameContains

public java.util.Optional<java.lang.String> getFileNameContains()

Returns:

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

Example: "invoice"

getSortBy

public java.util.Optional<SortByEnum> getSortBy()

Returns:

Sorts the workflow runs by the given field.

getSortDir

public java.util.Optional<SortDirEnum> getSortDir()

Returns:

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

getNextPageToken

public java.util.Optional<java.lang.String> getNextPageToken()

getMaxPageSize

public java.util.Optional<java.lang.Integer> getMaxPageSize()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static WorkflowRunListRequest.Builder builder()