com.google.rpc

类 ErrorInfo

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.rpc.ErrorInfo

所有已实现的接口:

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

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	ErrorInfo.Builder Describes the cause of the error with structured details.

从类继承的嵌套类/接口 com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

字段概要

字段

限定符和类型	字段和说明
static int	DOMAIN_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER
static int	REASON_FIELD_NUMBER

方法概要

限定符和类型	方法和说明
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() 已过时。
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()
int	hashCode()
boolean	isInitialized()
static ErrorInfo.Builder	newBuilder()
static ErrorInfo.Builder	newBuilder(ErrorInfo prototype)
ErrorInfo.Builder	newBuilderForType()
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(ByteBuffer data)
static ErrorInfo	parseFrom(ByteBuffer 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 com.google.protobuf.Parser<ErrorInfo>	parser()
ErrorInfo.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

从类继承的方法 com.google.protobuf.GeneratedMessageV3

getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

从类继承的方法 com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, toString

从类继承的方法 com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

从接口继承的方法 com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

字段详细资料

REASON_FIELD_NUMBER

public static final int REASON_FIELD_NUMBER

另请参阅:

常量字段值

DOMAIN_FIELD_NUMBER

public static final int DOMAIN_FIELD_NUMBER

另请参阅:

常量字段值

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

另请参阅:

常量字段值

方法详细资料

getDescriptor

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

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-Z0-9_]+/.
 

string reason = 1;

指定者:

getReason 在接口中 ErrorInfoOrBuilder

返回:

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-Z0-9_]+/.
 

string reason = 1;

指定者:

getReasonBytes 在接口中 ErrorInfoOrBuilder

返回:

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;

指定者:

getDomain 在接口中 ErrorInfoOrBuilder

返回:

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;

指定者:

getDomainBytes 在接口中 ErrorInfoOrBuilder

返回:

The bytes for domain.

getMetadataCount

public int getMetadataCount()

从接口复制的说明: ErrorInfoOrBuilder

 Additional structured details about this error.

 Keys should match /[a-zA-Z0-9-_]/ and 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;

指定者:

getMetadataCount 在接口中 ErrorInfoOrBuilder

containsMetadata

public boolean containsMetadata(String key)

 Additional structured details about this error.

 Keys should match /[a-zA-Z0-9-_]/ and 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;

指定者:

containsMetadata 在接口中 ErrorInfoOrBuilder

getMetadata

@Deprecated
public Map<String,String> getMetadata()

已过时。

Use getMetadataMap() instead.

指定者:

getMetadata 在接口中 ErrorInfoOrBuilder

getMetadataMap

public Map<String,String> getMetadataMap()

 Additional structured details about this error.

 Keys should match /[a-zA-Z0-9-_]/ and 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;

指定者:

getMetadataMap 在接口中 ErrorInfoOrBuilder

getMetadataOrDefault

public String getMetadataOrDefault(String key,
                                   String defaultValue)

 Additional structured details about this error.

 Keys should match /[a-zA-Z0-9-_]/ and 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;

指定者:

getMetadataOrDefault 在接口中 ErrorInfoOrBuilder

getMetadataOrThrow

public String getMetadataOrThrow(String key)

 Additional structured details about this error.

 Keys should match /[a-zA-Z0-9-_]/ and 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;

指定者:

getMetadataOrThrow 在接口中 ErrorInfoOrBuilder

isInitialized

public final boolean isInitialized()

指定者:

isInitialized 在接口中 com.google.protobuf.MessageLiteOrBuilder

覆盖:

isInitialized 在类中 com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

指定者:

writeTo 在接口中 com.google.protobuf.MessageLite

覆盖:

writeTo 在类中 com.google.protobuf.GeneratedMessageV3

抛出:

IOException

getSerializedSize

public int getSerializedSize()

指定者:

getSerializedSize 在接口中 com.google.protobuf.MessageLite

覆盖:

getSerializedSize 在类中 com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

指定者:

equals 在接口中 com.google.protobuf.Message

覆盖:

equals 在类中 com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

指定者:

hashCode 在接口中 com.google.protobuf.Message

覆盖:

hashCode 在类中 com.google.protobuf.AbstractMessage

parseFrom

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

抛出:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

抛出:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

抛出:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

抛出:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

抛出:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

抛出:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ErrorInfo parseFrom(InputStream input)
                           throws IOException

抛出:

IOException

parseFrom

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

抛出:

IOException

parseDelimitedFrom

public static ErrorInfo parseDelimitedFrom(InputStream input)
                                    throws IOException

抛出:

IOException

parseDelimitedFrom

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

抛出:

IOException

parseFrom

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

抛出:

IOException

parseFrom

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

抛出:

IOException

newBuilderForType

public ErrorInfo.Builder newBuilderForType()

指定者:

newBuilderForType 在接口中 com.google.protobuf.Message

指定者:

newBuilderForType 在接口中 com.google.protobuf.MessageLite

newBuilder

public static ErrorInfo.Builder newBuilder()

newBuilder

public static ErrorInfo.Builder newBuilder(ErrorInfo prototype)

toBuilder

public ErrorInfo.Builder toBuilder()

指定者:

toBuilder 在接口中 com.google.protobuf.Message

指定者:

toBuilder 在接口中 com.google.protobuf.MessageLite

getDefaultInstance

public static ErrorInfo getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ErrorInfo> getParserForType()

指定者:

getParserForType 在接口中 com.google.protobuf.Message

指定者:

getParserForType 在接口中 com.google.protobuf.MessageLite

覆盖:

getParserForType 在类中 com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ErrorInfo getDefaultInstanceForType()

指定者:

getDefaultInstanceForType 在接口中 com.google.protobuf.MessageLiteOrBuilder

指定者:

getDefaultInstanceForType 在接口中 com.google.protobuf.MessageOrBuilder