Exception ApiException (2.53.0)

public class ApiException extends RuntimeException

Represents an exception thrown during an RPC call.

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Throwable.addSuppressed(Throwable)

Throwable.fillInStackTrace()

Throwable.getCause()

Throwable.getLocalizedMessage()

Throwable.getMessage()

Throwable.getStackTrace()

Throwable.getSuppressed()

Throwable.initCause(Throwable)

Throwable.printStackTrace()

Throwable.printStackTrace(PrintStream)

Throwable.printStackTrace(PrintWriter)

Throwable.setStackTrace(StackTraceElement[])

Throwable.toString()

Constructors

ApiException(String message, Throwable cause, StatusCode statusCode, boolean retryable)

public ApiException(String message, Throwable cause, StatusCode statusCode, boolean retryable)

Parameters
Name	Description
`message`	`String`
`cause`	`Throwable`
`statusCode`	`StatusCode`
`retryable`	`boolean`

ApiException(Throwable cause, StatusCode statusCode, boolean retryable)

public ApiException(Throwable cause, StatusCode statusCode, boolean retryable)

Parameters
Name	Description
`cause`	`Throwable`
`statusCode`	`StatusCode`
`retryable`	`boolean`

ApiException(Throwable cause, StatusCode statusCode, boolean retryable, ErrorDetails errorDetails)

public ApiException(Throwable cause, StatusCode statusCode, boolean retryable, ErrorDetails errorDetails)

Parameters
Name	Description
`cause`	`Throwable`
`statusCode`	`StatusCode`
`retryable`	`boolean`
`errorDetails`	`ErrorDetails`

Methods

getDomain()

public String getDomain()

Returns the logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. e.g. googleapis.com

Returns
Type	Description
`String`

getErrorDetails()

public ErrorDetails getErrorDetails()

Returns all standard error messages that server sends.

Returns
Type	Description
`ErrorDetails`

getMetadata()

public Map<String,String> getMetadata()

Returns additional structured details about this exception.

Returns
Type	Description
`Map<String,String>`

getReason()

public String getReason()

Returns the reason of the exception. This is a constant value that identifies the proximate cause of the error. e.g. SERVICE_DISABLED

Returns
Type	Description
`String`

getStatusCode()

public StatusCode getStatusCode()

Returns the status code of the underlying exception.

Returns
Type	Description
`StatusCode`

isRetryable()

public boolean isRetryable()

Returns whether the failed request can be retried.

Returns
Type	Description
`boolean`