Send feedback
Exception ApiException (2.23.3) Stay organized with collections
Save and categorize content based on your preferences.
Version 2.23.3 keyboard_arrow_down
public
class
ApiException
extends
RuntimeException
Represents an exception thrown during an RPC call.
Constructors
ApiException(String message, Throwable cause, StatusCode statusCode, boolean retryable)
public
ApiException
(
String
message
,
Throwable
cause
,
StatusCode
statusCode
,
boolean
retryable
)
Parameters
ApiException(Throwable cause, StatusCode statusCode, boolean retryable)
public
ApiException
(
Throwable
cause
,
StatusCode
statusCode
,
boolean
retryable
)
Parameters
ApiException(Throwable cause, StatusCode statusCode, boolean retryable, ErrorDetails errorDetails)
public
ApiException
(
Throwable
cause
,
StatusCode
statusCode
,
boolean
retryable
,
ErrorDetails
errorDetails
)
Parameters
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
getErrorDetails()
public
ErrorDetails
getErrorDetails
()
Returns all standard error messages that server sends.
Returns
public
Map<String
,
String
> getMetadata
()
Returns additional structured details about this exception.
Returns
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
getStatusCode()
public
StatusCode
getStatusCode
()
Returns the status code of the underlying exception.
Returns
isRetryable()
public
boolean
isRetryable
()
Returns whether the failed request can be retried.
Returns
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
