com.google.rpc

Interface ErrorInfoOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ErrorInfo, ErrorInfo.Builder

public interface ErrorInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsMetadata(String key) Additional structured details about this error.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getReason

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;

Returns:

The reason.

getReasonBytes

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;

Returns:

The bytes for reason.

getDomain

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;

Returns:

The domain.

getDomainBytes

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;

Returns:

The bytes for domain.

getMetadataCount

int getMetadataCount()

 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

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;

getMetadata

@Deprecated
Map<String,String> getMetadata()

Deprecated.

Use getMetadataMap() instead.

getMetadataMap

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;

getMetadataOrDefault

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;

getMetadataOrThrow

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;