FirebaseFirestoreException.Code

enum FirebaseFirestoreException.Code


The set of Cloud Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Summary

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 functions

java-static FirebaseFirestoreException.Code
fromValue(value: Int)
Int

The numerical value of the code.

java-static FirebaseFirestoreException.Code!
valueOf(name: String!)

Returns the enum constant of this type with the specified name.

java-static Array<FirebaseFirestoreException.Code!>!

Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

ABORTED

val FirebaseFirestoreException.Code.ABORTEDFirebaseFirestoreException.Code

The operation was aborted, typically due to a concurrency issue like transaction aborts, etc.

ALREADY_EXISTS

val FirebaseFirestoreException.Code.ALREADY_EXISTSFirebaseFirestoreException.Code

Some document that we attempted to create already exists.

CANCELLED

val FirebaseFirestoreException.Code.CANCELLEDFirebaseFirestoreException.Code

The operation was cancelled (typically by the caller).

DATA_LOSS

val FirebaseFirestoreException.Code.DATA_LOSSFirebaseFirestoreException.Code

Unrecoverable data loss or corruption.

DEADLINE_EXCEEDED

val FirebaseFirestoreException.Code.DEADLINE_EXCEEDEDFirebaseFirestoreException.Code

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

val FirebaseFirestoreException.Code.FAILED_PRECONDITIONFirebaseFirestoreException.Code

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

INTERNAL

val FirebaseFirestoreException.Code.INTERNALFirebaseFirestoreException.Code

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

val FirebaseFirestoreException.Code.INVALID_ARGUMENTFirebaseFirestoreException.Code

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 (like an invalid field name).

NOT_FOUND

val FirebaseFirestoreException.Code.NOT_FOUNDFirebaseFirestoreException.Code

Some requested document was not found.

OK

val FirebaseFirestoreException.Code.OKFirebaseFirestoreException.Code

The operation completed successfully. FirebaseFirestoreException will never have a status of OK.

OUT_OF_RANGE

val FirebaseFirestoreException.Code.OUT_OF_RANGEFirebaseFirestoreException.Code

Operation was attempted past the valid range.

PERMISSION_DENIED

val FirebaseFirestoreException.Code.PERMISSION_DENIEDFirebaseFirestoreException.Code

The caller does not have permission to execute the specified operation.

RESOURCE_EXHAUSTED

val FirebaseFirestoreException.Code.RESOURCE_EXHAUSTEDFirebaseFirestoreException.Code

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

UNAUTHENTICATED

val FirebaseFirestoreException.Code.UNAUTHENTICATEDFirebaseFirestoreException.Code

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

UNAVAILABLE

val FirebaseFirestoreException.Code.UNAVAILABLEFirebaseFirestoreException.Code

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

UNIMPLEMENTED

val FirebaseFirestoreException.Code.UNIMPLEMENTEDFirebaseFirestoreException.Code

Operation is not implemented or not supported/enabled.

UNKNOWN

val FirebaseFirestoreException.Code.UNKNOWNFirebaseFirestoreException.Code

Unknown error or an error from a different error domain.

Public functions

fromValue

java-static fun fromValue(value: Int): FirebaseFirestoreException.Code

value

fun value(): Int

The numerical value of the code.

valueOf

java-static fun valueOf(name: String!): FirebaseFirestoreException.Code!

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.)

Returns
FirebaseFirestoreException.Code!

the enum constant with the specified name

Throws
java.lang.IllegalArgumentException: java.lang.IllegalArgumentException

if this enum type has no constant with the specified name

values

java-static fun values(): Array<FirebaseFirestoreException.Code!>!

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

Returns
Array<FirebaseFirestoreException.Code!>!

an array containing the constants of this enum type, in the order they're declared