Package com.google.rpc

Class ErrorInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<ErrorInfo,ErrorInfo.Builder>
com.google.rpc.ErrorInfo
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, ErrorInfoOrBuilder
public final class ErrorInfo extends com.google.protobuf.GeneratedMessageLite<ErrorInfo,ErrorInfo.Builder> implements ErrorInfoOrBuilder
 Describes the cause of the error with structured details.

 Example of an error when contacting the "pubsub.googleapis.com" API when it
 is not enabled:

 { "reason": "API_DISABLED"
 "domain": "googleapis.com"
 "metadata": {
 "resource": "projects/123",
 "service": "pubsub.googleapis.com"
 }
 }

 This response indicates that the pubsub.googleapis.com API is not enabled.

 Example of an error that is returned when attempting to create a Spanner
 instance in a region that is out of stock:

 { "reason": "STOCKOUT"
 "domain": "spanner.googleapis.com",
 "metadata": {
 "availableRegions": "us-central1,us-east2"
 }
 }
Protobuf type google.rpc.ErrorInfo

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ErrorInfo.Builder
    Describes the cause of the error with structured details.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DOMAIN_FIELD_NUMBER
     
    static final int
    METADATA_FIELD_NUMBER
     
    static final int
    REASON_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsMetadata(String key)
    Additional structured details about this error.
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    static ErrorInfo
    getDefaultInstance()
     
    String
    getDomain()
    The logical grouping to which the "reason" belongs.
    com.google.protobuf.ByteString
    getDomainBytes()
    The logical grouping to which the "reason" belongs.
    Map<String,String>
    getMetadata()
    Deprecated.
    int
    getMetadataCount()
    Additional structured details about this error.
    Map<String,String>
    getMetadataMap()
    Additional structured details about this error.
    String
    getMetadataOrDefault(String key, String defaultValue)
    Additional structured details about this error.
    String
    getMetadataOrThrow(String key)
    Additional structured details about this error.
    String
    getReason()
    The reason of the error.
    com.google.protobuf.ByteString
    getReasonBytes()
    The reason of the error.
    static ErrorInfo.Builder
    newBuilder()
     
    static ErrorInfo.Builder
    newBuilder(ErrorInfo prototype)
     
    static ErrorInfo
    parseDelimitedFrom(InputStream input)
     
    static ErrorInfo
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ErrorInfo
    parseFrom(byte[] data)
     
    static ErrorInfo
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ErrorInfo
    parseFrom(com.google.protobuf.ByteString data)
     
    static ErrorInfo
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ErrorInfo
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ErrorInfo
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ErrorInfo
    parseFrom(InputStream input)
     
    static ErrorInfo
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ErrorInfo
    parseFrom(ByteBuffer data)
     
    static ErrorInfo
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ErrorInfo>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

  • Method Details

    • getReason

      public String getReason()
       The reason of the error. This is a constant value that identifies the
 proximate cause of the error. Error reasons are unique within a particular
 domain of errors. This should be at most 63 characters and match a
 regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents
 UPPER_SNAKE_CASE.
      string reason = 1 [json_name = "reason"];
      Specified by:
      getReason in interface ErrorInfoOrBuilder
      Returns:
      The reason.

    • getReasonBytes

      public com.google.protobuf.ByteString getReasonBytes()
       The reason of the error. This is a constant value that identifies the
 proximate cause of the error. Error reasons are unique within a particular
 domain of errors. This should be at most 63 characters and match a
 regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents
 UPPER_SNAKE_CASE.
      string reason = 1 [json_name = "reason"];
      Specified by:
      getReasonBytes in interface ErrorInfoOrBuilder
      Returns:
      The bytes for reason.

    • getDomain

      public String getDomain()
       The logical grouping to which the "reason" belongs. The error domain
 is typically the registered service name of the tool or product that
 generates the error. Example: "pubsub.googleapis.com". If the error is
 generated by some common infrastructure, the error domain must be a
 globally unique value that identifies the infrastructure. For Google API
 infrastructure, the error domain is "googleapis.com".
      string domain = 2 [json_name = "domain"];
      Specified by:
      getDomain in interface ErrorInfoOrBuilder
      Returns:
      The domain.

    • getDomainBytes

      public com.google.protobuf.ByteString getDomainBytes()
       The logical grouping to which the "reason" belongs. The error domain
 is typically the registered service name of the tool or product that
 generates the error. Example: "pubsub.googleapis.com". If the error is
 generated by some common infrastructure, the error domain must be a
 globally unique value that identifies the infrastructure. For Google API
 infrastructure, the error domain is "googleapis.com".
      string domain = 2 [json_name = "domain"];
      Specified by:
      getDomainBytes in interface ErrorInfoOrBuilder
      Returns:
      The bytes for domain.

    • getMetadataCount

      public int getMetadataCount()
      Description copied from interface: ErrorInfoOrBuilder
       Additional structured details about this error.

 Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadata = 3 [json_name = "metadata"];
      Specified by:
      getMetadataCount in interface ErrorInfoOrBuilder

    • containsMetadata

      public boolean containsMetadata(String key)
       Additional structured details about this error.

 Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadata = 3 [json_name = "metadata"];
      Specified by:
      containsMetadata in interface ErrorInfoOrBuilder

    • getMetadata

      @Deprecated public Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.
      Specified by:
      getMetadata in interface ErrorInfoOrBuilder

    • getMetadataMap

      public Map<String,String> getMetadataMap()
       Additional structured details about this error.

 Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadata = 3 [json_name = "metadata"];
      Specified by:
      getMetadataMap in interface ErrorInfoOrBuilder

    • getMetadataOrDefault

      public String getMetadataOrDefault(String key, String defaultValue)
       Additional structured details about this error.

 Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadata = 3 [json_name = "metadata"];
      Specified by:
      getMetadataOrDefault in interface ErrorInfoOrBuilder

    • getMetadataOrThrow

      public String getMetadataOrThrow(String key)
       Additional structured details about this error.

 Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should
 ideally be lowerCamelCase. Also, they must be limited to 64 characters in
 length. When identifying the current value of an exceeded limit, the units
 should be contained in the key, not the value.  For example, rather than
 `{"instanceLimit": "100/request"}`, should be returned as,
 `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
 instances that can be created in a single (batch) request.
      map<string, string> metadata = 3 [json_name = "metadata"];
      Specified by:
      getMetadataOrThrow in interface ErrorInfoOrBuilder

    • parseFrom

      public static ErrorInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ErrorInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ErrorInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ErrorInfo parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ErrorInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ErrorInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ErrorInfo parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ErrorInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ErrorInfo parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ErrorInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ErrorInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ErrorInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static ErrorInfo.Builder newBuilder()

    • newBuilder

      public static ErrorInfo.Builder newBuilder(ErrorInfo prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<ErrorInfo,ErrorInfo.Builder>

    • getDefaultInstance

      public static ErrorInfo getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ErrorInfo> parser()