Variable ErrorCodeConst

Type Declaration

• ReadonlyABORTED: "ABORTED"

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

  Maps to:

  • google.rpc.Code: ABORTED = 10;
  • HTTP code: 409 Conflict

• ReadonlyALREADY_EXISTS: "ALREADY_EXISTS"

  Operation was rejected due a conflict with an existing resource, e.g. attempted to create file or directory that already exists.

  Prefer this over RESOURCE_CONFLICT.

  Maps to:

  • google.rpc.Code: ALREADY_EXISTS = 6;
  • HTTP code: 409 Conflict

• ReadonlyBAD_REQUEST: "BAD_REQUEST"

  The request is invalid. Prefer more specific error code whenever possible. Also see similar recommendation for the google.rpc.Code.FAILED_PRECONDITION.

  Prefer this error code over MALFORMED_REQUEST, INVALID_STATE, UNPARSEABLE_HTTP_ERROR.

  Maps to:

  • google.rpc.Code: FAILED_PRECONDITION = 9;
  • HTTP code: 400 Bad Request

• ReadonlyCANCELLED: "CANCELLED"

  The operation was canceled by the caller. An example - client closed the connection without waiting for a response.

  Maps to:

  • google.rpc.Code: CANCELLED = 1;
  • HTTP code: 499 Client Closed Request

• ReadonlyCATALOG_ALREADY_EXISTS: "CATALOG_ALREADY_EXISTS"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyCATALOG_DOES_NOT_EXIST: "CATALOG_DOES_NOT_EXIST"

• ReadonlyCATALOG_NOT_EMPTY: "CATALOG_NOT_EMPTY"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyCOULD_NOT_ACQUIRE_LOCK: "COULD_NOT_ACQUIRE_LOCK"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. Unable to perform the operation because the shard was locked by some other operation.

• ReadonlyCUSTOMER_UNAUTHORIZED: "CUSTOMER_UNAUTHORIZED"

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

  For authentication (AuthN) errors prefer using UNAUTHENTICATED, unless you need to keep consistent behavior with legacy code. For authorization (AuthZ) errors use PERMISSION_DENIED.

  Important: name is confusing, this error code is for authentication (AuthN) errors, not authorization (AuthZ) errors. It maps to 401 Unauthorized and suffers from the same confusing naming. See https://datatracker.ietf.org/doc/html/rfc7235#section-3.1 - "[...] status code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource. [...] If the request included authentication credentials, then the 401 response indicates that authorization has been refused for those credentials."

  Also, see https://stackoverflow.com/a/6937030/16352922, it covers it pretty well.

  Maps to:

  • google.rpc.Code: UNAUTHENTICATED = 16;
  • HTTP code: 401 Unauthorized

• ReadonlyDAC_ALREADY_EXISTS: "DAC_ALREADY_EXISTS"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyDAC_DOES_NOT_EXIST: "DAC_DOES_NOT_EXIST"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyDATA_LOSS: "DATA_LOSS"

  Unrecoverable data loss or corruption.

  One of the major use cases is to indicate that server failed to validate the integrity of the request. This error can occur when the checksum specified in the X-Databricks-Checksum request header (or trailer) doesn't match the actual request content checksum.

  Note, in case of the severe corruption that results in a malformed request, the server may send a generic 400 Bad Request response rather than sending this error code.

  Maps to:

  • google.rpc.Code: DATA_LOSS = 15;
  • HTTP code: 500 Internal Server Error

• ReadonlyDEADLINE_EXCEEDED: "DEADLINE_EXCEEDED"

  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. When possible - implementations should make sure further processing of the request is aborted, e.g. by throwing an exception instead of making the RPC request, making the database query, etc.

  Maps to:

  • google.rpc.Code: DEADLINE_EXCEEDED = 4;
  • HTTP code: 504 Gateway Timeout

• ReadonlyDEPLOYMENT_TIMEOUT: "DEPLOYMENT_TIMEOUT"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyDIRECTORY_NOT_EMPTY: "DIRECTORY_NOT_EMPTY"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyDIRECTORY_PROTECTED: "DIRECTORY_PROTECTED"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyDRY_RUN_FAILED: "DRY_RUN_FAILED"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyENDPOINT_NOT_FOUND: "ENDPOINT_NOT_FOUND"

  Indicates that the given API endpoint does not exist. Legacy, when possible - NOT_IMPLEMENTED should be used instead to indicate that API doesn't exist.

  Maps to:

  • google.rpc.Code: NOT_FOUND = 5;
  • HTTP code: 404 Not Found

• ReadonlyEXTERNAL_LOCATION_ALREADY_EXISTS: "EXTERNAL_LOCATION_ALREADY_EXISTS"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyEXTERNAL_LOCATION_DOES_NOT_EXIST: "EXTERNAL_LOCATION_DOES_NOT_EXIST"

• ReadonlyFEATURE_DISABLED: "FEATURE_DISABLED"

  NOTE: Deprecated due to inconsistent mapping in legacy code, see https://docs.google.com/document/d/17TZIKX_Y39cJMBr333lc-d5dTvvBLSu3DPUyGU5eMJg/edit?disco=AAAAzVGt6FA. Prefer using NOT_FOUND or PERMISSION_DENIED.

  If a given user/entity is trying to use a feature which has been disabled.

  Maps to:

  • google.rpc.Code: NOT_FOUND = 5;
  • HTTP code: 404 Not Found

• ReadonlyGIT_CONFLICT: "GIT_CONFLICT"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyGIT_REMOTE_ERROR: "GIT_REMOTE_ERROR"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyGIT_SENSITIVE_TOKEN_DETECTED: "GIT_SENSITIVE_TOKEN_DETECTED"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyGIT_UNKNOWN_REF: "GIT_UNKNOWN_REF"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyGIT_URL_NOT_ON_ALLOW_LIST: "GIT_URL_NOT_ON_ALLOW_LIST"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyINSECURE_PARTNER_RESPONSE: "INSECURE_PARTNER_RESPONSE"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyINTERNAL_ERROR: "INTERNAL_ERROR"

  Internal error. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors, which generally cannot be resolved by the user.

  Prefer this over all kinds of detailed error messages (e.g IO_ERROR), unless there's some automation that relies on the custom error code.

  Maps to:

  • google.rpc.Code: INTERNAL = 13;
  • HTTP code: 500 Internal Server Error

• ReadonlyINVALID_PARAMETER_VALUE: "INVALID_PARAMETER_VALUE"

  Supplied value for a parameter was invalid (e.g., giving a number for a string parameter).

  Maps to:

  • google.rpc.Code: INVALID_ARGUMENT = 3;
  • HTTP code: 400 Bad Request

• ReadonlyINVALID_STATE: "INVALID_STATE"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. If one or more of the inputs to a given RPC are not in a valid state for the action.

• ReadonlyINVALID_STATE_TRANSITION: "INVALID_STATE_TRANSITION"

  If the user attempts to perform an invalid state transition on a shard.

• ReadonlyIO_ERROR: "IO_ERROR"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. Indicates that an IOException has been internally thrown.

• ReadonlyIPYNB_FILE_IN_REPO: "IPYNB_FILE_IN_REPO"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyMALFORMED_PARTNER_RESPONSE: "MALFORMED_PARTNER_RESPONSE"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyMALFORMED_REQUEST: "MALFORMED_REQUEST"

  Indicates that the given API request was malformed.

• ReadonlyMANAGED_RESOURCE_GROUP_DOES_NOT_EXIST: "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyMAX_BLOCK_SIZE_EXCEEDED: "MAX_BLOCK_SIZE_EXCEEDED"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyMAX_CHILD_NODE_SIZE_EXCEEDED: "MAX_CHILD_NODE_SIZE_EXCEEDED"

• ReadonlyMAX_LIST_SIZE_EXCEEDED: "MAX_LIST_SIZE_EXCEEDED"

• ReadonlyMAX_NOTEBOOK_SIZE_EXCEEDED: "MAX_NOTEBOOK_SIZE_EXCEEDED"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyMAX_READ_SIZE_EXCEEDED: "MAX_READ_SIZE_EXCEEDED"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyMETASTORE_ALREADY_EXISTS: "METASTORE_ALREADY_EXISTS"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyMETASTORE_DOES_NOT_EXIST: "METASTORE_DOES_NOT_EXIST"

• ReadonlyMETASTORE_NOT_EMPTY: "METASTORE_NOT_EMPTY"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyNOT_FOUND: "NOT_FOUND"

  Operation was performed on a resource that does not exist, e.g. file or directory was not found.

  Maps to:

  • google.rpc.Code: NOT_FOUND = 5;
  • HTTP code: 404 Not Found

• ReadonlyNOT_IMPLEMENTED: "NOT_IMPLEMENTED"

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

  Maps to:

  • google.rpc.Code: UNIMPLEMENTED = 12;
  • HTTP code: 501 Not Implemented

• ReadonlyPARTIAL_DELETE: "PARTIAL_DELETE"

• ReadonlyPERMISSION_DENIED: "PERMISSION_DENIED"

  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 CUSTOMER_UNAUTHORIZED instead for those errors. This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions.

  Maps to:

  • google.rpc.Code: PERMISSION_DENIED = 7;
  • HTTP code: 403 Forbidden

• ReadonlyPERMISSION_NOT_PROPAGATED: "PERMISSION_NOT_PROPAGATED"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyPRINCIPAL_DOES_NOT_EXIST: "PRINCIPAL_DOES_NOT_EXIST"

• ReadonlyPROJECTS_OPERATION_TIMEOUT: "PROJECTS_OPERATION_TIMEOUT"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyPROVIDER_ALREADY_EXISTS: "PROVIDER_ALREADY_EXISTS"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyPROVIDER_DOES_NOT_EXIST: "PROVIDER_DOES_NOT_EXIST"

• ReadonlyPROVIDER_SHARE_NOT_ACCESSIBLE: "PROVIDER_SHARE_NOT_ACCESSIBLE"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyQUOTA_EXCEEDED: "QUOTA_EXCEEDED"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyRECIPIENT_ALREADY_EXISTS: "RECIPIENT_ALREADY_EXISTS"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyRECIPIENT_DOES_NOT_EXIST: "RECIPIENT_DOES_NOT_EXIST"

• ReadonlyREQUEST_LIMIT_EXCEEDED: "REQUEST_LIMIT_EXCEEDED"

  The operation is rejected because of request rate limit, for example rate limiting applied to users, workspaces, IP addresses, etc.

  Prefer a more generic RESOURCE_EXHAUSTED for the new use cases.

  See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit# for guideline on the rate limiting vs throttling.

  Maps to:

  • google.rpc.Code: RESOURCE_EXHAUSTED = 8;
  • HTTP code: 429 Too Many Requests

• ReadonlyRESOURCE_ALREADY_EXISTS: "RESOURCE_ALREADY_EXISTS"

  NOTE: Deprecated, prefer using ALREADY_EXISTS. Unlike ALREADY_EXISTS - this maps to HTTP code 400 Bad Request due to legacy reasons, remapping will be a backwards incompatible change.

  Operation was performed on a resource that already exists.

• ReadonlyRESOURCE_CONFLICT: "RESOURCE_CONFLICT"

  Indicates API request was rejected due a conflict with an existing resource.

• ReadonlyRESOURCE_DOES_NOT_EXIST: "RESOURCE_DOES_NOT_EXIST"

  NOTE: Deprecated, prefer using NOT_FOUND - see the note for the RESOURCE_ALREADY_EXISTS, because this pair of codes is related and RESOURCE_ALREADY_EXISTS has bad mapping to the HTTP codes we added new error codes NOT_FOUND and ALREADY_EXISTS, and recommend to use them instead.

  Operation was performed on a resource that does not exist.

• ReadonlyRESOURCE_EXHAUSTED: "RESOURCE_EXHAUSTED"

  The operation is rejected because of either rate limiting or resource quota, such as the client has sent too many requests recently or the client has allocated too many resources.

  See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit# for guideline on how to pick this vs TEMPORARILY_UNAVAILABLE.

  Maps to:

  • google.rpc.Code: RESOURCE_EXHAUSTED = 8;
  • HTTP code: 429 Too Many Requests

• ReadonlyRESOURCE_LIMIT_EXCEEDED: "RESOURCE_LIMIT_EXCEEDED"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. Cluster request was rejected because it would exceed a resource limit.

• ReadonlySCHEMA_ALREADY_EXISTS: "SCHEMA_ALREADY_EXISTS"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlySCHEMA_DOES_NOT_EXIST: "SCHEMA_DOES_NOT_EXIST"

• ReadonlySCHEMA_NOT_EMPTY: "SCHEMA_NOT_EMPTY"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlySEARCH_QUERY_TOO_LONG: "SEARCH_QUERY_TOO_LONG"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlySEARCH_QUERY_TOO_SHORT: "SEARCH_QUERY_TOO_SHORT"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlySERVICE_UNDER_MAINTENANCE: "SERVICE_UNDER_MAINTENANCE"

  An external service is unavailable temporarily as it is being updated/re-deployed. Indicates gateway proxy to safely retry the request.

• ReadonlySHARE_ALREADY_EXISTS: "SHARE_ALREADY_EXISTS"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlySHARE_DOES_NOT_EXIST: "SHARE_DOES_NOT_EXIST"

• ReadonlySTORAGE_CREDENTIAL_ALREADY_EXISTS: "STORAGE_CREDENTIAL_ALREADY_EXISTS"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlySTORAGE_CREDENTIAL_DOES_NOT_EXIST: "STORAGE_CREDENTIAL_DOES_NOT_EXIST"

• ReadonlyTABLE_ALREADY_EXISTS: "TABLE_ALREADY_EXISTS"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.

• ReadonlyTABLE_DOES_NOT_EXIST: "TABLE_DOES_NOT_EXIST"

• ReadonlyTEMPORARILY_UNAVAILABLE: "TEMPORARILY_UNAVAILABLE"

  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.

  Prefer this over SERVICE_UNDER_MAINTENANCE, WORKSPACE_TEMPORARILY_UNAVAILABLE.

  See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit# for guideline on how to pick this vs RESOURCE_EXHAUSTED.

  Maps to:

  • google.rpc.Code: UNAVAILABLE = 14;
  • HTTP code: 503 Service Unavailable

• ReadonlyUNAUTHENTICATED: "UNAUTHENTICATED"

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

  Prefer this over CUSTOMER_UNAUTHORIZED, unless you need to keep consistent behavior with legacy code. For authorization (AuthZ) errors use PERMISSION_DENIED.

  Maps to:

  • google.rpc.Code: UNAUTHENTICATED = 16;
  • HTTP code: 401 Unauthorized

• ReadonlyUNAVAILABLE: "UNAVAILABLE"

  The service is currently unavailable. Please note that the unavailability may or may not be transient. That means if this is a non-transient condition, retrying it does not work. If the unavailability is certainly a transient condition, pleases use TEMPORARILY_UNAVAILABLE which signals its transient nature explicitly. An example of this error code’s use case is that when DNS resolution fails, the DNS resolver does not know whether it is because the domain name is completely wrong (non-transient situation) or the domain name is valid but the DNS server does not have an entry for this domain name yet (transient situation). Hence, UNAVAILABLE is suitable for this case.

  Maps to:

  • google.rpc.Code: UNAVAILABLE = 14;
  • HTTP code: 503 Service Unavailable

• ReadonlyUNKNOWN: "UNKNOWN"

  Unknown error. This error generally should not be returned explicitly, but will be used as a fallback if the error enum is missing from the message for some reason.

  It's assigned tag 0 to follow the best practice from https://developers.google.com/protocol-buffers/docs/style#enums

  TODO(PLAT-55898): Add custom option to declare HTTP and gRPC mappings. Maps to:

  • google.rpc.Code: UNKNOWN = 2;
  • HTTP code: 500 Internal Server Error

• ReadonlyUNPARSEABLE_HTTP_ERROR: "UNPARSEABLE_HTTP_ERROR"

  NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. Indicates that the HTTP response cannot be correctly deserialized. This currently is only used in DUST test clients, and not by any real service code.

• ReadonlyWORKSPACE_TEMPORARILY_UNAVAILABLE: "WORKSPACE_TEMPORARILY_UNAVAILABLE"

  A workspace is temporarily unavailable as the workspace is being re-assigned.