Package-level declarations

Types

Link copied to clipboard
interface BadRequest

Describes violations in a client request. This error type focuses on the syntactic aspects of the request.

Link copied to clipboard
class BadRequestInternal : InternalMessage
Link copied to clipboard
Link copied to clipboard
interface DebugInfo

Describes additional debugging info.

Link copied to clipboard
class DebugInfoInternal : InternalMessage
Link copied to clipboard
interface ErrorInfo

Describes the cause of the error with structured details.

Link copied to clipboard
class ErrorInfoInternal : InternalMessage
Link copied to clipboard
interface Help

Provides links to documentation or for performing an out of band action.

Link copied to clipboard
class HelpInternal : InternalMessage
Link copied to clipboard

Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

Link copied to clipboard
class LocalizedMessageInternal : InternalMessage
Link copied to clipboard

Describes what preconditions have failed.

Link copied to clipboard
class PreconditionFailureInternal : InternalMessage
Link copied to clipboard
interface QuotaFailure

Describes how a quota check failed.

Link copied to clipboard
class QuotaFailureInternal : InternalMessage
Link copied to clipboard
interface RequestInfo

Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.

Link copied to clipboard
class RequestInfoInternal : InternalMessage
Link copied to clipboard
interface ResourceInfo

Describes the resource that is being accessed.

Link copied to clipboard
class ResourceInfoInternal : InternalMessage
Link copied to clipboard
interface RetryInfo

Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses.

Link copied to clipboard
class RetryInfoInternal : InternalMessage
Link copied to clipboard

Interface providing field-presence information for RetryInfo messages. Retrieve it via the RetryInfo.presence extension property.

Link copied to clipboard
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.

Link copied to clipboard
class StatusInternal : InternalMessage

Properties

Link copied to clipboard

Returns the field-presence view for this BadRequest.FieldViolation instance.

Returns the field-presence view for this RetryInfo instance.

Functions

Link copied to clipboard
fun BadRequest.copy(body: <Error class: unknown class>.() -> Unit = {}): BadRequest
fun BadRequest.FieldViolation.copy(body: <Error class: unknown class>.() -> Unit = {}): BadRequest.FieldViolation
fun DebugInfo.copy(body: <Error class: unknown class>.() -> Unit = {}): DebugInfo
fun ErrorInfo.copy(body: <Error class: unknown class>.() -> Unit = {}): ErrorInfo
fun Help.copy(body: <Error class: unknown class>.() -> Unit = {}): Help
fun Help.Link.copy(body: <Error class: unknown class>.() -> Unit = {}): Help.Link
fun LocalizedMessage.copy(body: <Error class: unknown class>.() -> Unit = {}): LocalizedMessage
fun PreconditionFailure.copy(body: <Error class: unknown class>.() -> Unit = {}): PreconditionFailure
fun PreconditionFailure.Violation.copy(body: <Error class: unknown class>.() -> Unit = {}): PreconditionFailure.Violation
fun QuotaFailure.copy(body: <Error class: unknown class>.() -> Unit = {}): QuotaFailure
fun QuotaFailure.Violation.copy(body: <Error class: unknown class>.() -> Unit = {}): QuotaFailure.Violation
fun RequestInfo.copy(body: <Error class: unknown class>.() -> Unit = {}): RequestInfo
fun ResourceInfo.copy(body: <Error class: unknown class>.() -> Unit = {}): ResourceInfo
fun RetryInfo.copy(body: <Error class: unknown class>.() -> Unit = {}): RetryInfo
fun Status.copy(body: <Error class: unknown class>.() -> Unit = {}): Status

Copies the original message, including unknown fields.

Link copied to clipboard
fun BadRequestInternal.Companion.decodeWith(msg: BadRequestInternal, decoder: WireDecoder, config: ProtoConfig?)
fun DebugInfoInternal.Companion.decodeWith(msg: DebugInfoInternal, decoder: WireDecoder, config: ProtoConfig?)
fun ErrorInfoInternal.Companion.decodeWith(msg: ErrorInfoInternal, decoder: WireDecoder, config: ProtoConfig?)
fun HelpInternal.Companion.decodeWith(msg: HelpInternal, decoder: WireDecoder, config: ProtoConfig?)
fun HelpInternal.LinkInternal.Companion.decodeWith(msg: HelpInternal.LinkInternal, decoder: WireDecoder, config: ProtoConfig?)
fun LocalizedMessageInternal.Companion.decodeWith(msg: LocalizedMessageInternal, decoder: WireDecoder, config: ProtoConfig?)
fun PreconditionFailureInternal.Companion.decodeWith(msg: PreconditionFailureInternal, decoder: WireDecoder, config: ProtoConfig?)
fun QuotaFailureInternal.Companion.decodeWith(msg: QuotaFailureInternal, decoder: WireDecoder, config: ProtoConfig?)
fun RequestInfoInternal.Companion.decodeWith(msg: RequestInfoInternal, decoder: WireDecoder, config: ProtoConfig?)
fun ResourceInfoInternal.Companion.decodeWith(msg: ResourceInfoInternal, decoder: WireDecoder, config: ProtoConfig?)
fun RetryInfoInternal.Companion.decodeWith(msg: RetryInfoInternal, decoder: WireDecoder, config: ProtoConfig?)
fun StatusInternal.Companion.decodeWith(msg: StatusInternal, decoder: WireDecoder, config: ProtoConfig?)
Link copied to clipboard
fun BadRequestInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun BadRequestInternal.FieldViolationInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun DebugInfoInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun ErrorInfoInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun ErrorInfoInternal.MetadataEntryInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun HelpInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun HelpInternal.LinkInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun LocalizedMessageInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun PreconditionFailureInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun PreconditionFailureInternal.ViolationInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun QuotaFailureInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun QuotaFailureInternal.ViolationInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun RequestInfoInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun ResourceInfoInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun RetryInfoInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
fun StatusInternal.encodeWith(encoder: WireEncoder, config: ProtoConfig?)
Link copied to clipboard
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): BadRequest
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): BadRequest.FieldViolation
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): DebugInfo
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): ErrorInfo
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): Help
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): Help.Link
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): LocalizedMessage
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): PreconditionFailure
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): PreconditionFailure.Violation
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): QuotaFailure
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): QuotaFailure.Violation
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): RequestInfo
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): ResourceInfo
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): RetryInfo
operator fun <Error class: unknown class>.invoke(body: <Error class: unknown class>.() -> Unit): Status

Constructs a new message.