Package ai.extend.types

Class ApiError.Builder

java.lang.Object

ai.extend.types.ApiError.Builder

All Implemented Interfaces:

ApiError._FinalStage, ApiError.CodeStage, ApiError.MessageStage, ApiError.RetryableStage

Enclosing class:

ApiError

public static final class ApiError.Builder
extends java.lang.Object
implements ApiError.CodeStage, ApiError.MessageStage, ApiError.RetryableStage, ApiError._FinalStage

Method Summary

Modifier and Type	Method	Description
ApiError	build()
ApiError.MessageStage	code(java.lang.String code)	Error code for programmatic handling.
ApiError._FinalStage	docUrl(java.lang.String docUrl)	Link to relevant documentation when one is available.
ApiError._FinalStage	docUrl(java.util.Optional<java.lang.String> docUrl)	Link to relevant documentation when one is available.
ApiError.Builder	from(ApiError other)
ApiError.RetryableStage	message(java.lang.String message)	Human-readable error message suitable for displaying to developers.
ApiError._FinalStage	requestId(java.lang.String requestId)	Unique request identifier for support purposes.
ApiError._FinalStage	requestId(java.util.Optional<java.lang.String> requestId)	Unique request identifier for support purposes.
ApiError._FinalStage	retryable(boolean retryable)	Whether the request can be retried.

Methods inherited from class java.lang.Object

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

Method Detail

from

public ApiError.Builder from(ApiError other)

Specified by:

from in interface ApiError.CodeStage

code

public ApiError.MessageStage code(@NotNull
                                  java.lang.String code)

Error code for programmatic handling.

Error code for programmatic handling.

Specified by:

code in interface ApiError.CodeStage

Returns:

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

message

public ApiError.RetryableStage message(@NotNull
                                       java.lang.String message)

Human-readable error message suitable for displaying to developers. Do not rely on the exact text of this message as it may change.

Human-readable error message suitable for displaying to developers. Do not rely on the exact text of this message as it may change.

Specified by:

message in interface ApiError.MessageStage

Returns:

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

retryable

public ApiError._FinalStage retryable(boolean retryable)

Whether the request can be retried. When true, retry with exponential backoff. When false, fix the underlying issue before retrying.

Whether the request can be retried. When true, retry with exponential backoff. When false, fix the underlying issue before retrying.

Specified by:

retryable in interface ApiError.RetryableStage

Returns:

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

docUrl

public ApiError._FinalStage docUrl(java.lang.String docUrl)

Link to relevant documentation when one is available.

Specified by:

docUrl in interface ApiError._FinalStage

Returns:

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

docUrl

public ApiError._FinalStage docUrl(java.util.Optional<java.lang.String> docUrl)

Link to relevant documentation when one is available.

Specified by:

docUrl in interface ApiError._FinalStage

requestId

public ApiError._FinalStage requestId(java.lang.String requestId)

Unique request identifier for support purposes. Always include this when contacting Extend support about an error.

Specified by:

requestId in interface ApiError._FinalStage

Returns:

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

requestId

public ApiError._FinalStage requestId(java.util.Optional<java.lang.String> requestId)

Unique request identifier for support purposes. Always include this when contacting Extend support about an error.

Specified by:

requestId in interface ApiError._FinalStage

build

public ApiError build()

Specified by:

build in interface ApiError._FinalStage