Table of Contents

Class Status

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.

public class Status
Inheritance
object
Status

Remarks

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

Properties

Code

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

public int Code { get; set; }

Property Value

int

Details

A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type.

Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

public Dictionary<string, string> Details { get; set; }

Property Value

Dictionary<string, string>

Message

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 field, or localized by the client.

public string Message { get; set; }

Property Value

string

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.