Search Results for

    Show / Hide 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.

    Inheritance
    object
    Status
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Glitch9.AIDevKit.Google
    Assembly: Glitch9.AIDevKit.Provider.Google.dll
    Syntax
    public class Status
    Remarks

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

    Properties

    | Edit this page View Source

    Code

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

    Declaration
    [JsonProperty("code")]
    public int Code { get; set; }
    Property Value
    Type Description
    int
    | Edit this page View Source

    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" }.

    Declaration
    [JsonProperty("details")]
    public Dictionary<string, string> Details { get; set; }
    Property Value
    Type Description
    Dictionary<string, string>
    | Edit this page View Source

    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.

    Declaration
    [JsonProperty("message")]
    public string Message { get; set; }
    Property Value
    Type Description
    string

    Methods

    | Edit this page View Source

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    object.ToString()

    Extension Methods

    ArrayExtensions.ToArrayOrEmpty<T>(T)
    ArrayExtensions.ToArrayOrNull<T>(T)
    EventExtensions.ToDelta<T>(T, string, int, string, bool)
    EventExtensions.ToDone<T>(T, string, int, string)
    EventExtensions.ToEvent<T>(T)
    EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)
    FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)
    ResponseCastingExtensions.GetResult<T>(T)
    SystemExtensions.GetName(object)
    • Edit this page
    • View Source
    In this article
    Back to top AI DevKit Documentation