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 .
Namespace
Google.RpcAssembly
Google.Api.CommonProtos.dll
Constructors
Status()
public Status()
Status(Status)
public Status(Status other)
Fields
CodeFieldNumber
public
const
int
CodeFieldNumber
=
1
Field number for the "code" field.
DetailsFieldNumber
public
const
int
DetailsFieldNumber
=
3
Field number for the "details" field.
MessageFieldNumber
public
const
int
MessageFieldNumber
=
2
Field number for the "message" field.
Properties
Code
public int Code { get; set; }
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
Descriptor
public static MessageDescriptor Descriptor { get; }
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.
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.
Parser
public static MessageParser<Status> Parser { get; }
Methods
CalculateSize()
public int CalculateSize()
Clone()
public Status Clone()
Equals(Status)
public bool Equals(Status other)
Equals(object)
public override bool Equals(object other)
GetHashCode()
public override int GetHashCode()
MergeFrom(CodedInputStream)
public void MergeFrom(CodedInputStream input)
MergeFrom(Status)
public void MergeFrom(Status other)
ToString()
public override string ToString()
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)