java.lang.Object
- ai.extend.resources.processorrun.requests.ProcessorRunCreateRequest.Builder

All Implemented Interfaces:: ProcessorRunCreateRequest._FinalStage, ProcessorRunCreateRequest.ProcessorIdStage

Enclosing class:: ProcessorRunCreateRequest

public static final class ProcessorRunCreateRequest.Builder
extends java.lang.Object
implements ProcessorRunCreateRequest.ProcessorIdStage, ProcessorRunCreateRequest._FinalStage

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ProcessorRunCreateRequest`	`build()`
`ProcessorRunCreateRequest._FinalStage`	`config(ProcessorRunCreateRequestConfig config)`	The configuration for the processor run.
`ProcessorRunCreateRequest._FinalStage`	`config(java.util.Optional<ProcessorRunCreateRequestConfig> config)`	The configuration for the processor run.
`ProcessorRunCreateRequest._FinalStage`	`file(LegacyProcessorRunFileInput file)`	The file to be processed.
`ProcessorRunCreateRequest._FinalStage`	`file(java.util.Optional<LegacyProcessorRunFileInput> file)`	The file to be processed.
`ProcessorRunCreateRequest.Builder`	`from(ProcessorRunCreateRequest other)`
`ProcessorRunCreateRequest._FinalStage`	`metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)`	An optional object that can be passed in to identify the run of the document processor.
`ProcessorRunCreateRequest._FinalStage`	`metadata(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> metadata)`	An optional object that can be passed in to identify the run of the document processor.
`ProcessorRunCreateRequest._FinalStage`	`priority(java.lang.Integer priority)`	An optional value used to determine the relative order of ProcessorRuns when rate limiting is in effect.
`ProcessorRunCreateRequest._FinalStage`	`priority(java.util.Optional<java.lang.Integer> priority)`	An optional value used to determine the relative order of ProcessorRuns when rate limiting is in effect.
`ProcessorRunCreateRequest._FinalStage`	`processorId(java.lang.String processorId)`
`ProcessorRunCreateRequest._FinalStage`	`rawText(java.lang.String rawText)`	A raw string to be processed.
`ProcessorRunCreateRequest._FinalStage`	`rawText(java.util.Optional<java.lang.String> rawText)`	A raw string to be processed.
`ProcessorRunCreateRequest._FinalStage`	`sync(java.lang.Boolean sync)`	Whether to run the processor synchronously.
`ProcessorRunCreateRequest._FinalStage`	`sync(java.util.Optional<java.lang.Boolean> sync)`	Whether to run the processor synchronously.
`ProcessorRunCreateRequest._FinalStage`	`version(java.lang.String version)`	An optional version of the processor to use.
`ProcessorRunCreateRequest._FinalStage`	`version(java.util.Optional<java.lang.String> version)`	An optional version of the processor to use.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - from
```
public ProcessorRunCreateRequest.Builder from(ProcessorRunCreateRequest other)
```
    Specified by:
    
    from in interface ProcessorRunCreateRequest.ProcessorIdStage
  - processorId
```
public ProcessorRunCreateRequest._FinalStage processorId(@NotNull
                                                         java.lang.String processorId)
```
    Specified by:
    
    processorId in interface ProcessorRunCreateRequest.ProcessorIdStage
  - config
```
public ProcessorRunCreateRequest._FinalStage config(ProcessorRunCreateRequestConfig config)
```
    The configuration for the processor run. If this is provided, this config will be used. If not provided, the config for the specific version you provide will be used. The type of configuration must match the processor type.
    
    Specified by:
    
    config in interface ProcessorRunCreateRequest._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - config
```
public ProcessorRunCreateRequest._FinalStage config(java.util.Optional<ProcessorRunCreateRequestConfig> config)
```
    The configuration for the processor run. If this is provided, this config will be used. If not provided, the config for the specific version you provide will be used. The type of configuration must match the processor type.
    
    Specified by:
    
    config in interface ProcessorRunCreateRequest._FinalStage
  - metadata
```
public ProcessorRunCreateRequest._FinalStage metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)
```
    An optional object that can be passed in to identify the run of the document processor. It will be returned back to you in the response and webhooks.
    
    To categorize processor runs for billing and usage tracking, include extend:usage_tags with an array of string values (e.g., {"extend:usage_tags": ["production", "team-eng", "customer-123"]}). Tags must contain only alphanumeric characters, hyphens, and underscores; any special characters will be automatically removed.
    
    Specified by:
    
    metadata in interface ProcessorRunCreateRequest._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - metadata
```
public ProcessorRunCreateRequest._FinalStage metadata(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> metadata)
```
    An optional object that can be passed in to identify the run of the document processor. It will be returned back to you in the response and webhooks.
    
    To categorize processor runs for billing and usage tracking, include extend:usage_tags with an array of string values (e.g., {"extend:usage_tags": ["production", "team-eng", "customer-123"]}). Tags must contain only alphanumeric characters, hyphens, and underscores; any special characters will be automatically removed.
    
    Specified by:
    
    metadata in interface ProcessorRunCreateRequest._FinalStage
  - priority
```
public ProcessorRunCreateRequest._FinalStage priority(java.lang.Integer priority)
```
    An optional value used to determine the relative order of ProcessorRuns when rate limiting is in effect. Lower values will be prioritized before higher values.
    
    Specified by:
    
    priority in interface ProcessorRunCreateRequest._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - priority
```
public ProcessorRunCreateRequest._FinalStage priority(java.util.Optional<java.lang.Integer> priority)
```
    An optional value used to determine the relative order of ProcessorRuns when rate limiting is in effect. Lower values will be prioritized before higher values.
    
    Specified by:
    
    priority in interface ProcessorRunCreateRequest._FinalStage
  - sync
```
public ProcessorRunCreateRequest._FinalStage sync(java.lang.Boolean sync)
```
    Whether to run the processor synchronously. When true, the request will wait for the processor run to complete and return the final results. When false (default), the request returns immediately with a PROCESSING status, and you can poll for completion or use webhooks. For production use cases, we recommending leaving sync off and building around an async integration for more resiliency, unless your use case is predictably fast (e.g. sub < 30 seconds) run time or otherwise have integration constraints that require a synchronous API. See Async Processing for more details.
    
    Timeout: Synchronous requests have a 5-minute timeout. If the processor run takes longer, it will continue processing asynchronously and you can retrieve the results via the GET endpoint.
    
    Specified by:
    
    sync in interface ProcessorRunCreateRequest._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - sync
```
public ProcessorRunCreateRequest._FinalStage sync(java.util.Optional<java.lang.Boolean> sync)
```
    Whether to run the processor synchronously. When true, the request will wait for the processor run to complete and return the final results. When false (default), the request returns immediately with a PROCESSING status, and you can poll for completion or use webhooks. For production use cases, we recommending leaving sync off and building around an async integration for more resiliency, unless your use case is predictably fast (e.g. sub < 30 seconds) run time or otherwise have integration constraints that require a synchronous API. See Async Processing for more details.
    
    Timeout: Synchronous requests have a 5-minute timeout. If the processor run takes longer, it will continue processing asynchronously and you can retrieve the results via the GET endpoint.
    
    Specified by:
    
    sync in interface ProcessorRunCreateRequest._FinalStage
  - rawText
```
public ProcessorRunCreateRequest._FinalStage rawText(java.lang.String rawText)
```
    A raw string to be processed. Can be used in place of file when passing raw text data streams. One of file or rawText must be provided.
    
    Specified by:
    
    rawText in interface ProcessorRunCreateRequest._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - rawText
```
public ProcessorRunCreateRequest._FinalStage rawText(java.util.Optional<java.lang.String> rawText)
```
    A raw string to be processed. Can be used in place of file when passing raw text data streams. One of file or rawText must be provided.
    
    Specified by:
    
    rawText in interface ProcessorRunCreateRequest._FinalStage
  - file
```
public ProcessorRunCreateRequest._FinalStage file(LegacyProcessorRunFileInput file)
```
    The file to be processed. One of file or rawText must be provided. Supported file types can be found here.
    
    Specified by:
    
    file in interface ProcessorRunCreateRequest._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - file
```
public ProcessorRunCreateRequest._FinalStage file(java.util.Optional<LegacyProcessorRunFileInput> file)
```
    The file to be processed. One of file or rawText must be provided. Supported file types can be found here.
    
    Specified by:
    
    file in interface ProcessorRunCreateRequest._FinalStage
  - version
```
public ProcessorRunCreateRequest._FinalStage version(java.lang.String version)
```
    An optional version of the processor to use. When not supplied, the most recent published version of the processor will be used. Special values include:
    
    "latest" for the most recent published version. If there are no published versions, the draft version will be used.
    
    "draft" for the draft version.
    
    Specific version numbers corresponding to versions your team has published, e.g. "1.0", "2.2", etc.
    Specified by:
    
    version in interface ProcessorRunCreateRequest._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - version
```
public ProcessorRunCreateRequest._FinalStage version(java.util.Optional<java.lang.String> version)
```
    An optional version of the processor to use. When not supplied, the most recent published version of the processor will be used. Special values include:
    
    "latest" for the most recent published version. If there are no published versions, the draft version will be used.
    
    "draft" for the draft version.
    
    Specific version numbers corresponding to versions your team has published, e.g. "1.0", "2.2", etc.
    Specified by:
    
    version in interface ProcessorRunCreateRequest._FinalStage
  - build
```
public ProcessorRunCreateRequest build()
```
    Specified by:
    
    build in interface ProcessorRunCreateRequest._FinalStage

Class ProcessorRunCreateRequest.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

from

processorId

config

config

metadata

metadata

priority

priority

sync

sync

rawText

rawText

file

file

version

version

build