Class ErrorDetails (2.83.0)

2.83.0 (latest) 2.82.0 2.81.0 2.80.0 2.79.0 2.76.0 2.75.0 2.74.1 2.73.1 2.72.2 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

public abstract class ErrorDetails

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

Inheritance

java.lang.Object > ErrorDetails

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

builder()

public static ErrorDetails.Builder builder()

Returns
Type	Description
ErrorDetails.Builder

Constructors

ErrorDetails()

public ErrorDetails()

Methods

<T>getMessage(Class<T> messageClass)

public @Nullable 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
@org.jspecify.annotations.Nullable T

getBadRequest()

public @Nullable BadRequest getBadRequest()

Describes violations in a client request. This error type focuses on the syntactic aspects of the request.

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.rpc.BadRequest

getDebugInfo()

public @Nullable DebugInfo getDebugInfo()

Describes additional debugging info.

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.rpc.DebugInfo

getErrorInfo()

public @Nullable 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
@org.jspecify.annotations.Nullable com.google.rpc.ErrorInfo

getHelp()

public @Nullable Help getHelp()

Provides links to documentation or for performing an out-of-band action.

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.rpc.Help

getLocalizedMessage()

public @Nullable 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
@org.jspecify.annotations.Nullable com.google.rpc.LocalizedMessage

getPreconditionFailure()

public @Nullable PreconditionFailure getPreconditionFailure()

Describes what preconditions have failed.

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.rpc.PreconditionFailure

getQuotaFailure()

public @Nullable QuotaFailure getQuotaFailure()

Describes how a quota check failed.

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.rpc.QuotaFailure

getRequestInfo()

public @Nullable RequestInfo getRequestInfo()

Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.rpc.RequestInfo

getResourceInfo()

public @Nullable ResourceInfo getResourceInfo()

Describes the resource that is being accessed.

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.rpc.ResourceInfo

getRetryInfo()

public @Nullable 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
@org.jspecify.annotations.Nullable com.google.rpc.RetryInfo