Status

interface 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.

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

Link copied to clipboard
abstract val code: Int

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

Link copied to clipboard
abstract val details: List<Any>

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Link copied to clipboard
abstract val message: String

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.

Functions

Link copied to clipboard
Link copied to clipboard
fun Status.copy(body: <Error class: unknown class>.() -> Unit = {}): Status

Copies the original message, including unknown fields.