com.google.rpc

类 ErrorInfo.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<ErrorInfo.Builder>

com.google.rpc.ErrorInfo.Builder

所有已实现的接口:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ErrorInfoOrBuilder, Cloneable

封闭类:

ErrorInfo

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

方法概要

限定符和类型	方法和说明
ErrorInfo	build()
ErrorInfo	buildPartial()
ErrorInfo.Builder	clear()
ErrorInfo.Builder	clearDomain() The logical grouping to which the "reason" belongs.
ErrorInfo.Builder	clearMetadata()
ErrorInfo.Builder	clearReason() The reason of the error.
boolean	containsMetadata(String key) Additional structured details about this error.
ErrorInfo	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
Map<String,String>	getMutableMetadata() 已过时。
String	getReason() The reason of the error.
com.google.protobuf.ByteString	getReasonBytes() The reason of the error.
boolean	isInitialized()
ErrorInfo.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ErrorInfo.Builder	mergeFrom(ErrorInfo other)
ErrorInfo.Builder	mergeFrom(com.google.protobuf.Message other)
ErrorInfo.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ErrorInfo.Builder	putAllMetadata(Map<String,String> values) Additional structured details about this error.
ErrorInfo.Builder	putMetadata(String key, String value) Additional structured details about this error.
ErrorInfo.Builder	removeMetadata(String key) Additional structured details about this error.
ErrorInfo.Builder	setDomain(String value) The logical grouping to which the "reason" belongs.
ErrorInfo.Builder	setDomainBytes(com.google.protobuf.ByteString value) The logical grouping to which the "reason" belongs.
ErrorInfo.Builder	setReason(String value) The reason of the error.
ErrorInfo.Builder	setReasonBytes(com.google.protobuf.ByteString value) The reason of the error.
ErrorInfo.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, newBuilderForField, setField, setRepeatedField

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

findInitializationErrors, getInitializationErrorString, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, toString

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

mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

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

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

方法详细资料

getDescriptor

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

clear

public ErrorInfo.Builder clear()

指定者:

clear 在接口中 com.google.protobuf.Message.Builder

指定者:

clear 在接口中 com.google.protobuf.MessageLite.Builder

覆盖:

clear 在类中 com.google.protobuf.GeneratedMessageV3.Builder<ErrorInfo.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

指定者:

getDescriptorForType 在接口中 com.google.protobuf.Message.Builder

指定者:

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

覆盖:

getDescriptorForType 在类中 com.google.protobuf.GeneratedMessageV3.Builder<ErrorInfo.Builder>

getDefaultInstanceForType

public ErrorInfo getDefaultInstanceForType()

指定者:

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

指定者:

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

build

public ErrorInfo build()

指定者:

build 在接口中 com.google.protobuf.Message.Builder

指定者:

build 在接口中 com.google.protobuf.MessageLite.Builder

buildPartial

public ErrorInfo buildPartial()

指定者:

buildPartial 在接口中 com.google.protobuf.Message.Builder

指定者:

buildPartial 在接口中 com.google.protobuf.MessageLite.Builder

mergeFrom

public ErrorInfo.Builder mergeFrom(com.google.protobuf.Message other)

指定者:

mergeFrom 在接口中 com.google.protobuf.Message.Builder

覆盖:

mergeFrom 在类中 com.google.protobuf.AbstractMessage.Builder<ErrorInfo.Builder>

mergeFrom

public ErrorInfo.Builder mergeFrom(ErrorInfo other)

isInitialized

public final boolean isInitialized()

指定者:

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

覆盖:

isInitialized 在类中 com.google.protobuf.GeneratedMessageV3.Builder<ErrorInfo.Builder>

mergeFrom

public ErrorInfo.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

指定者:

mergeFrom 在接口中 com.google.protobuf.Message.Builder

指定者:

mergeFrom 在接口中 com.google.protobuf.MessageLite.Builder

覆盖:

mergeFrom 在类中 com.google.protobuf.AbstractMessage.Builder<ErrorInfo.Builder>

抛出:

IOException

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.

setReason

public ErrorInfo.Builder setReason(String value)

 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;

参数:

value - The reason to set.

返回:

This builder for chaining.

clearReason

public ErrorInfo.Builder clearReason()

 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;

返回:

This builder for chaining.

setReasonBytes

public ErrorInfo.Builder setReasonBytes(com.google.protobuf.ByteString value)

 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;

参数:

value - The bytes for reason to set.

返回:

This builder for chaining.

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.

setDomain

public ErrorInfo.Builder setDomain(String value)

 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;

参数:

value - The domain to set.

返回:

This builder for chaining.

clearDomain

public ErrorInfo.Builder clearDomain()

 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;

返回:

This builder for chaining.

setDomainBytes

public ErrorInfo.Builder setDomainBytes(com.google.protobuf.ByteString value)

 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;

参数:

value - The bytes for domain to set.

返回:

This builder for chaining.

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

clearMetadata

public ErrorInfo.Builder clearMetadata()

removeMetadata

public ErrorInfo.Builder removeMetadata(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;

getMutableMetadata

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

已过时。

Use alternate mutation accessors instead.

putMetadata

public ErrorInfo.Builder putMetadata(String key,
                                     String value)

 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;

putAllMetadata

public ErrorInfo.Builder putAllMetadata(Map<String,String> values)

 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;

setUnknownFields

public final ErrorInfo.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

指定者:

setUnknownFields 在接口中 com.google.protobuf.Message.Builder

覆盖:

setUnknownFields 在类中 com.google.protobuf.GeneratedMessageV3.Builder<ErrorInfo.Builder>

mergeUnknownFields

public final ErrorInfo.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

指定者:

mergeUnknownFields 在接口中 com.google.protobuf.Message.Builder

覆盖:

mergeUnknownFields 在类中 com.google.protobuf.GeneratedMessageV3.Builder<ErrorInfo.Builder>