Send feedback
Class Status (2.10.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.10.0 keyboard_arrow_down
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.Rpc
Assembly
Google.Api.CommonProtos.dll
Constructors
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; }
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.
Property Value
Type
Description
string
Parser
public static MessageParser<Status> Parser { get; }
Methods
CalculateSize()
public int CalculateSize()
Returns
Type
Description
int
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
GetHashCode()
public override int GetHashCode()
Returns
Type
Description
int
Overrides
public void MergeFrom(CodedInputStream input)
MergeFrom(Status)
public void MergeFrom(Status other)
Parameter
Name
Description
other
Status
ToString()
public override string ToString()
Returns
Type
Description
string
Overrides
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-24 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-09-24 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-24 UTC."]]