Class Status (2.10.0)

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

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide.

Inheritance

object > Status

Implements

IMessage Status, IEquatable Status, IDeepCloneable Status, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace

Google.Rpc

Assembly

Google.Api.CommonProtos.dll

Constructors

Status()

public Status()

Status(Status)

public Status(Status other)

Parameter
Name	Description
`other`	`Status`

Fields

CodeFieldNumber

public const int CodeFieldNumber = 1

Field number for the "code" field.

Field Value
Type	Description
`int`

DetailsFieldNumber

public const int DetailsFieldNumber = 3

Field number for the "details" field.

Field Value
Type	Description
`int`

MessageFieldNumber

public const int MessageFieldNumber = 2

Field number for the "message" field.

Field Value
Type	Description
`int`

Properties

Code

public int Code { get; set; }

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

Property Value
Type	Description
`int`

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`MessageDescriptor`

Details

public RepeatedField<Any> Details { get; }

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Property Value
Type	Description
`RepeatedFieldAny`

Message

public string Message { get; set; }

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

Property Value
Type	Description
`string`

Parser

public static MessageParser<Status> Parser { get; }

Property Value
Type	Description
`MessageParserStatus`

Methods

CalculateSize()

public int CalculateSize()

Returns
Type	Description
`int`

Clone()

public Status Clone()

Returns
Type	Description
`Status`

Equals(Status)

public bool Equals(Status other)

Parameter
Name	Description
`other`	`Status`

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)

Parameter
Name	Description
`input`	`CodedInputStream`

MergeFrom(Status)

public void MergeFrom(Status other)

Parameter
Name	Description
`other`	`Status`

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`