FirebaseFunctionsException.Code
public enum FirebaseFunctionsException.Code extends Enum
The set of error status codes that can be returned from a Callable HTTPS tigger. These are the canonical error codes for Google APIs, as documented here: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto#L26
Summary
Nested types |
|---|
public static class FirebaseFunctionsException.Code.Companion |
Enum Values |
|
|---|---|
ABORTED |
The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. |
ALREADY_EXISTS |
Some document that we attempted to create already exists. |
CANCELLED |
The operation was cancelled (typically by the caller). |
DATA_LOSS |
Unrecoverable data loss or corruption. |
DEADLINE_EXCEEDED |
Deadline expired before operation could complete. |
FAILED_PRECONDITION |
Operation was rejected because the system is not in a state required for the operation's execution. |
INTERNAL |
Internal errors. |
INVALID_ARGUMENT |
Client specified an invalid argument. |
NOT_FOUND |
Some requested document was not found. |
OK |
The operation completed successfully. |
OUT_OF_RANGE |
Operation was attempted past the valid range. |
PERMISSION_DENIED |
The caller does not have permission to execute the specified operation. |
RESOURCE_EXHAUSTED |
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. |
UNAUTHENTICATED |
The request does not have valid authentication credentials for the operation. |
UNAVAILABLE |
The service is currently unavailable. |
UNIMPLEMENTED |
Operation is not implemented or not supported/enabled. |
UNKNOWN |
Unknown error or an error from a different error domain. |
Public methods |
|
|---|---|
static final @NonNull FirebaseFunctionsException.Code |
fromHttpStatus(int status)Takes an HTTP status code and returns the corresponding |
static final @NonNull FirebaseFunctionsException.Code |
fromValue(int value) |
final @NonNull FirebaseFunctionsException.Code |
Returns the enum constant of this type with the specified name. |
final @NonNull FirebaseFunctionsException.Code[] |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
ABORTED
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.ABORTED
The operation was aborted, typically due to a concurrency issue like transaction aborts, etc.
ALREADY_EXISTS
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.ALREADY_EXISTS
Some document that we attempted to create already exists.
CANCELLED
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.CANCELLED
The operation was cancelled (typically by the caller).
DATA_LOSS
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.DATA_LOSS
Unrecoverable data loss or corruption.
DEADLINE_EXCEEDED
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.DEADLINE_EXCEEDED
Deadline expired before 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.
FAILED_PRECONDITION
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.FAILED_PRECONDITION
Operation was rejected because the system is not in a state required for the operation's execution.
INTERNAL
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.INTERNAL
Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken.
INVALID_ARGUMENT
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.INVALID_ARGUMENT
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 (For example, an invalid field name).
NOT_FOUND
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.NOT_FOUND
Some requested document was not found.
OK
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.OK
The operation completed successfully. FirebaseFunctionsException will never have a status of OK.
OUT_OF_RANGE
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.OUT_OF_RANGE
Operation was attempted past the valid range.
PERMISSION_DENIED
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.PERMISSION_DENIED
The caller does not have permission to execute the specified operation.
RESOURCE_EXHAUSTED
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.RESOURCE_EXHAUSTED
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
UNAUTHENTICATED
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.UNAUTHENTICATED
The request does not have valid authentication credentials for the operation.
UNAVAILABLE
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.UNAVAILABLE
The service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff.
UNIMPLEMENTED
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.UNIMPLEMENTED
Operation is not implemented or not supported/enabled.
UNKNOWN
FirebaseFunctionsException.Code FirebaseFunctionsException.Code.UNKNOWN
Unknown error or an error from a different error domain.
Public methods
fromHttpStatus
public static final @NonNull FirebaseFunctionsException.Code fromHttpStatus(int status)
Takes an HTTP status code and returns the corresponding Code error code. This is the standard HTTP status code -> error mapping defined in: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
| Parameters | |
|---|---|
int status |
An HTTP status code. |
| Returns | |
|---|---|
@NonNull FirebaseFunctionsException.Code |
The corresponding |
valueOf
public final @NonNull FirebaseFunctionsException.Code valueOf(@NonNull String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |