Geminix.V1beta.Status (geminix v0.2.0)

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.

Fields:

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

Summary

Types

t()

Functions

from_map(schema \\ %__MODULE__{}, map)

Create a Geminix.V1beta.Status.t/0 from a map returned by the Gemini API.

Types

t()

@type t() :: %Geminix.V1beta.Status{
  __meta__: term(),
  code: integer(),
  details: [map()],
  message: binary()
}

Functions

from_map(schema \\ %MODULE{}, map)

@spec from_map(t(), map()) :: {:ok, t()} | {:error, Ecto.Changeset.t()}

Create a Geminix.V1beta.Status.t/0 from a map returned by the Gemini API.

Sometimes, this function should not be applied to the full response body, but instead it should be applied to the correct part of the map in the response body. This depends on the concrete API call.