Code class final

The canonical error codes for gRPC APIs.

Sometimes multiple error codes may apply. Services should return the most specific error code that applies. For example, prefer OUT_OF_RANGE over FAILED_PRECONDITION if both codes apply. Similarly prefer NOT_FOUND or ALREADY_EXISTS over FAILED_PRECONDITION.

Inheritance

• Object
• ProtoEnum
• Code

Constructors

Code(String value)

const

Code.fromJson(Object? json)

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

isNotDefault → bool

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

value → String

final, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → String

inherited

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

$default → const Code

The default value for Code.

aborted → const Code

The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort.

alreadyExists → const Code

The entity that a client attempted to create (e.g., file or directory) already exists.

cancelled → const Code

The operation was cancelled, typically by the caller.

dataLoss → const Code

Unrecoverable data loss or corruption.

deadlineExceeded → const Code

The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire.

failedPrecondition → const Code

The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc.

internal → const Code

Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors.

invalidArgument → const Code

The client specified an invalid argument. Note that this differs from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name).

notFound → const Code

Some requested entity (e.g., file or directory) was not found.

ok → const Code

Not an error; returned on success.

outOfRange → const Code

The operation was attempted past the valid range. E.g., seeking or reading past end-of-file.

permissionDenied → const Code

The caller does not have permission to execute the specified operation. PERMISSION_DENIED must not be used for rejections caused by exhausting some resource (use RESOURCE_EXHAUSTED instead for those errors). PERMISSION_DENIED must not be used if the caller can not be identified (use UNAUTHENTICATED instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions.

resourceExhausted → const Code

Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.

unauthenticated → const Code

The request does not have valid authentication credentials for the operation.

unavailable → const Code

The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations.

unimplemented → const Code

The operation is not implemented or is not supported/enabled in this service.

unknown → const Code

Unknown error. For example, this error may be returned when a Status value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error.