Class ErrorDetails (2.57.0)

  public 
  
 abstract 
  
 class 
 ErrorDetails 
 

This class contains a list of standard error messages that returns from server.

Inheritance

java.lang.Object > ErrorDetails

Static Methods

builder()

  public 
  
 static 
  
 ErrorDetails 
 . 
 Builder 
  
 builder 
 () 
 
Returns
Type
Description

Constructors

ErrorDetails()

  public 
  
 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()

  public 
  
 Help 
  
 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
Create a Mobile Website
View Site in Mobile | Classic
Share by: