Package ai.extend.types

Class SplitRunSummary.Builder

java.lang.Object

ai.extend.types.SplitRunSummary.Builder

All Implemented Interfaces:

SplitRunSummary._FinalStage, SplitRunSummary.CreatedAtStage, SplitRunSummary.DashboardUrlStage, SplitRunSummary.EditedStage, SplitRunSummary.FileStage, SplitRunSummary.IdStage, SplitRunSummary.ReviewedStage, SplitRunSummary.StatusStage, SplitRunSummary.UpdatedAtStage

Enclosing class:

SplitRunSummary

public static final class SplitRunSummary.Builder
extends java.lang.Object
implements SplitRunSummary.IdStage, SplitRunSummary.StatusStage, SplitRunSummary.ReviewedStage, SplitRunSummary.EditedStage, SplitRunSummary.FileStage, SplitRunSummary.DashboardUrlStage, SplitRunSummary.CreatedAtStage, SplitRunSummary.UpdatedAtStage, SplitRunSummary._FinalStage

Method Summary

Modifier and Type	Method	Description
SplitRunSummary	build()
SplitRunSummary.UpdatedAtStage	createdAt(java.time.OffsetDateTime createdAt)
SplitRunSummary.CreatedAtStage	dashboardUrl(java.lang.String dashboardUrl)	The URL to view the split run in the Extend dashboard.
SplitRunSummary.FileStage	edited(boolean edited)	Indicates whether the run results have been edited during review.
SplitRunSummary._FinalStage	failureMessage(Nullable<java.lang.String> failureMessage)	A detailed message about the failure.
SplitRunSummary._FinalStage	failureMessage(java.lang.String failureMessage)	A detailed message about the failure.
SplitRunSummary._FinalStage	failureMessage(java.util.Optional<java.lang.String> failureMessage)	A detailed message about the failure.
SplitRunSummary._FinalStage	failureReason(Nullable<java.lang.String> failureReason)	The reason for failure.
SplitRunSummary._FinalStage	failureReason(java.lang.String failureReason)	The reason for failure.
SplitRunSummary._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason for failure.
SplitRunSummary.DashboardUrlStage	file(FileSummary file)	The file that was processed.
SplitRunSummary.Builder	from(SplitRunSummary other)
SplitRunSummary.StatusStage	id(java.lang.String id)	The unique identifier for this split run.
SplitRunSummary._FinalStage	metadata(Nullable<java.util.Map<java.lang.String,java.lang.Object>> metadata)	Any metadata that was provided when creating the split run.
SplitRunSummary._FinalStage	metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)	Any metadata that was provided when creating the split run.
SplitRunSummary._FinalStage	metadata(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> metadata)	Any metadata that was provided when creating the split run.
SplitRunSummary._FinalStage	parseRunId(Nullable<java.lang.String> parseRunId)	The ID of the parse run that was used for this split run.
SplitRunSummary._FinalStage	parseRunId(java.lang.String parseRunId)	The ID of the parse run that was used for this split run.
SplitRunSummary._FinalStage	parseRunId(java.util.Optional<java.lang.String> parseRunId)	The ID of the parse run that was used for this split run.
SplitRunSummary.EditedStage	reviewed(boolean reviewed)	Indicates whether the run has been reviewed by a human.
SplitRunSummary._FinalStage	splitter(Nullable<SplitterSummary> splitter)	The splitter that was used for this run.
SplitRunSummary._FinalStage	splitter(SplitterSummary splitter)	The splitter that was used for this run.
SplitRunSummary._FinalStage	splitter(java.util.Optional<SplitterSummary> splitter)	The splitter that was used for this run.
SplitRunSummary._FinalStage	splitterVersion(Nullable<SplitterVersionSummary> splitterVersion)	The version of the splitter that was used for this run.
SplitRunSummary._FinalStage	splitterVersion(SplitterVersionSummary splitterVersion)	The version of the splitter that was used for this run.
SplitRunSummary._FinalStage	splitterVersion(java.util.Optional<SplitterVersionSummary> splitterVersion)	The version of the splitter that was used for this run.
SplitRunSummary.ReviewedStage	status(ProcessorRunStatus status)
SplitRunSummary._FinalStage	updatedAt(java.time.OffsetDateTime updatedAt)
SplitRunSummary._FinalStage	usage(Nullable<RunUsage> usage)	Usage credits consumed by this run.
SplitRunSummary._FinalStage	usage(RunUsage usage)	Usage credits consumed by this run.
SplitRunSummary._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 SplitRunSummary.Builder from(SplitRunSummary other)

Specified by:

from in interface SplitRunSummary.IdStage

id

public SplitRunSummary.StatusStage id(@NotNull
                                      java.lang.String id)

The unique identifier for this split run.

The unique identifier for this split run.

Specified by:

id in interface SplitRunSummary.IdStage

Returns:

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

status

public SplitRunSummary.ReviewedStage status(@NotNull
                                            ProcessorRunStatus status)

Specified by:

status in interface SplitRunSummary.StatusStage

reviewed

public SplitRunSummary.EditedStage reviewed(boolean reviewed)

Indicates whether the run has been reviewed by a human.

Indicates whether the run has been reviewed by a human.

Specified by:

reviewed in interface SplitRunSummary.ReviewedStage

Returns:

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

edited

public SplitRunSummary.FileStage edited(boolean edited)

Indicates whether the run results have been edited during review.

Indicates whether the run results have been edited during review.

Specified by:

edited in interface SplitRunSummary.EditedStage

Returns:

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

file

public SplitRunSummary.DashboardUrlStage file(@NotNull
                                              FileSummary file)

The file that was processed.

The file that was processed.

Specified by:

file in interface SplitRunSummary.FileStage

Returns:

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

dashboardUrl

public SplitRunSummary.CreatedAtStage dashboardUrl(@NotNull
                                                   java.lang.String dashboardUrl)

The URL to view the split run in the Extend dashboard.

The URL to view the split run in the Extend dashboard.

Specified by:

dashboardUrl in interface SplitRunSummary.DashboardUrlStage

Returns:

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

createdAt

public SplitRunSummary.UpdatedAtStage createdAt(@NotNull
                                                java.time.OffsetDateTime createdAt)

Specified by:

createdAt in interface SplitRunSummary.CreatedAtStage

updatedAt

public SplitRunSummary._FinalStage updatedAt(@NotNull
                                             java.time.OffsetDateTime updatedAt)

Specified by:

updatedAt in interface SplitRunSummary.UpdatedAtStage

usage

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

Usage credits consumed by this run.

Availability: Present when status is "PROCESSED".

Specified by:

usage in interface SplitRunSummary._FinalStage

Returns:

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

usage

public SplitRunSummary._FinalStage usage(RunUsage usage)

Usage credits consumed by this run.

Availability: Present when status is "PROCESSED".

Specified by:

usage in interface SplitRunSummary._FinalStage

Returns:

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

usage

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

Usage credits consumed by this run.

Availability: Present when status is "PROCESSED".

Specified by:

usage in interface SplitRunSummary._FinalStage

parseRunId

public SplitRunSummary._FinalStage parseRunId(Nullable<java.lang.String> parseRunId)

The ID of the parse run that was used for this split run.

Availability: Present when a parse run was created.

Specified by:

parseRunId in interface SplitRunSummary._FinalStage

Returns:

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

parseRunId

public SplitRunSummary._FinalStage parseRunId(java.lang.String parseRunId)

The ID of the parse run that was used for this split run.

Availability: Present when a parse run was created.

Specified by:

parseRunId in interface SplitRunSummary._FinalStage

Returns:

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

parseRunId

public SplitRunSummary._FinalStage parseRunId(java.util.Optional<java.lang.String> parseRunId)

The ID of the parse run that was used for this split run.

Availability: Present when a parse run was created.

Specified by:

parseRunId in interface SplitRunSummary._FinalStage

metadata

public SplitRunSummary._FinalStage metadata(Nullable<java.util.Map<java.lang.String,java.lang.Object>> metadata)

Any metadata that was provided when creating the split run.

Availability: Present when metadata was provided during creation.

Specified by:

metadata in interface SplitRunSummary._FinalStage

Returns:

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

metadata

public SplitRunSummary._FinalStage metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)

Any metadata that was provided when creating the split run.

Availability: Present when metadata was provided during creation.

Specified by:

metadata in interface SplitRunSummary._FinalStage

Returns:

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

metadata

public SplitRunSummary._FinalStage metadata(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> metadata)

Any metadata that was provided when creating the split run.

Availability: Present when metadata was provided during creation.

Specified by:

metadata in interface SplitRunSummary._FinalStage

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface SplitRunSummary._FinalStage

Returns:

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

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface SplitRunSummary._FinalStage

Returns:

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

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface SplitRunSummary._FinalStage

failureReason

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

The reason for failure.

Availability: Present when status is "FAILED".

Specified by:

failureReason in interface SplitRunSummary._FinalStage

Returns:

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

failureReason

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

The reason for failure.

Availability: Present when status is "FAILED".

Specified by:

failureReason in interface SplitRunSummary._FinalStage

Returns:

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

failureReason

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

The reason for failure.

Availability: Present when status is "FAILED".

Specified by:

failureReason in interface SplitRunSummary._FinalStage

splitterVersion

public SplitRunSummary._FinalStage splitterVersion(Nullable<SplitterVersionSummary> splitterVersion)

The version of the splitter that was used for this run.

Availability: Present when a splitter reference was provided. Not present when using inline config.

Specified by:

splitterVersion in interface SplitRunSummary._FinalStage

Returns:

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

splitterVersion

public SplitRunSummary._FinalStage splitterVersion(SplitterVersionSummary splitterVersion)

The version of the splitter that was used for this run.

Availability: Present when a splitter reference was provided. Not present when using inline config.

Specified by:

splitterVersion in interface SplitRunSummary._FinalStage

Returns:

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

splitterVersion

public SplitRunSummary._FinalStage splitterVersion(java.util.Optional<SplitterVersionSummary> splitterVersion)

The version of the splitter that was used for this run.

Availability: Present when a splitter reference was provided. Not present when using inline config.

Specified by:

splitterVersion in interface SplitRunSummary._FinalStage

splitter

public SplitRunSummary._FinalStage splitter(Nullable<SplitterSummary> splitter)

The splitter that was used for this run.

Availability: Present when a splitter reference was provided. Not present when using inline config.

Specified by:

splitter in interface SplitRunSummary._FinalStage

Returns:

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

splitter

public SplitRunSummary._FinalStage splitter(SplitterSummary splitter)

The splitter that was used for this run.

Availability: Present when a splitter reference was provided. Not present when using inline config.

Specified by:

splitter in interface SplitRunSummary._FinalStage

Returns:

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

splitter

public SplitRunSummary._FinalStage splitter(java.util.Optional<SplitterSummary> splitter)

The splitter that was used for this run.

Availability: Present when a splitter reference was provided. Not present when using inline config.

Specified by:

splitter in interface SplitRunSummary._FinalStage

build

public SplitRunSummary build()

Specified by:

build in interface SplitRunSummary._FinalStage