Package ai.extend.types

Class ParseRunStatus.Builder

java.lang.Object

ai.extend.types.ParseRunStatus.Builder

All Implemented Interfaces:

ParseRunStatus._FinalStage, ParseRunStatus.IdStage, ParseRunStatus.StatusStage

Enclosing class:

ParseRunStatus

public static final class ParseRunStatus.Builder
extends java.lang.Object
implements ParseRunStatus.IdStage, ParseRunStatus.StatusStage, ParseRunStatus._FinalStage

Method Summary

Modifier and Type	Method	Description
ParseRunStatus	build()
ParseRunStatus._FinalStage	failureMessage(Nullable<java.lang.String> failureMessage)	A human-readable description of the failure.
ParseRunStatus._FinalStage	failureMessage(java.lang.String failureMessage)	A human-readable description of the failure.
ParseRunStatus._FinalStage	failureMessage(java.util.Optional<java.lang.String> failureMessage)	A human-readable description of the failure.
ParseRunStatus._FinalStage	failureReason(Nullable<java.lang.String> failureReason)	The reason for failure.
ParseRunStatus._FinalStage	failureReason(java.lang.String failureReason)	The reason for failure.
ParseRunStatus._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason for failure.
ParseRunStatus.Builder	from(ParseRunStatus other)
ParseRunStatus.StatusStage	id(java.lang.String id)	A unique identifier for the parse run.
ParseRunStatus._FinalStage	metadata(Nullable<java.util.Map<java.lang.String,java.lang.Object>> metadata)	Any metadata that was provided when creating the parse run.
ParseRunStatus._FinalStage	metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)	Any metadata that was provided when creating the parse run.
ParseRunStatus._FinalStage	metadata(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> metadata)	Any metadata that was provided when creating the parse run.
ParseRunStatus._FinalStage	status(ParseRunStatusStatus status)	The status of the parse run:

Methods inherited from class java.lang.Object

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

Method Detail

from

public ParseRunStatus.Builder from(ParseRunStatus other)

Specified by:

from in interface ParseRunStatus.IdStage

id

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

A unique identifier for the parse run.

Example: "pr_xK9mLPqRtN3vS8wF5hB2cQ"

A unique identifier for the parse run.

Example: "pr_xK9mLPqRtN3vS8wF5hB2cQ"

Specified by:

id in interface ParseRunStatus.IdStage

Returns:

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

status

public ParseRunStatus._FinalStage status(@NotNull
                                         ParseRunStatusStatus status)

The status of the parse run:

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

The status of the parse run:

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

Specified by:

status in interface ParseRunStatus.StatusStage

Returns:

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

metadata

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

Any metadata that was provided when creating the parse run.

Availability: Present when metadata was provided during creation.

Specified by:

metadata in interface ParseRunStatus._FinalStage

Returns:

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

metadata

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

Any metadata that was provided when creating the parse run.

Availability: Present when metadata was provided during creation.

Specified by:

metadata in interface ParseRunStatus._FinalStage

Returns:

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

metadata

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

Any metadata that was provided when creating the parse run.

Availability: Present when metadata was provided during creation.

Specified by:

metadata in interface ParseRunStatus._FinalStage

failureMessage

public ParseRunStatus._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 ParseRunStatus._FinalStage

Returns:

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

failureMessage

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

A human-readable description of the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface ParseRunStatus._FinalStage

Returns:

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

failureMessage

public ParseRunStatus._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 ParseRunStatus._FinalStage

failureReason

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

The reason for failure.

Availability: Present when status is "FAILED".

Specified by:

failureReason in interface ParseRunStatus._FinalStage

Returns:

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

failureReason

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

The reason for failure.

Availability: Present when status is "FAILED".

Specified by:

failureReason in interface ParseRunStatus._FinalStage

Returns:

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

failureReason

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

The reason for failure.

Availability: Present when status is "FAILED".

Specified by:

failureReason in interface ParseRunStatus._FinalStage

build

public ParseRunStatus build()

Specified by:

build in interface ParseRunStatus._FinalStage