Documentation

StatusCode
in package

AbstractYes

GRPC status codes.

Table of Contents

Constants

Aborted  = 10
Aborted indicates the operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.
AlreadyExists  = 6
AlreadyExists means an attempt to create an entity failed because one already exists.
Canceled  = 1
Canceled indicates the operation was canceled (typically by the caller).
DataLoss  = 15
DataLoss indicates unrecoverable data loss or corruption.
DeadlineExceeded  = 4
DeadlineExceeded means operation expired before completion.
FailedPrecondition  = 9
FailedPrecondition indicates operation was rejected because the system is not in a state required for the operation's execution.
Internal  = 13
Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken.
InvalidArgument  = 3
InvalidArgument indicates client specified an invalid argument.
NotFound  = 5
NotFound means some requested entity (e.g., file or directory) was not found.
OK  = 0
OK is returned on success.
OutOfRange  = 11
OutOfRange means operation was attempted past the valid range.
PermissionDenied  = 7
PermissionDenied indicates the caller does not have permission to execute the specified operation. It must not be used for rejections caused by exhausting some resource (use ResourceExhausted instead for those errors). It must not be used if the caller cannot be identified (use Unauthenticated instead for those errors).
ResourceExhausted  = 8
ResourceExhausted indicates some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
Unauthenticated  = 16
Unauthenticated indicates the request does not have valid authentication credentials for the operation.
Unavailable  = 14
Unavailable indicates the service is currently unavailable.
Unimplemented  = 12
Unimplemented indicates operation is not implemented or not supported/enabled in this service.
Unknown  = 2
Unknown error. An example of where this error may be returned is if 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.
NAMES  = [self::OK => 'OK', self::Canceled => 'Canceled', self::Unknown => 'Unknown', self::InvalidArgument => 'InvalidArgument', self::DeadlineExceeded => 'DeadlineExceeded', self::NotFound => 'NotFound', self::AlreadyExists => 'AlreadyExists', self::PermissionDenied => 'PermissionDenied', self::ResourceExhausted => 'ResourceExhausted', self::FailedPrecondition => 'FailedPrecondition', self::Aborted => 'Aborted', self::OutOfRange => 'OutOfRange', self::Unimplemented => 'Unimplemented', self::Internal => 'Internal', self::Unavailable => 'Unavailable', self::DataLoss => 'DataLoss', self::Unauthenticated => 'Unauthenticated']

Methods

nameFromCode()  : string
Return the name of the gRPC status code.

Constants

Aborted

Aborted indicates the operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.

public mixed Aborted = 10

See litmus test above for deciding between FailedPrecondition, Aborted, and Unavailable.

AlreadyExists

AlreadyExists means an attempt to create an entity failed because one already exists.

public mixed AlreadyExists = 6

Canceled

Canceled indicates the operation was canceled (typically by the caller).

public mixed Canceled = 1

DataLoss

DataLoss indicates unrecoverable data loss or corruption.

public mixed DataLoss = 15

DeadlineExceeded

DeadlineExceeded means operation expired before completion.

public mixed DeadlineExceeded = 4

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

FailedPrecondition indicates operation was rejected because the system is not in a state required for the operation's execution.

public mixed FailedPrecondition = 9

For example, directory to be deleted may be non-empty, an rmdir operation is applied to a non-directory, etc.

A litmus test that may help a service implementor in deciding between FailedPrecondition, Aborted, and Unavailable: (a) Use Unavailable if the client can retry just the failing call. (b) Use Aborted if the client should retry at a higher-level (e.g., restarting a read-modify-write sequence). (c) Use FailedPrecondition if the client should not retry until the system state has been explicitly fixed. E.g., if an "rmdir" fails because the directory is non-empty, FailedPrecondition should be returned since the client should not retry unless they have first fixed up the directory by deleting files from it. (d) Use FailedPrecondition if the client performs conditional REST Get/Update/Delete on a resource and the resource on the server does not match the condition. E.g., conflicting read-modify-write on the same resource.

Internal

Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken.

public mixed Internal = 13

InvalidArgument

InvalidArgument indicates client specified an invalid argument.

public mixed InvalidArgument = 3

Note that this differs from FailedPrecondition. It indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name).

NotFound

NotFound means some requested entity (e.g., file or directory) was not found.

public mixed NotFound = 5

OK

OK is returned on success.

public mixed OK = 0

OutOfRange

OutOfRange means operation was attempted past the valid range.

public mixed OutOfRange = 11

E.g., seeking or reading past end of file.

Unlike InvalidArgument, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate InvalidArgument if asked to read at an offset that is not in the range [0,2^32-1], but it will generate OutOfRange if asked to read from an offset past the current file size.

There is a fair bit of overlap between FailedPrecondition and OutOfRange. We recommend using OutOfRange (the more specific error) when it applies so that callers who are iterating through a space can easily look for an OutOfRange error to detect when they are done.

PermissionDenied

PermissionDenied indicates the caller does not have permission to execute the specified operation. It must not be used for rejections caused by exhausting some resource (use ResourceExhausted instead for those errors). It must not be used if the caller cannot be identified (use Unauthenticated instead for those errors).

public mixed PermissionDenied = 7

ResourceExhausted

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

public mixed ResourceExhausted = 8

Unauthenticated

Unauthenticated indicates the request does not have valid authentication credentials for the operation.

public mixed Unauthenticated = 16

Unavailable

Unavailable indicates the service is currently unavailable.

public mixed Unavailable = 14

This is a most likely a transient condition and may be corrected by retrying with a backoff.

See litmus test above for deciding between FailedPrecondition, Aborted, and Unavailable.

Unimplemented

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

public mixed Unimplemented = 12

Unknown

Unknown error. An example of where this error may be returned is if 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.

public mixed Unknown = 2

NAMES

private mixed NAMES = [self::OK => 'OK', self::Canceled => 'Canceled', self::Unknown => 'Unknown', self::InvalidArgument => 'InvalidArgument', self::DeadlineExceeded => 'DeadlineExceeded', self::NotFound => 'NotFound', self::AlreadyExists => 'AlreadyExists', self::PermissionDenied => 'PermissionDenied', self::ResourceExhausted => 'ResourceExhausted', self::FailedPrecondition => 'FailedPrecondition', self::Aborted => 'Aborted', self::OutOfRange => 'OutOfRange', self::Unimplemented => 'Unimplemented', self::Internal => 'Internal', self::Unavailable => 'Unavailable', self::DataLoss => 'DataLoss', self::Unauthenticated => 'Unauthenticated']

Methods

nameFromCode()

Return the name of the gRPC status code.

public static nameFromCode(int $code) : string
Parameters
$code : int

Status code from the service.

Return values
string —

Name of the status code.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results