Package com.google.api.gax.rpc

Class ErrorDetails

  • public abstract class ErrorDetails
extends java.lang.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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ErrorDetails.Builder builder()  
      com.google.rpc.BadRequest getBadRequest()
      Describes violations in a client request.
      com.google.rpc.DebugInfo getDebugInfo()
      Describes additional debugging info.
      com.google.rpc.ErrorInfo getErrorInfo()
      This is the most important and special error message.
      com.google.rpc.Help getHelp()
      Provides links to documentation or for performing an out-of-band action.
      com.google.rpc.LocalizedMessage getLocalizedMessage()
      Provides a localized error message that is safe to return to the user which can be attached to an RPC error
      com.google.rpc.PreconditionFailure getPreconditionFailure()
      Describes what preconditions have failed.
      com.google.rpc.QuotaFailure getQuotaFailure()
      Describes how a quota check failed.
      com.google.rpc.RequestInfo getRequestInfo()
      Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.
      com.google.rpc.ResourceInfo getResourceInfo()
      Describes the resource that is being accessed.
      com.google.rpc.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 Detail

      • ErrorDetails

        public ErrorDetails()

    • Method Detail

      • getErrorInfo

        @Nullable
public com.google.rpc.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 com.google.rpc.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 com.google.rpc.DebugInfo getDebugInfo()
        Describes additional debugging info.

      • getQuotaFailure

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

      • getPreconditionFailure

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

      • getBadRequest

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

      • getRequestInfo

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

      • getResourceInfo

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

      • getHelp

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

      • getLocalizedMessage

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