GoogleApi.Apigee.V1.Model.GoogleRpcStatus (google_api_apigee v0.24.1) View Source

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

  • code (type: integer(), default: nil) - The status code, which should be an enum value of google.rpc.Code.
  • 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.
  • 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.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Apigee.V1.Model.GoogleRpcStatus{
  code: integer(),
  details: [map()],
  message: String.t()
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.