AI Dev Kit
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
    Namespace: Glitch9.AIDevKit.Google
    Assembly: .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

    Code

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

    Declaration
    public int Code { get; set; }
    Property Value
    Type Description
    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" }.

    Declaration
    public Dictionary<string, string> Details { get; set; }
    Property Value
    Type Description
    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.

    Declaration
    public string Message { get; set; }
    Property Value
    Type Description
    string
    In this article
    Back to top Generated by DocFX