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. The error model is designed to be:
- Simple to use and understand for most users
- Flexible enough to meet unexpected needs
Overview
The Status
message contains three pieces of data: error code, error
message, and error details. The error code should be an enum value of
[google.rpc.Code][google.rpc.Code], but it may accept additional error codes
if needed. The error message should be a developer-facing English message
that helps developers understand and resolve the error. If a localized
user-facing error message is needed, put the localized message in the error
details or localize it in the client. The optional error details may contain
arbitrary information about the error. There is a predefined set of error
detail types in the package google.rpc
that can be used for common error
conditions.
Language mapping
The Status
message is the logical representation of the error model, but it
is not necessarily the actual wire format. When the Status
message is
exposed in different client libraries and different wire protocols, it can be
mapped differently. For example, it will likely be mapped to some exceptions
in Java, but more likely mapped to some error codes in C.
Other uses
The error model and the Status
message can be used in a variety of
environments, either with or without APIs, to provide a
consistent developer experience across different environments.
Example uses of this error model include:
Partial errors. If a service needs to return partial errors to the client,
it may embed the Status
in the normal response to indicate the partial
errors.
Workflow errors. A typical workflow has multiple steps. Each step may
have a Status
message for error reporting.
Batch operations. If a client uses batch request and batch response, the
Status
message should be used directly inside batch response, one for
each error sub-response.
Asynchronous operations. If an API call embeds asynchronous operation
results in its response, the status of those operations should be
represented directly using the Status
message.
Logging. If some API errors are stored in logs, the message Status
could
be used directly after any stripping needed for security/privacy reasons.
Inheritance
System.Object
Status
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Google.Api.CommonProtos.dll
Syntax
public sealed class Status : IMessage<Status>, IMessage, IEquatable<Status>, IDeepCloneable<Status>
Constructors
Status()
Declaration
Status(Status)
Declaration
public Status(Status other)
Parameters
Type |
Name |
Description |
Status |
other |
|
Fields
CodeFieldNumber
Field number for the "code" field.
Declaration
public const int CodeFieldNumber = 1
Field Value
Type |
Description |
System.Int32 |
|
DetailsFieldNumber
Field number for the "details" field.
Declaration
public const int DetailsFieldNumber = 3
Field Value
Type |
Description |
System.Int32 |
|
MessageFieldNumber
Field number for the "message" field.
Declaration
public const int MessageFieldNumber = 2
Field Value
Type |
Description |
System.Int32 |
|
Properties
Code
The status code, which should be an enum value of
[google.rpc.Code][google.rpc.Code].
Declaration
public int Code { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
Descriptor
Declaration
public static MessageDescriptor Descriptor { get; }
Property Value
Details
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
Declaration
public RepeatedField<Any> Details { get; }
Property Value
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][google.rpc.Status.details] field, or localized
by the client.
Declaration
public string Message { get; set; }
Property Value
Type |
Description |
System.String |
|
Parser
Declaration
public static MessageParser<Status> Parser { get; }
Property Value
Methods
CalculateSize()
Declaration
public int CalculateSize()
Returns
Type |
Description |
System.Int32 |
|
Implements
Clone()
Declaration
Returns
Implements
Equals(Status)
Declaration
public bool Equals(Status other)
Parameters
Type |
Name |
Description |
Status |
other |
|
Returns
Type |
Description |
System.Boolean |
|
Implements
System.IEquatable<T>.Equals(T)
Equals(Object)
Declaration
public override bool Equals(object other)
Parameters
Type |
Name |
Description |
System.Object |
other |
|
Returns
Type |
Description |
System.Boolean |
|
Overrides
System.Object.Equals(System.Object)
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Type |
Description |
System.Int32 |
|
Overrides
System.Object.GetHashCode()
Declaration
public void MergeFrom(CodedInputStream input)
Parameters
Implements
MergeFrom(Status)
Declaration
public void MergeFrom(Status other)
Parameters
Type |
Name |
Description |
Status |
other |
|
Implements
ToString()
Declaration
public override string ToString()
Returns
Type |
Description |
System.String |
|
Overrides
System.Object.ToString()
WriteTo(CodedOutputStream)
Declaration
public void WriteTo(CodedOutputStream output)
Parameters
Implements
Explicit Interface Implementations
IMessage.Descriptor
Declaration
MessageDescriptor IMessage.Descriptor { get; }
Returns
Implements