Package com.google.api.gax.rpc

Class ErrorDetails

java.lang.Object

com.google.api.gax.rpc.ErrorDetails

@NullMarked
public abstract class ErrorDetails
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ErrorDetails.Builder

Constructor Summary

Constructors

Constructor	Description
ErrorDetails()

Method Summary

Modifier and Type	Method	Description
static ErrorDetails.Builder	builder()
@Nullable BadRequest	getBadRequest()	Describes violations in a client request.
@Nullable DebugInfo	getDebugInfo()	Describes additional debugging info.
@Nullable ErrorInfo	getErrorInfo()	This is the most important and special error message.
@Nullable Help	getHelp()	Provides links to documentation or for performing an out-of-band action.
@Nullable LocalizedMessage	getLocalizedMessage()	Provides a localized error message that is safe to return to the user which can be attached to an RPC error
<T extends com.google.protobuf.Message> @Nullable T	getMessage(Class<T> messageClass)	Attempt to unpack a non-default error message type T.
@Nullable PreconditionFailure	getPreconditionFailure()	Describes what preconditions have failed.
@Nullable QuotaFailure	getQuotaFailure()	Describes how a quota check failed.
@Nullable RequestInfo	getRequestInfo()	Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.
@Nullable ResourceInfo	getResourceInfo()	Describes the resource that is being accessed.
@Nullable RetryInfo	getRetryInfo()	Describes when the clients can retry a failed request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ErrorDetails

public ErrorDetails()

Method Details

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.

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.

getDebugInfo

public @Nullable DebugInfo getDebugInfo()

Describes additional debugging info.

getQuotaFailure

public @Nullable QuotaFailure getQuotaFailure()

Describes how a quota check failed.

getPreconditionFailure

public @Nullable PreconditionFailure getPreconditionFailure()

Describes what preconditions have failed.

getBadRequest

public @Nullable BadRequest getBadRequest()

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

getRequestInfo

public @Nullable RequestInfo getRequestInfo()

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

getResourceInfo

public @Nullable ResourceInfo getResourceInfo()

Describes the resource that is being accessed.

getHelp

public @Nullable Help getHelp()

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

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

getMessage

public <T extends com.google.protobuf.Message>
@Nullable 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.

builder

public static ErrorDetails.Builder builder()