Environments
============

These dataclasses are used in the SDK to represent API requests and responses for services in the ``databricks.sdk.service.environments`` module.

.. py:currentmodule:: databricks.sdk.service.environments
.. py:class:: BaseEnvironmentType

   If changed, also update estore/namespaces/defaultbaseenvironments/latest.proto

   .. py:attribute:: CPU
      :value: "CPU"

   .. py:attribute:: GPU
      :value: "GPU"

.. autoclass:: DatabricksServiceExceptionWithDetailsProto
   :members:
   :undoc-members:

.. autoclass:: DefaultWorkspaceBaseEnvironment
   :members:
   :undoc-members:

.. py:class:: ErrorCode

   Error codes returned by Databricks APIs to indicate specific failure conditions.

   .. py:attribute:: ABORTED
      :value: "ABORTED"

   .. py:attribute:: ALREADY_EXISTS
      :value: "ALREADY_EXISTS"

   .. py:attribute:: BAD_REQUEST
      :value: "BAD_REQUEST"

   .. py:attribute:: CANCELLED
      :value: "CANCELLED"

   .. py:attribute:: CATALOG_ALREADY_EXISTS
      :value: "CATALOG_ALREADY_EXISTS"

   .. py:attribute:: CATALOG_DOES_NOT_EXIST
      :value: "CATALOG_DOES_NOT_EXIST"

   .. py:attribute:: CATALOG_NOT_EMPTY
      :value: "CATALOG_NOT_EMPTY"

   .. py:attribute:: COULD_NOT_ACQUIRE_LOCK
      :value: "COULD_NOT_ACQUIRE_LOCK"

   .. py:attribute:: CUSTOMER_UNAUTHORIZED
      :value: "CUSTOMER_UNAUTHORIZED"

   .. py:attribute:: DAC_ALREADY_EXISTS
      :value: "DAC_ALREADY_EXISTS"

   .. py:attribute:: DAC_DOES_NOT_EXIST
      :value: "DAC_DOES_NOT_EXIST"

   .. py:attribute:: DATA_LOSS
      :value: "DATA_LOSS"

   .. py:attribute:: DEADLINE_EXCEEDED
      :value: "DEADLINE_EXCEEDED"

   .. py:attribute:: DEPLOYMENT_TIMEOUT
      :value: "DEPLOYMENT_TIMEOUT"

   .. py:attribute:: DIRECTORY_NOT_EMPTY
      :value: "DIRECTORY_NOT_EMPTY"

   .. py:attribute:: DIRECTORY_PROTECTED
      :value: "DIRECTORY_PROTECTED"

   .. py:attribute:: DRY_RUN_FAILED
      :value: "DRY_RUN_FAILED"

   .. py:attribute:: ENDPOINT_NOT_FOUND
      :value: "ENDPOINT_NOT_FOUND"

   .. py:attribute:: EXTERNAL_LOCATION_ALREADY_EXISTS
      :value: "EXTERNAL_LOCATION_ALREADY_EXISTS"

   .. py:attribute:: EXTERNAL_LOCATION_DOES_NOT_EXIST
      :value: "EXTERNAL_LOCATION_DOES_NOT_EXIST"

   .. py:attribute:: FEATURE_DISABLED
      :value: "FEATURE_DISABLED"

   .. py:attribute:: GIT_CONFLICT
      :value: "GIT_CONFLICT"

   .. py:attribute:: GIT_REMOTE_ERROR
      :value: "GIT_REMOTE_ERROR"

   .. py:attribute:: GIT_SENSITIVE_TOKEN_DETECTED
      :value: "GIT_SENSITIVE_TOKEN_DETECTED"

   .. py:attribute:: GIT_UNKNOWN_REF
      :value: "GIT_UNKNOWN_REF"

   .. py:attribute:: GIT_URL_NOT_ON_ALLOW_LIST
      :value: "GIT_URL_NOT_ON_ALLOW_LIST"

   .. py:attribute:: INSECURE_PARTNER_RESPONSE
      :value: "INSECURE_PARTNER_RESPONSE"

   .. py:attribute:: INTERNAL_ERROR
      :value: "INTERNAL_ERROR"

   .. py:attribute:: INVALID_PARAMETER_VALUE
      :value: "INVALID_PARAMETER_VALUE"

   .. py:attribute:: INVALID_STATE
      :value: "INVALID_STATE"

   .. py:attribute:: INVALID_STATE_TRANSITION
      :value: "INVALID_STATE_TRANSITION"

   .. py:attribute:: IO_ERROR
      :value: "IO_ERROR"

   .. py:attribute:: IPYNB_FILE_IN_REPO
      :value: "IPYNB_FILE_IN_REPO"

   .. py:attribute:: MALFORMED_PARTNER_RESPONSE
      :value: "MALFORMED_PARTNER_RESPONSE"

   .. py:attribute:: MALFORMED_REQUEST
      :value: "MALFORMED_REQUEST"

   .. py:attribute:: MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST
      :value: "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST"

   .. py:attribute:: MAX_BLOCK_SIZE_EXCEEDED
      :value: "MAX_BLOCK_SIZE_EXCEEDED"

   .. py:attribute:: MAX_CHILD_NODE_SIZE_EXCEEDED
      :value: "MAX_CHILD_NODE_SIZE_EXCEEDED"

   .. py:attribute:: MAX_LIST_SIZE_EXCEEDED
      :value: "MAX_LIST_SIZE_EXCEEDED"

   .. py:attribute:: MAX_NOTEBOOK_SIZE_EXCEEDED
      :value: "MAX_NOTEBOOK_SIZE_EXCEEDED"

   .. py:attribute:: MAX_READ_SIZE_EXCEEDED
      :value: "MAX_READ_SIZE_EXCEEDED"

   .. py:attribute:: METASTORE_ALREADY_EXISTS
      :value: "METASTORE_ALREADY_EXISTS"

   .. py:attribute:: METASTORE_DOES_NOT_EXIST
      :value: "METASTORE_DOES_NOT_EXIST"

   .. py:attribute:: METASTORE_NOT_EMPTY
      :value: "METASTORE_NOT_EMPTY"

   .. py:attribute:: NOT_FOUND
      :value: "NOT_FOUND"

   .. py:attribute:: NOT_IMPLEMENTED
      :value: "NOT_IMPLEMENTED"

   .. py:attribute:: PARTIAL_DELETE
      :value: "PARTIAL_DELETE"

   .. py:attribute:: PERMISSION_DENIED
      :value: "PERMISSION_DENIED"

   .. py:attribute:: PERMISSION_NOT_PROPAGATED
      :value: "PERMISSION_NOT_PROPAGATED"

   .. py:attribute:: PRINCIPAL_DOES_NOT_EXIST
      :value: "PRINCIPAL_DOES_NOT_EXIST"

   .. py:attribute:: PROJECTS_OPERATION_TIMEOUT
      :value: "PROJECTS_OPERATION_TIMEOUT"

   .. py:attribute:: PROVIDER_ALREADY_EXISTS
      :value: "PROVIDER_ALREADY_EXISTS"

   .. py:attribute:: PROVIDER_DOES_NOT_EXIST
      :value: "PROVIDER_DOES_NOT_EXIST"

   .. py:attribute:: PROVIDER_SHARE_NOT_ACCESSIBLE
      :value: "PROVIDER_SHARE_NOT_ACCESSIBLE"

   .. py:attribute:: QUOTA_EXCEEDED
      :value: "QUOTA_EXCEEDED"

   .. py:attribute:: RECIPIENT_ALREADY_EXISTS
      :value: "RECIPIENT_ALREADY_EXISTS"

   .. py:attribute:: RECIPIENT_DOES_NOT_EXIST
      :value: "RECIPIENT_DOES_NOT_EXIST"

   .. py:attribute:: REQUEST_LIMIT_EXCEEDED
      :value: "REQUEST_LIMIT_EXCEEDED"

   .. py:attribute:: RESOURCE_ALREADY_EXISTS
      :value: "RESOURCE_ALREADY_EXISTS"

   .. py:attribute:: RESOURCE_CONFLICT
      :value: "RESOURCE_CONFLICT"

   .. py:attribute:: RESOURCE_DOES_NOT_EXIST
      :value: "RESOURCE_DOES_NOT_EXIST"

   .. py:attribute:: RESOURCE_EXHAUSTED
      :value: "RESOURCE_EXHAUSTED"

   .. py:attribute:: RESOURCE_LIMIT_EXCEEDED
      :value: "RESOURCE_LIMIT_EXCEEDED"

   .. py:attribute:: SCHEMA_ALREADY_EXISTS
      :value: "SCHEMA_ALREADY_EXISTS"

   .. py:attribute:: SCHEMA_DOES_NOT_EXIST
      :value: "SCHEMA_DOES_NOT_EXIST"

   .. py:attribute:: SCHEMA_NOT_EMPTY
      :value: "SCHEMA_NOT_EMPTY"

   .. py:attribute:: SEARCH_QUERY_TOO_LONG
      :value: "SEARCH_QUERY_TOO_LONG"

   .. py:attribute:: SEARCH_QUERY_TOO_SHORT
      :value: "SEARCH_QUERY_TOO_SHORT"

   .. py:attribute:: SERVICE_UNDER_MAINTENANCE
      :value: "SERVICE_UNDER_MAINTENANCE"

   .. py:attribute:: SHARE_ALREADY_EXISTS
      :value: "SHARE_ALREADY_EXISTS"

   .. py:attribute:: SHARE_DOES_NOT_EXIST
      :value: "SHARE_DOES_NOT_EXIST"

   .. py:attribute:: STORAGE_CREDENTIAL_ALREADY_EXISTS
      :value: "STORAGE_CREDENTIAL_ALREADY_EXISTS"

   .. py:attribute:: STORAGE_CREDENTIAL_DOES_NOT_EXIST
      :value: "STORAGE_CREDENTIAL_DOES_NOT_EXIST"

   .. py:attribute:: TABLE_ALREADY_EXISTS
      :value: "TABLE_ALREADY_EXISTS"

   .. py:attribute:: TABLE_DOES_NOT_EXIST
      :value: "TABLE_DOES_NOT_EXIST"

   .. py:attribute:: TEMPORARILY_UNAVAILABLE
      :value: "TEMPORARILY_UNAVAILABLE"

   .. py:attribute:: UNAUTHENTICATED
      :value: "UNAUTHENTICATED"

   .. py:attribute:: UNAVAILABLE
      :value: "UNAVAILABLE"

   .. py:attribute:: UNKNOWN
      :value: "UNKNOWN"

   .. py:attribute:: UNPARSEABLE_HTTP_ERROR
      :value: "UNPARSEABLE_HTTP_ERROR"

   .. py:attribute:: WORKSPACE_TEMPORARILY_UNAVAILABLE
      :value: "WORKSPACE_TEMPORARILY_UNAVAILABLE"

.. autoclass:: ListWorkspaceBaseEnvironmentsResponse
   :members:
   :undoc-members:

.. autoclass:: Operation
   :members:
   :undoc-members:

.. autoclass:: WorkspaceBaseEnvironment
   :members:
   :undoc-members:

.. py:class:: WorkspaceBaseEnvironmentCacheStatus

   Status of the environment materialization.

   .. py:attribute:: CREATED
      :value: "CREATED"

   .. py:attribute:: EXPIRED
      :value: "EXPIRED"

   .. py:attribute:: FAILED
      :value: "FAILED"

   .. py:attribute:: INVALID
      :value: "INVALID"

   .. py:attribute:: PENDING
      :value: "PENDING"

   .. py:attribute:: REFRESHING
      :value: "REFRESHING"

.. autoclass:: WorkspaceBaseEnvironmentOperationMetadata
   :members:
   :undoc-members: