Class Status (2.2.0)

public sealed class Status : Protobuf.IMessage<Status>, Protobuf.IBufferMessage

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

Protobuf.IBufferMessage

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
`Int32`

DetailsFieldNumber

public const int DetailsFieldNumber = 3

Field number for the "details" field.

Field Value
Type	Description
`Int32`

MessageFieldNumber

public const int MessageFieldNumber = 2

Field number for the "message" field.

Field Value
Type	Description
`Int32`

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
`Int32`

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`Protobuf.Reflection.MessageDescriptor`

Details

public Protobuf.Collections.RepeatedField<Protobuf.WellKnownTypes.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
`Protobuf.Collections.RepeatedField<Protobuf.WellKnownTypes.Any>`

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 Protobuf.MessageParser<Status> Parser { get; }

Property Value
Type	Description
`Protobuf.MessageParser<Status>`

Methods

CalculateSize()

public int CalculateSize()

Returns
Type	Description
`Int32`

Clone()

public Status Clone()

Returns
Type	Description
`Status`

Equals(Status)

public bool Equals(Status other)

Parameter
Name	Description
`other`	`Status`

Returns
Type	Description
`Boolean`

Equals(Object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`Object`

Returns
Type	Description
`Boolean`

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`Int32`

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)

Parameter
Name	Description
`input`	`Protobuf.CodedInputStream`

MergeFrom(Status)

public void MergeFrom(Status other)

Parameter
Name	Description
`other`	`Status`

ToString()

public override string ToString()

Returns
Type	Description
`String`

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)

Parameter
Name	Description
`output`	`Protobuf.CodedOutputStream`