java.lang.Object
- ai.extend.types.BatchProcessorRun.Builder

All Implemented Interfaces:: BatchProcessorRun._FinalStage, BatchProcessorRun.CreatedAtStage, BatchProcessorRun.IdStage, BatchProcessorRun.MetricsStage, BatchProcessorRun.ObjectStage, BatchProcessorRun.OptionsStage, BatchProcessorRun.ProcessorIdStage, BatchProcessorRun.ProcessorNameStage, BatchProcessorRun.ProcessorVersionIdStage, BatchProcessorRun.RunCountStage, BatchProcessorRun.SourceStage, BatchProcessorRun.StatusStage, BatchProcessorRun.UpdatedAtStage

Enclosing class:: BatchProcessorRun

public static final class BatchProcessorRun.Builder
extends java.lang.Object
implements BatchProcessorRun.ObjectStage, BatchProcessorRun.IdStage, BatchProcessorRun.ProcessorIdStage, BatchProcessorRun.ProcessorVersionIdStage, BatchProcessorRun.ProcessorNameStage, BatchProcessorRun.MetricsStage, BatchProcessorRun.StatusStage, BatchProcessorRun.SourceStage, BatchProcessorRun.RunCountStage, BatchProcessorRun.OptionsStage, BatchProcessorRun.CreatedAtStage, BatchProcessorRun.UpdatedAtStage, BatchProcessorRun._FinalStage

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BatchProcessorRun`	`build()`
`BatchProcessorRun.UpdatedAtStage`	`createdAt(java.time.OffsetDateTime createdAt)`	The time (in UTC) at which the batch processor run was created.
`BatchProcessorRun.Builder`	`from(BatchProcessorRun other)`
`BatchProcessorRun.ProcessorIdStage`	`id(java.lang.String id)`	The unique identifier for this batch processor run.
`BatchProcessorRun.StatusStage`	`metrics(BatchProcessorRunMetrics metrics)`
`BatchProcessorRun.IdStage`	`object(java.lang.String object)`	The type of response.
`BatchProcessorRun.CreatedAtStage`	`options(BatchProcessorRunOptions options)`	The options for the batch processor run.
`BatchProcessorRun.ProcessorVersionIdStage`	`processorId(java.lang.String processorId)`	The ID of the processor used for this run.
`BatchProcessorRun.MetricsStage`	`processorName(java.lang.String processorName)`	The name of the processor.
`BatchProcessorRun.ProcessorNameStage`	`processorVersionId(java.lang.String processorVersionId)`	The ID of the specific processor version used.
`BatchProcessorRun.OptionsStage`	`runCount(int runCount)`	The number of runs that were made.
`BatchProcessorRun.RunCountStage`	`source(BatchProcessorRunSource source)`	The source of the batch processor run:
`BatchProcessorRun._FinalStage`	`sourceId(java.lang.String sourceId)`	The ID of the source of the batch processor run.
`BatchProcessorRun._FinalStage`	`sourceId(java.util.Optional<java.lang.String> sourceId)`	The ID of the source of the batch processor run.
`BatchProcessorRun.SourceStage`	`status(BatchProcessorRunStatus status)`	The current status of the batch processor run:
`BatchProcessorRun._FinalStage`	`updatedAt(java.time.OffsetDateTime updatedAt)`	The time (in UTC) at which the batch processor run was last updated.

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

- Method Detail
  - from
```
public BatchProcessorRun.Builder from(BatchProcessorRun other)
```
    Specified by:
    
    from in interface BatchProcessorRun.ObjectStage
  - object
```
public BatchProcessorRun.IdStage object(@NotNull
                                        java.lang.String object)
```
    The type of response. In this case, it will always be "batch_processor_run".
    
    The type of response. In this case, it will always be "batch_processor_run".
    
    Specified by:
    
    object in interface BatchProcessorRun.ObjectStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - id
```
public BatchProcessorRun.ProcessorIdStage id(@NotNull
                                             java.lang.String id)
```
    The unique identifier for this batch processor run.
    
    Example: "batch_processor_run_Xj8mK2pL9nR4vT7qY5wZ"
    
    The unique identifier for this batch processor run.
    
    Example: "batch_processor_run_Xj8mK2pL9nR4vT7qY5wZ"
    
    Specified by:
    
    id in interface BatchProcessorRun.IdStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - processorId
```
public BatchProcessorRun.ProcessorVersionIdStage processorId(@NotNull
                                                             java.lang.String processorId)
```
    The ID of the processor used for this run.
    
    Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"
    
    The ID of the processor used for this run.
    
    Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"
    
    Specified by:
    
    processorId in interface BatchProcessorRun.ProcessorIdStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - processorVersionId
```
public BatchProcessorRun.ProcessorNameStage processorVersionId(@NotNull
                                                               java.lang.String processorVersionId)
```
    The ID of the specific processor version used.
    
    Example: "exv_xK9mLPqRtN3vS8wF5hB2cQ"
    
    The ID of the specific processor version used.
    
    Example: "exv_xK9mLPqRtN3vS8wF5hB2cQ"
    
    Specified by:
    
    processorVersionId in interface BatchProcessorRun.ProcessorVersionIdStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - processorName
```
public BatchProcessorRun.MetricsStage processorName(@NotNull
                                                    java.lang.String processorName)
```
    The name of the processor.
    
    Example: "Invoice Processor"
    
    The name of the processor.
    
    Example: "Invoice Processor"
    
    Specified by:
    
    processorName in interface BatchProcessorRun.ProcessorNameStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - metrics
```
public BatchProcessorRun.StatusStage metrics(@NotNull
                                             BatchProcessorRunMetrics metrics)
```
    Specified by:
    
    metrics in interface BatchProcessorRun.MetricsStage
  - status
```
public BatchProcessorRun.SourceStage status(@NotNull
                                            BatchProcessorRunStatus status)
```
    The current status of the batch processor run:
    
    "PENDING" - The batch processor run is waiting to start
    
    "PROCESSING" - The batch processor run is in progress
    
    "PROCESSED" - The batch processor run completed successfully
    
    "FAILED" - The batch processor run encountered an error
    
    The current status of the batch processor run:
    
    "PENDING" - The batch processor run is waiting to start
    
    "PROCESSING" - The batch processor run is in progress
    
    "PROCESSED" - The batch processor run completed successfully
    
    "FAILED" - The batch processor run encountered an error
    Specified by:
    
    status in interface BatchProcessorRun.StatusStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - source
```
public BatchProcessorRun.RunCountStage source(@NotNull
                                              BatchProcessorRunSource source)
```
    The source of the batch processor run:
    
    "EVAL_SET" - The batch processor run was made from an evaluation set. The sourceId will be the ID of the evaluation set (e.g., "ev_1234")
    
    "PLAYGROUND" - The batch processor run was made from the playground. The sourceId will not be set
    
    "STUDIO" - The batch processor run was made for a processor in Studio. The sourceId will be the ID of the processor (e.g., "ex_1234")
    
    The source of the batch processor run:
    
    "EVAL_SET" - The batch processor run was made from an evaluation set. The sourceId will be the ID of the evaluation set (e.g., "ev_1234")
    
    "PLAYGROUND" - The batch processor run was made from the playground. The sourceId will not be set
    
    "STUDIO" - The batch processor run was made for a processor in Studio. The sourceId will be the ID of the processor (e.g., "ex_1234")
    Specified by:
    
    source in interface BatchProcessorRun.SourceStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - runCount
```
public BatchProcessorRun.OptionsStage runCount(int runCount)
```
    The number of runs that were made.
    
    The number of runs that were made.
    
    Specified by:
    
    runCount in interface BatchProcessorRun.RunCountStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - options
```
public BatchProcessorRun.CreatedAtStage options(@NotNull
                                                BatchProcessorRunOptions options)
```
    The options for the batch processor run.
    
    The options for the batch processor run.
    
    Specified by:
    
    options in interface BatchProcessorRun.OptionsStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - createdAt
```
public BatchProcessorRun.UpdatedAtStage createdAt(@NotNull
                                                  java.time.OffsetDateTime createdAt)
```
    The time (in UTC) at which the batch processor run was created. Will follow the RFC 3339 format.
    
    Example: "2024-03-21T15:30:00Z"
    
    The time (in UTC) at which the batch processor run was created. Will follow the RFC 3339 format.
    
    Example: "2024-03-21T15:30:00Z"
    
    Specified by:
    
    createdAt in interface BatchProcessorRun.CreatedAtStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - updatedAt
```
public BatchProcessorRun._FinalStage updatedAt(@NotNull
                                               java.time.OffsetDateTime updatedAt)
```
    The time (in UTC) at which the batch processor run was last updated. Will follow the RFC 3339 format.
    
    Example: "2024-03-21T16:45:00Z"
    
    The time (in UTC) at which the batch processor run was last updated. Will follow the RFC 3339 format.
    
    Example: "2024-03-21T16:45:00Z"
    
    Specified by:
    
    updatedAt in interface BatchProcessorRun.UpdatedAtStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - sourceId
```
public BatchProcessorRun._FinalStage sourceId(java.lang.String sourceId)
```
    The ID of the source of the batch processor run. See the source field for more details. Example: "ev_1234" for EVAL_SET source, "ex_1234" for STUDIO source
    
    Specified by:
    
    sourceId in interface BatchProcessorRun._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - sourceId
```
public BatchProcessorRun._FinalStage sourceId(java.util.Optional<java.lang.String> sourceId)
```
    The ID of the source of the batch processor run. See the source field for more details. Example: "ev_1234" for EVAL_SET source, "ex_1234" for STUDIO source
    
    Specified by:
    
    sourceId in interface BatchProcessorRun._FinalStage
  - build
```
public BatchProcessorRun build()
```
    Specified by:
    
    build in interface BatchProcessorRun._FinalStage

Class BatchProcessorRun.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

from

object

id

processorId

processorVersionId

processorName

metrics

status

source

runCount

options

createdAt

updatedAt

sourceId

sourceId

build