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

All Implemented Interfaces:: ProcessorVersion._FinalStage, ProcessorVersion.ConfigStage, ProcessorVersion.CreatedAtStage, ProcessorVersion.IdStage, ProcessorVersion.ObjectStage, ProcessorVersion.ProcessorIdStage, ProcessorVersion.ProcessorTypeStage, ProcessorVersion.UpdatedAtStage, ProcessorVersion.VersionStage

Enclosing class:: ProcessorVersion

public static final class ProcessorVersion.Builder
extends java.lang.Object
implements ProcessorVersion.ObjectStage, ProcessorVersion.IdStage, ProcessorVersion.ProcessorIdStage, ProcessorVersion.ProcessorTypeStage, ProcessorVersion.VersionStage, ProcessorVersion.ConfigStage, ProcessorVersion.CreatedAtStage, ProcessorVersion.UpdatedAtStage, ProcessorVersion._FinalStage

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ProcessorVersion`	`build()`
`ProcessorVersion.CreatedAtStage`	`config(ProcessorVersionConfig config)`	The configuration settings for this version of the document processor.
`ProcessorVersion.UpdatedAtStage`	`createdAt(java.time.OffsetDateTime createdAt)`	The time (in UTC) at which this version of the document processor was created.
`ProcessorVersion._FinalStage`	`description(java.lang.String description)`	An optional description of this version of the document processor.
`ProcessorVersion._FinalStage`	`description(java.util.Optional<java.lang.String> description)`	An optional description of this version of the document processor.
`ProcessorVersion.Builder`	`from(ProcessorVersion other)`
`ProcessorVersion.ProcessorIdStage`	`id(java.lang.String id)`	The unique identifier for this version of the document processor.
`ProcessorVersion.IdStage`	`object(java.lang.String object)`	The type of the object.
`ProcessorVersion.ProcessorTypeStage`	`processorId(java.lang.String processorId)`	The ID of the parent document processor.
`ProcessorVersion._FinalStage`	`processorName(java.lang.String processorName)`	The name of the parent document processor.
`ProcessorVersion._FinalStage`	`processorName(java.util.Optional<java.lang.String> processorName)`	The name of the parent document processor.
`ProcessorVersion.VersionStage`	`processorType(ProcessorType processorType)`
`ProcessorVersion._FinalStage`	`updatedAt(java.time.OffsetDateTime updatedAt)`	The time (in UTC) at which this version of the document processor was last updated.
`ProcessorVersion.ConfigStage`	`version(java.lang.String version)`	The version number or identifier for this specific version of the document processor.

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

- Method Detail
  - from
```
public ProcessorVersion.Builder from(ProcessorVersion other)
```
    Specified by:
    
    from in interface ProcessorVersion.ObjectStage
  - object
```
public ProcessorVersion.IdStage object(@NotNull
                                       java.lang.String object)
```
    The type of the object. In this case, it will always be "document_processor_version".
    
    The type of the object. In this case, it will always be "document_processor_version".
    
    Specified by:
    
    object in interface ProcessorVersion.ObjectStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - id
```
public ProcessorVersion.ProcessorIdStage id(@NotNull
                                            java.lang.String id)
```
    The unique identifier for this version of the document processor.
    
    Example: "dpv_xK9mLPqRtN3vS8wF5hB2cQ"
    
    The unique identifier for this version of the document processor.
    
    Example: "dpv_xK9mLPqRtN3vS8wF5hB2cQ"
    
    Specified by:
    
    id in interface ProcessorVersion.IdStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - processorId
```
public ProcessorVersion.ProcessorTypeStage processorId(@NotNull
                                                       java.lang.String processorId)
```
    The ID of the parent document processor.
    
    Example: "dp_Xj8mK2pL9nR4vT7qY5wZ"
    
    The ID of the parent document processor.
    
    Example: "dp_Xj8mK2pL9nR4vT7qY5wZ"
    
    Specified by:
    
    processorId in interface ProcessorVersion.ProcessorIdStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - processorType
```
public ProcessorVersion.VersionStage processorType(@NotNull
                                                   ProcessorType processorType)
```
    Specified by:
    
    processorType in interface ProcessorVersion.ProcessorTypeStage
  - version
```
public ProcessorVersion.ConfigStage version(@NotNull
                                            java.lang.String version)
```
    The version number or identifier for this specific version of the document processor. The draft version will have version="draft".
    
    Examples: "1.0", "2.1", "draft"
    
    The version number or identifier for this specific version of the document processor. The draft version will have version="draft".
    
    Examples: "1.0", "2.1", "draft"
    
    Specified by:
    
    version in interface ProcessorVersion.VersionStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - config
```
public ProcessorVersion.CreatedAtStage config(@NotNull
                                              ProcessorVersionConfig config)
```
    The configuration settings for this version of the document processor. The structure of this object will vary depending on the processor type.
    
    See the configuration section in the "Guides" tab, for yout specific processor type, for more details on the configuration settings.
    
    The configuration settings for this version of the document processor. The structure of this object will vary depending on the processor type.
    
    See the configuration section in the "Guides" tab, for yout specific processor type, for more details on the configuration settings.
    
    Specified by:
    
    config in interface ProcessorVersion.ConfigStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - createdAt
```
public ProcessorVersion.UpdatedAtStage createdAt(@NotNull
                                                 java.time.OffsetDateTime createdAt)
```
    The time (in UTC) at which this version of the document processor was created. Will follow the RFC 3339 format.
    
    Example: "2024-03-21T15:30:00Z"
    
    The time (in UTC) at which this version of the document processor was created. Will follow the RFC 3339 format.
    
    Example: "2024-03-21T15:30:00Z"
    
    Specified by:
    
    createdAt in interface ProcessorVersion.CreatedAtStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - updatedAt
```
public ProcessorVersion._FinalStage updatedAt(@NotNull
                                              java.time.OffsetDateTime updatedAt)
```
    The time (in UTC) at which this version of the document processor was last updated. Will follow the RFC 3339 format.
    
    Example: "2024-03-21T16:45:00Z"
    
    The time (in UTC) at which this version of the document processor was last updated. Will follow the RFC 3339 format.
    
    Example: "2024-03-21T16:45:00Z"
    
    Specified by:
    
    updatedAt in interface ProcessorVersion.UpdatedAtStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - description
```
public ProcessorVersion._FinalStage description(java.lang.String description)
```
    An optional description of this version of the document processor.
    
    Example: "Updated extraction fields for new invoice format"
    
    Specified by:
    
    description in interface ProcessorVersion._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - description
```
public ProcessorVersion._FinalStage description(java.util.Optional<java.lang.String> description)
```
    An optional description of this version of the document processor.
    
    Example: "Updated extraction fields for new invoice format"
    
    Specified by:
    
    description in interface ProcessorVersion._FinalStage
  - processorName
```
public ProcessorVersion._FinalStage processorName(java.lang.String processorName)
```
    The name of the parent document processor.
    
    Example: "Invoice Processor"
    
    Specified by:
    
    processorName in interface ProcessorVersion._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - processorName
```
public ProcessorVersion._FinalStage processorName(java.util.Optional<java.lang.String> processorName)
```
    The name of the parent document processor.
    
    Example: "Invoice Processor"
    
    Specified by:
    
    processorName in interface ProcessorVersion._FinalStage
  - build
```
public ProcessorVersion build()
```
    Specified by:
    
    build in interface ProcessorVersion._FinalStage

Class ProcessorVersion.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

from

object

id

processorId

processorType

version

config

createdAt

updatedAt

description

description

processorName

processorName

build