GoogleRpcStatus

Posted on by Darth Autocrat

GoogleApi.ContentWarehouse.V1.Model.GoogleRpcStatus

Table of Contents ▼

Jump to a specific part of the page:

Description

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.

Attributes List

This module has the following attributes (case-insensitive ascending order):

View Attributes

Attributes

  1. code (type: integer(), default: nil)
    - The status code, which should be an enum value of google.rpc.Code.
  2. details (type: list(map()), default: nil)
    - A list of messages that carry the error details. There is a common set of message types for APIs to use.
  3. message (type: String.t, default: nil)
    - 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.

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.GoogleRpcStatus{
code: integer() | nil,
details: [map()] | nil,
message: String.t() | nil
}

Function

@spec decode(struct(), keyword()) :: struct()

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.GoogleRpcStatus