java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.rpc.ErrorInfo

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ErrorInfoOrBuilder, Serializable

public final class ErrorInfo
extends com.google.protobuf.GeneratedMessageV3
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

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ErrorInfo.Builder
Describes the cause of the error with structured details.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type Field Description

static int DOMAIN_FIELD_NUMBER

static int METADATA_FIELD_NUMBER

static int REASON_FIELD_NUMBER
- Fields inherited from class com.google.protobuf.GeneratedMessageV3
  alwaysUseFieldBuilders, unknownFields
- Fields inherited from class com.google.protobuf.AbstractMessage
  memoizedSize
- Fields inherited from class com.google.protobuf.AbstractMessageLite
  memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`containsMetadata(String key)`	Additional structured details about this error.
`boolean`	`equals(Object obj)`
`static ErrorInfo`	`getDefaultInstance()`
`ErrorInfo`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.Parser<ErrorInfo>`	`getParserForType()`
`String`	`getReason()`	The reason of the error.
`com.google.protobuf.ByteString`	`getReasonBytes()`	The reason of the error.
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static ErrorInfo.Builder`	`newBuilder()`
`static ErrorInfo.Builder`	`newBuilder(ErrorInfo prototype)`
`ErrorInfo.Builder`	`newBuilderForType()`
`protected ErrorInfo.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`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()`
`ErrorInfo.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, 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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Detail
- REASON_FIELD_NUMBER
```
public static final int REASON_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DOMAIN_FIELD_NUMBER
```
public static final int DOMAIN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- METADATA_FIELD_NUMBER
```
public static final int METADATA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

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;

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;

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;

Specified by:: getDomainBytes in interface ErrorInfoOrBuilder
Returns:: The bytes for domain.