Package ai.extend.types

Class EditRun.Builder

java.lang.Object

ai.extend.types.EditRun.Builder

All Implemented Interfaces:

EditRun._FinalStage, EditRun.ConfigStage, EditRun.FileStage, EditRun.IdStage, EditRun.StatusStage

Enclosing class:

EditRun

public static final class EditRun.Builder
extends java.lang.Object
implements EditRun.IdStage, EditRun.FileStage, EditRun.StatusStage, EditRun.ConfigStage, EditRun._FinalStage

Method Summary

Modifier and Type	Method	Description
EditRun	build()
EditRun._FinalStage	config(EditConfig config)	The configuration used for this edit run, including any default values that were applied.
EditRun._FinalStage	failureMessage(Nullable<java.lang.String> failureMessage)	A human-readable description of the failure.
EditRun._FinalStage	failureMessage(java.lang.String failureMessage)	A human-readable description of the failure.
EditRun._FinalStage	failureMessage(java.util.Optional<java.lang.String> failureMessage)	A human-readable description of the failure.
EditRun._FinalStage	failureReason(Nullable<java.lang.String> failureReason)	The reason for failure.
EditRun._FinalStage	failureReason(java.lang.String failureReason)	The reason for failure.
EditRun._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason for failure.
EditRun.StatusStage	file(FileSummary file)	The input file that was submitted for editing.
EditRun.Builder	from(EditRun other)
EditRun.FileStage	id(java.lang.String id)	A unique identifier for the edit run.
EditRun._FinalStage	metrics(Nullable<EditRunMetrics> metrics)	Metrics about the editing process.
EditRun._FinalStage	metrics(EditRunMetrics metrics)	Metrics about the editing process.
EditRun._FinalStage	metrics(java.util.Optional<EditRunMetrics> metrics)	Metrics about the editing process.
EditRun._FinalStage	output(Nullable<EditRunOutput> output)	The output of the edit run.
EditRun._FinalStage	output(EditRunOutput output)	The output of the edit run.
EditRun._FinalStage	output(java.util.Optional<EditRunOutput> output)	The output of the edit run.
EditRun.ConfigStage	status(EditRunStatus status)	The status of the edit run:
EditRun._FinalStage	usage(Nullable<RunUsage> usage)	Usage credits consumed by this run.
EditRun._FinalStage	usage(RunUsage usage)	Usage credits consumed by this run.
EditRun._FinalStage	usage(java.util.Optional<RunUsage> usage)	Usage credits consumed by this run.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public EditRun.Builder from(EditRun other)

Specified by:

from in interface EditRun.IdStage

id

public EditRun.FileStage id(@NotNull
                            java.lang.String id)

A unique identifier for the edit run.

Example: "edr_xK9mLPqRtN3vS8wF5hB2cQ"

A unique identifier for the edit run.

Example: "edr_xK9mLPqRtN3vS8wF5hB2cQ"

Specified by:

id in interface EditRun.IdStage

Returns:

Reference to this so that method calls can be chained together.

file

public EditRun.StatusStage file(@NotNull
                                FileSummary file)

The input file that was submitted for editing.

The input file that was submitted for editing.

Specified by:

file in interface EditRun.FileStage

Returns:

Reference to this so that method calls can be chained together.

status

public EditRun.ConfigStage status(@NotNull
                                  EditRunStatus status)

The status of the edit run:

• "PROCESSING" - The file is still being processed
• "PROCESSED" - The file was successfully edited
• "FAILED" - The editing failed (see failureReason for details)

The status of the edit run:

• "PROCESSING" - The file is still being processed
• "PROCESSED" - The file was successfully edited
• "FAILED" - The editing failed (see failureReason for details)

Specified by:

status in interface EditRun.StatusStage

Returns:

Reference to this so that method calls can be chained together.

config

public EditRun._FinalStage config(@NotNull
                                  EditConfig config)

The configuration used for this edit run, including any default values that were applied.

The configuration used for this edit run, including any default values that were applied.

Specified by:

config in interface EditRun.ConfigStage

Returns:

Reference to this so that method calls can be chained together.

usage

public EditRun._FinalStage usage(Nullable<RunUsage> usage)

Usage credits consumed by this run.

Availability: Present when status is "PROCESSED", the run was created after October 7, 2025, and the customer is on the current billing system.

Specified by:

usage in interface EditRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

usage

public EditRun._FinalStage usage(RunUsage usage)

Usage credits consumed by this run.

Availability: Present when status is "PROCESSED", the run was created after October 7, 2025, and the customer is on the current billing system.

Specified by:

usage in interface EditRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

usage

public EditRun._FinalStage usage(java.util.Optional<RunUsage> usage)

Usage credits consumed by this run.

Availability: Present when status is "PROCESSED", the run was created after October 7, 2025, and the customer is on the current billing system.

Specified by:

usage in interface EditRun._FinalStage

metrics

public EditRun._FinalStage metrics(Nullable<EditRunMetrics> metrics)

Metrics about the editing process.

Availability: Present when status is "PROCESSED".

Specified by:

metrics in interface EditRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

metrics

public EditRun._FinalStage metrics(EditRunMetrics metrics)

Metrics about the editing process.

Availability: Present when status is "PROCESSED".

Specified by:

metrics in interface EditRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

metrics

public EditRun._FinalStage metrics(java.util.Optional<EditRunMetrics> metrics)

Metrics about the editing process.

Availability: Present when status is "PROCESSED".

Specified by:

metrics in interface EditRun._FinalStage

output

public EditRun._FinalStage output(Nullable<EditRunOutput> output)

The output of the edit run.

Availability: Present when status is "PROCESSED".

Specified by:

output in interface EditRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

output

public EditRun._FinalStage output(EditRunOutput output)

The output of the edit run.

Availability: Present when status is "PROCESSED".

Specified by:

output in interface EditRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

output

public EditRun._FinalStage output(java.util.Optional<EditRunOutput> output)

The output of the edit run.

Availability: Present when status is "PROCESSED".

Specified by:

output in interface EditRun._FinalStage

failureMessage

public EditRun._FinalStage failureMessage(Nullable<java.lang.String> failureMessage)

A human-readable description of the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface EditRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

failureMessage

public EditRun._FinalStage failureMessage(java.lang.String failureMessage)

A human-readable description of the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface EditRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

failureMessage

public EditRun._FinalStage failureMessage(java.util.Optional<java.lang.String> failureMessage)

A human-readable description of the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface EditRun._FinalStage

failureReason

public EditRun._FinalStage failureReason(Nullable<java.lang.String> failureReason)

The reason for failure.

Availability: Present when status is "FAILED".

Possible values include:

• UNABLE_TO_DOWNLOAD_FILE - Failed to load the requested file
• FILE_TYPE_NOT_SUPPORTED - File type not supported. Edit runs currently require a PDF
• FILE_SIZE_TOO_LARGE - The file exceeds the maximum allowed size
• CORRUPT_FILE - The file appears to be corrupted and cannot be edited
• FIELD_DETECTION_ERROR - An error occurred during field detection
• PASSWORD_PROTECTED_FILE - The file is password protected and cannot be edited
• FAILED_TO_CONVERT_TO_PDF - The file could not be converted to PDF for processing
• INTERNAL_ERROR - An unexpected internal error occurred
• INVALID_OPTIONS - The provided configuration options are invalid
• EMPTY_SCHEMA - No schema was provided and no fields could be detected
• OUT_OF_CREDITS - Insufficient credits to process the file

Note: Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.

Specified by:

failureReason in interface EditRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

failureReason

public EditRun._FinalStage failureReason(java.lang.String failureReason)

The reason for failure.

Availability: Present when status is "FAILED".

Possible values include:

• UNABLE_TO_DOWNLOAD_FILE - Failed to load the requested file
• FILE_TYPE_NOT_SUPPORTED - File type not supported. Edit runs currently require a PDF
• FILE_SIZE_TOO_LARGE - The file exceeds the maximum allowed size
• CORRUPT_FILE - The file appears to be corrupted and cannot be edited
• FIELD_DETECTION_ERROR - An error occurred during field detection
• PASSWORD_PROTECTED_FILE - The file is password protected and cannot be edited
• FAILED_TO_CONVERT_TO_PDF - The file could not be converted to PDF for processing
• INTERNAL_ERROR - An unexpected internal error occurred
• INVALID_OPTIONS - The provided configuration options are invalid
• EMPTY_SCHEMA - No schema was provided and no fields could be detected
• OUT_OF_CREDITS - Insufficient credits to process the file

Note: Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.

Specified by:

failureReason in interface EditRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

failureReason

public EditRun._FinalStage failureReason(java.util.Optional<java.lang.String> failureReason)

The reason for failure.

Availability: Present when status is "FAILED".

Possible values include:

• UNABLE_TO_DOWNLOAD_FILE - Failed to load the requested file
• FILE_TYPE_NOT_SUPPORTED - File type not supported. Edit runs currently require a PDF
• FILE_SIZE_TOO_LARGE - The file exceeds the maximum allowed size
• CORRUPT_FILE - The file appears to be corrupted and cannot be edited
• FIELD_DETECTION_ERROR - An error occurred during field detection
• PASSWORD_PROTECTED_FILE - The file is password protected and cannot be edited
• FAILED_TO_CONVERT_TO_PDF - The file could not be converted to PDF for processing
• INTERNAL_ERROR - An unexpected internal error occurred
• INVALID_OPTIONS - The provided configuration options are invalid
• EMPTY_SCHEMA - No schema was provided and no fields could be detected
• OUT_OF_CREDITS - Insufficient credits to process the file

Note: Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.

Specified by:

failureReason in interface EditRun._FinalStage

build

public EditRun build()

Specified by:

build in interface EditRun._FinalStage