Package com.google.api.gax.rpc

Class ErrorDetails

java.lang.Object
com.google.api.gax.rpc.ErrorDetails
public abstract class ErrorDetails extends Object
This class contains a list of standard error messages that returns from server.

  • Constructor Details

    • ErrorDetails

      public ErrorDetails()

  • Method Details

    • getErrorInfo

      @Nullable 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.

    • getRetryInfo

      @Nullable 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.

    • getDebugInfo

      @Nullable public DebugInfo getDebugInfo()
      Describes additional debugging info.

    • getQuotaFailure

      @Nullable public QuotaFailure getQuotaFailure()
      Describes how a quota check failed.

    • getPreconditionFailure

      @Nullable public PreconditionFailure getPreconditionFailure()
      Describes what preconditions have failed.

    • getBadRequest

      @Nullable public BadRequest getBadRequest()
      Describes violations in a client request. This error type focuses on the syntactic aspects of the request.

    • getRequestInfo

      @Nullable public RequestInfo getRequestInfo()
      Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.

    • getResourceInfo

      @Nullable public ResourceInfo getResourceInfo()
      Describes the resource that is being accessed.

    • getHelp

      @Nullable public Help getHelp()
      Provides links to documentation or for performing an out-of-band action.

    • getLocalizedMessage

      @Nullable public LocalizedMessage getLocalizedMessage()
      Provides a localized error message that is safe to return to the user which can be attached to an RPC error

    • getMessage

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