Exception ApiException (2.69.0)
- 2.72.2 (latest)
- 2.72.1
- 2.71.0
- 2.70.3
- 2.69.0
- 2.68.2
- 2.67.0
- 2.66.0
- 2.65.0
- 2.63.1
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.1
- 2.58.0
- 2.57.0
- 2.55.0
- 2.54.1
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.1
- 2.47.0
- 2.46.1
- 2.45.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.1
- 2.33.0
- 2.32.1
- 2.31.1
- 2.30.1
- 2.24.0
- 2.23.3
- 2.22.0
- 2.21.0
- 2.20.1
- 2.19.6
- 2.18.7
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.2
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.1
- 2.7.1
publicclassApiExceptionextendsRuntimeExceptionRepresents an exception thrown during an RPC call.
Inherited Members
Constructors
ApiException(String message, Throwable cause, StatusCode statusCode, boolean retryable)
publicApiException(Stringmessage,Throwablecause,StatusCodestatusCode,booleanretryable)| Parameters | |
|---|---|
| Name | Description |
message | String |
cause | Throwable |
statusCode | StatusCode |
retryable | boolean |
ApiException(Throwable cause, StatusCode statusCode, boolean retryable)
publicApiException(Throwablecause,StatusCodestatusCode,booleanretryable)| Parameters | |
|---|---|
| Name | Description |
cause | Throwable |
statusCode | StatusCode |
retryable | boolean |
ApiException(Throwable cause, StatusCode statusCode, boolean retryable, ErrorDetails errorDetails)
publicApiException(Throwablecause,StatusCodestatusCode,booleanretryable,ErrorDetailserrorDetails)| Parameters | |
|---|---|
| Name | Description |
cause | Throwable |
statusCode | StatusCode |
retryable | boolean |
errorDetails | ErrorDetails |
Methods
getDomain()
publicStringgetDomain()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()
publicErrorDetailsgetErrorDetails()Returns all standard error messages that server sends.
| Returns | |
|---|---|
| Type | Description |
ErrorDetails | |
getMetadata()
publicMap<String,String>getMetadata()Returns additional structured details about this exception.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getReason()
publicStringgetReason()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()
publicStatusCodegetStatusCode()Returns the status code of the underlying exception.
| Returns | |
|---|---|
| Type | Description |
StatusCode | |
isRetryable()
publicbooleanisRetryable()Returns whether the failed request can be retried.
| Returns | |
|---|---|
| Type | Description |
boolean | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-17 UTC.