Blog Studio Go to console

FirebaseFunctions Framework Reference

FunctionsErrorCode

@objc(FIRFunctionsErrorCode)
public enum FunctionsErrorCode : Int, Sendable

The set of error status codes that can be returned from a Callable HTTPS trigger. These are the canonical error codes for Google APIs, as documented here: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto#L26

  • OK

    The operation completed successfully.

    Declaration

    Swift

    case OK = 0

  • The operation was cancelled (typically by the caller).

    Declaration

    Swift

    case cancelled = 1

  • Unknown error or an error from a different error domain.

    Declaration

    Swift

    case unknown = 2

  • Client specified an invalid argument. Note that this differs from FailedPrecondition. InvalidArgument indicates arguments that are problematic regardless of the state of the system (e.g., an invalid field name).

    Declaration

    Swift

    case invalidArgument = 3

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

    Declaration

    Swift

    case deadlineExceeded = 4

  • Some requested document was not found.

    Declaration

    Swift

    case notFound = 5

  • Some document that we attempted to create already exists.

    Declaration

    Swift

    case alreadyExists = 6

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

    Declaration

    Swift

    case permissionDenied = 7

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

    Declaration

    Swift

    case resourceExhausted = 8

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

    Declaration

    Swift

    case failedPrecondition = 9

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

    Declaration

    Swift

    case aborted = 10

  • Operation was attempted past the valid range.

    Declaration

    Swift

    case outOfRange = 11

  • Operation is not implemented or not supported/enabled.

    Declaration

    Swift

    case unimplemented = 12

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

    Declaration

    Swift

    case `internal` = 13

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

    Declaration

    Swift

    case unavailable = 14

  • Unrecoverable data loss or corruption.

    Declaration

    Swift

    case dataLoss = 15

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

    Declaration

    Swift

    case unauthenticated = 16