Package ai.extend.resources.processorrun.requests

Class ProcessorRunListRequest

  • public final class ProcessorRunListRequest
extends java.lang.Object

    • Method Detail

      • getExtendWorkspaceId

        public java.util.Optional<java.lang.String> getExtendWorkspaceId()
        Returns:
        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.

      • getStatus

        public java.util.Optional<LegacyProcessorStatus> getStatus()
        Returns:
        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

      • getProcessorId

        public java.util.Optional<java.lang.String> getProcessorId()
        Returns:
        Filters processor runs by the processor ID. If not provided, runs for all processors are returned.

        Example: "ex_BMdfq_yWM3sT-ZzvCnA3f"

      • getProcessorType

        public java.util.Optional<LegacyProcessorType> getProcessorType()
        Returns:
        Filters processor runs by the processor type. If not provided, runs for all processor types are returned.

        Example: "EXTRACT"

      • getSourceId

        public java.util.Optional<java.lang.String> getSourceId()
        Returns:
        Filters processor runs by the source ID. The source ID corresponds to the entity that created the processor run.

        Example: "workflow_run_123"

      • getSource

        public java.util.Optional<ProcessorRunListRequestSource> getSource()
        Returns:
        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

      • getFileNameContains

        public java.util.Optional<java.lang.String> getFileNameContains()
        Returns:
        Filters processor runs by the name of the file. Only returns processor runs where the file name contains this string.

        Example: "invoice"

      • getSortBy

        public java.util.Optional<LegacySortByEnum> getSortBy()
        Returns:
        Sorts the processor runs by the given field.

      • getSortDir

        public java.util.Optional<LegacySortDirEnum> getSortDir()
        Returns:
        Sorts the processor runs in ascending or descending order. Ascending order means the earliest processor 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