Interface NonOkStatus

Failed operation result with any non-OK StatusCode.

interface NonOkStatus {
    cause?: unknown;
    code:
        | CANCELLED
        | UNKNOWN
        | INVALID_ARGUMENT
        | DEADLINE_EXCEEDED
        | NOT_FOUND
        | ALREADY_EXISTS
        | PERMISSION_DENIED
        | RESOURCE_EXHAUSTED
        | FAILED_PRECONDITION
        | ABORTED
        | OUT_OF_RANGE
        | UNIMPLEMENTED
        | INTERNAL
        | UNAVAILABLE
        | DATA_LOSS
        | UNAUTHENTICATED;
    details?: object[];
    message: string;
}

Hierarchy (View Summary)

StatusBase
- NonOkStatus

Index

Properties

cause? code details? message

Properties

`Optional`cause

cause?: unknown

Local exception/diagnostic cause; omitted at serialized boundaries.

code

code:
    | CANCELLED
    | UNKNOWN
    | INVALID_ARGUMENT
    | DEADLINE_EXCEEDED
    | NOT_FOUND
    | ALREADY_EXISTS
    | PERMISSION_DENIED
    | RESOURCE_EXHAUSTED
    | FAILED_PRECONDITION
    | ABORTED
    | OUT_OF_RANGE
    | UNIMPLEMENTED
    | INTERNAL
    | UNAVAILABLE
    | DATA_LOSS
    | UNAUTHENTICATED

Machine-readable portable outcome.

`Optional`details

details?: object[]

Structured, serializable application or validation context.

message

message: string

Concise description suitable for logs and user-facing diagnostics.