Type Alias Status

Status: { code?: number; details?: { [k: string]: any }[]; message?: string }

The Status type defines a logical error model that is suitable for

Type declaration

  • Optionalcode?: number

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

  • Optionaldetails?: { [k: string]: any }[]

    A list of messages that carry the error details. There is a common set of

    Remarks

    message types for APIs to use.

  • Optionalmessage?: string

    A developer-facing error message, which should be in English. Any

    Remarks

    user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Remarks

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.

Settings