OvokException

public class OvokException extends RuntimeException

Base class of every exception the SDK throws; carries the API's error details when there is a response.

ConstructorsCopy Anchor Link

OvokExceptionCopy Anchor Link

public OvokException(String message)

Creates an exception with only a message.

Parameters:

• message: the error message

public OvokException(
        String message,
        Integer status,
        String code,
        String type,
        String traceId,
        String requestId,
        Duration retryAfter,
        String body,
        Throwable cause)

Creates an exception with the API's error details.

Parameters:

• message: the error message
• status: the HTTP status, or null
• code: the error code from the response body, or null
• type: the error type from the response body, or null
• traceId: the x-trace-id response header, or null
• requestId: the x-request-id response header, or null
• retryAfter: the Retry-After delay, or null
• body: the raw response body, or null
• cause: the underlying cause, or null

MethodsCopy Anchor Link

statusCopy Anchor Link

public Integer status()

Returns the HTTP status.

Returns: the status, or null when there was no response

codeCopy Anchor Link

public String code()

Returns the error code from the response body.

Returns: the code, or null

typeCopy Anchor Link

public String type()

Returns the error type from the response body.

Returns: the type, or null

traceIdCopy Anchor Link

public String traceId()

Returns the x-trace-id response header, for support requests.

Returns: the trace id, or null

requestIdCopy Anchor Link

public String requestId()

Returns the x-request-id response header, for support requests.

Returns: the request id, or null

retryAfterCopy Anchor Link

public Duration retryAfter()

Returns how long to wait before retrying, from the Retry-After header.

Returns: the delay, or null when the response did not set one

bodyCopy Anchor Link

public String body()

Returns the raw response body.

Returns: the body, or null