Class ErrorDetails (2.70.3)
public abstract class ErrorDetails
This class contains a list of standard error messages that returns from server.
Static Methods
builder()
public static ErrorDetails.Builder builder()
Constructors
ErrorDetails()
Methods
<T>getMessage(Class<T> messageClass)
public T <T>getMessage(Class<T> messageClass)
Attempt to unpack a non-default error message type T
. The first occurrence of a
T
is returned, null otherwise.
Parameter |
Name |
Description |
messageClass |
Class<T>
|
Returns |
Type |
Description |
T |
|
getBadRequest()
public BadRequest getBadRequest()
Describes violations in a client request. This error type focuses on the syntactic aspects of
the request.
Returns |
Type |
Description |
com.google.rpc.BadRequest |
|
getDebugInfo()
public DebugInfo getDebugInfo()
Describes additional debugging info.
Returns |
Type |
Description |
com.google.rpc.DebugInfo |
|
getErrorInfo()
public ErrorInfo getErrorInfo()
This is the most important and special error message. It describes the cause of the error with
structured details that both humans and applications can depend on.
Returns |
Type |
Description |
com.google.rpc.ErrorInfo |
|
getHelp()
Provides links to documentation or for performing an out-of-band action.
Returns |
Type |
Description |
com.google.rpc.Help |
|
getLocalizedMessage()
public LocalizedMessage getLocalizedMessage()
Provides a localized error message that is safe to return to the user which can be attached to
an RPC error
Returns |
Type |
Description |
com.google.rpc.LocalizedMessage |
|
getPreconditionFailure()
public PreconditionFailure getPreconditionFailure()
Describes what preconditions have failed.
Returns |
Type |
Description |
com.google.rpc.PreconditionFailure |
|
getQuotaFailure()
public QuotaFailure getQuotaFailure()
Describes how a quota check failed.
Returns |
Type |
Description |
com.google.rpc.QuotaFailure |
|
getRequestInfo()
public RequestInfo getRequestInfo()
Contains metadata about the request that clients can attach when filing a bug or providing
other forms of feedback.
Returns |
Type |
Description |
com.google.rpc.RequestInfo |
|
getResourceInfo()
public ResourceInfo getResourceInfo()
Describes the resource that is being accessed.
Returns |
Type |
Description |
com.google.rpc.ResourceInfo |
|
getRetryInfo()
public RetryInfo getRetryInfo()
Describes when the clients can retry a failed request. Clients could ignore the recommendation
here or retry when this information is missing from error responses.
Returns |
Type |
Description |
com.google.rpc.RetryInfo |
|
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-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-10 UTC."],[],[]]