ApiError (extend-java-sdk 1.18.0 API)

java.lang.Object
- ai.extend.types.ApiError

public final class ApiError
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`ApiError._FinalStage`
`static class`	`ApiError.Builder`
`static interface`	`ApiError.CodeStage`
`static interface`	`ApiError.MessageStage`
`static interface`	`ApiError.RetryableStage`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ApiError.CodeStage`	`builder()`
`boolean`	`equals(java.lang.Object other)`
`java.util.Map<java.lang.String,java.lang.Object>`	`getAdditionalProperties()`
`java.lang.String`	`getCode()`
`java.util.Optional<java.lang.String>`	`getDocUrl()`
`java.lang.String`	`getMessage()`
`java.util.Optional<java.lang.String>`	`getRequestId()`
`boolean`	`getRetryable()`
`int`	`hashCode()`
`java.lang.String`	`toString()`

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

- Method Detail
  - getCode
```
public java.lang.String getCode()
```
    Returns:
    
    Error code for programmatic handling.
  - getMessage
```
public java.lang.String getMessage()
```
    Returns:
    
    Human-readable error message suitable for displaying to developers. Do not rely on the exact text of this message as it may change.
  - getRetryable
```
public boolean getRetryable()
```
    Returns:
    
    Whether the request can be retried. When true, retry with exponential backoff. When false, fix the underlying issue before retrying.
  - getRequestId
```
public java.util.Optional<java.lang.String> getRequestId()
```
    Returns:
    
    Unique request identifier for support purposes. Always include this when contacting Extend support about an error.
  - getDocUrl
```
public java.util.Optional<java.lang.String> getDocUrl()
```
    Returns:
    
    Link to relevant documentation when one is available.
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - getAdditionalProperties
```
public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - builder
```
public static ApiError.CodeStage builder()
```