Class ErrorInfo (2.15.0)

Version latest

• 2.15.0 (latest)
• 2.10.0
• 2.2.0

public sealed class ErrorInfo : IMessage<ErrorInfo>, IEquatable<ErrorInfo>, IDeepCloneable<ErrorInfo>, IBufferMessage, IMessage

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"
  }
}

Inheritance

object > ErrorInfo

Implements

IMessageErrorInfo, IEquatableErrorInfo, IDeepCloneableErrorInfo, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Rpc

Assembly

Google.Api.CommonProtos.dll

Constructors

ErrorInfo()

public ErrorInfo()

ErrorInfo(ErrorInfo)

public ErrorInfo(ErrorInfo other)

Parameter
Name	Description
other	ErrorInfo

Fields

DomainFieldNumber

public const int DomainFieldNumber = 2

Field number for the "domain" field.

Field Value
Type	Description
int

MetadataFieldNumber

public const int MetadataFieldNumber = 3

Field number for the "metadata" field.

Field Value
Type	Description
int

ReasonFieldNumber

public const int ReasonFieldNumber = 1

Field number for the "reason" field.

Field Value
Type	Description
int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
MessageDescriptor

Domain

public string Domain { get; set; }

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".

Property Value
Type	Description
string

Metadata

public MapField<string, string> Metadata { get; }

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.

Property Value
Type	Description
MapFieldstringstring

Parser

public static MessageParser<ErrorInfo> Parser { get; }

Property Value
Type	Description
MessageParserErrorInfo

Reason

public string Reason { get; set; }

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.

Property Value
Type	Description
string

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type	Description
int	The number of bytes required to write this message to a coded output stream.

Clone()

public ErrorInfo Clone()

Creates a deep clone of this object.

Returns
Type	Description
ErrorInfo	A deep clone of this object.

Equals(ErrorInfo)

public bool Equals(ErrorInfo other)

Parameter
Name	Description
other	ErrorInfo

Returns
Type	Description
bool

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
other	object

Returns
Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
int

Overrides

object.GetHashCode()

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name	Description
input	CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(ErrorInfo)

public void MergeFrom(ErrorInfo other)

Merges the given message into this one.

Parameter
Name	Description
other	ErrorInfo

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns
Type	Description
string

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name	Description
output	CodedOutputStream Coded output stream to write the data to. Must not be null.