databricks-sdk 0.40.0__py3-none-any.whl → 0.42.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of databricks-sdk might be problematic. Click here for more details.
- databricks/sdk/__init__.py +273 -239
- databricks/sdk/_base_client.py +36 -24
- databricks/sdk/config.py +5 -0
- databricks/sdk/credentials_provider.py +35 -20
- databricks/sdk/data_plane.py +1 -1
- databricks/sdk/mixins/files.py +184 -1
- databricks/sdk/mixins/open_ai_client.py +55 -1
- databricks/sdk/retries.py +5 -1
- databricks/sdk/service/apps.py +12 -4
- databricks/sdk/service/billing.py +348 -0
- databricks/sdk/service/catalog.py +16 -62
- databricks/sdk/service/cleanrooms.py +73 -2
- databricks/sdk/service/compute.py +40 -0
- databricks/sdk/service/dashboards.py +12 -4
- databricks/sdk/service/files.py +6 -3
- databricks/sdk/service/iam.py +158 -0
- databricks/sdk/service/jobs.py +253 -17
- databricks/sdk/service/oauth2.py +94 -50
- databricks/sdk/service/pipelines.py +89 -12
- databricks/sdk/service/serving.py +424 -222
- databricks/sdk/service/settings.py +206 -0
- databricks/sdk/service/sharing.py +51 -54
- databricks/sdk/useragent.py +54 -0
- databricks/sdk/version.py +1 -1
- {databricks_sdk-0.40.0.dist-info → databricks_sdk-0.42.0.dist-info}/METADATA +26 -26
- {databricks_sdk-0.40.0.dist-info → databricks_sdk-0.42.0.dist-info}/RECORD +30 -30
- {databricks_sdk-0.40.0.dist-info → databricks_sdk-0.42.0.dist-info}/WHEEL +1 -1
- {databricks_sdk-0.40.0.dist-info → databricks_sdk-0.42.0.dist-info}/LICENSE +0 -0
- {databricks_sdk-0.40.0.dist-info → databricks_sdk-0.42.0.dist-info}/NOTICE +0 -0
- {databricks_sdk-0.40.0.dist-info → databricks_sdk-0.42.0.dist-info}/top_level.txt +0 -0
databricks/sdk/__init__.py
CHANGED
|
@@ -1,17 +1,22 @@
|
|
|
1
|
+
# Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
import logging
|
|
1
4
|
from typing import Optional
|
|
2
5
|
|
|
3
6
|
import databricks.sdk.core as client
|
|
4
7
|
import databricks.sdk.dbutils as dbutils
|
|
8
|
+
import databricks.sdk.service as service
|
|
5
9
|
from databricks.sdk import azure
|
|
6
10
|
from databricks.sdk.credentials_provider import CredentialsStrategy
|
|
7
11
|
from databricks.sdk.mixins.compute import ClustersExt
|
|
8
|
-
from databricks.sdk.mixins.files import DbfsExt
|
|
12
|
+
from databricks.sdk.mixins.files import DbfsExt, FilesExt
|
|
9
13
|
from databricks.sdk.mixins.jobs import JobsExt
|
|
10
14
|
from databricks.sdk.mixins.open_ai_client import ServingEndpointsExt
|
|
11
15
|
from databricks.sdk.mixins.workspace import WorkspaceExt
|
|
12
16
|
from databricks.sdk.service.apps import AppsAPI
|
|
13
|
-
from databricks.sdk.service.billing import (BillableUsageAPI,
|
|
14
|
-
LogDeliveryAPI,
|
|
17
|
+
from databricks.sdk.service.billing import (BillableUsageAPI, BudgetPolicyAPI,
|
|
18
|
+
BudgetsAPI, LogDeliveryAPI,
|
|
19
|
+
UsageDashboardsAPI)
|
|
15
20
|
from databricks.sdk.service.catalog import (AccountMetastoreAssignmentsAPI,
|
|
16
21
|
AccountMetastoresAPI,
|
|
17
22
|
AccountStorageCredentialsAPI,
|
|
@@ -40,7 +45,8 @@ from databricks.sdk.service.compute import (ClusterPoliciesAPI, ClustersAPI,
|
|
|
40
45
|
PolicyFamiliesAPI)
|
|
41
46
|
from databricks.sdk.service.dashboards import GenieAPI, LakeviewAPI
|
|
42
47
|
from databricks.sdk.service.files import DbfsAPI, FilesAPI
|
|
43
|
-
from databricks.sdk.service.iam import (
|
|
48
|
+
from databricks.sdk.service.iam import (AccessControlAPI,
|
|
49
|
+
AccountAccessControlAPI,
|
|
44
50
|
AccountAccessControlProxyAPI,
|
|
45
51
|
AccountGroupsAPI,
|
|
46
52
|
AccountServicePrincipalsAPI,
|
|
@@ -76,7 +82,7 @@ from databricks.sdk.service.settings import (
|
|
|
76
82
|
AibiDashboardEmbeddingApprovedDomainsAPI, AutomaticClusterUpdateAPI,
|
|
77
83
|
ComplianceSecurityProfileAPI, CredentialsManagerAPI,
|
|
78
84
|
CspEnablementAccountAPI, DefaultNamespaceAPI, DisableLegacyAccessAPI,
|
|
79
|
-
DisableLegacyDbfsAPI, DisableLegacyFeaturesAPI,
|
|
85
|
+
DisableLegacyDbfsAPI, DisableLegacyFeaturesAPI, EnableIpAccessListsAPI,
|
|
80
86
|
EnhancedSecurityMonitoringAPI, EsmEnablementAccountAPI, IpAccessListsAPI,
|
|
81
87
|
NetworkConnectivityAPI, NotificationDestinationsAPI, PersonalComputeAPI,
|
|
82
88
|
RestrictWorkspaceAdminsAPI, SettingsAPI, TokenManagementAPI, TokensAPI,
|
|
@@ -97,6 +103,8 @@ from databricks.sdk.service.vectorsearch import (VectorSearchEndpointsAPI,
|
|
|
97
103
|
from databricks.sdk.service.workspace import (GitCredentialsAPI, ReposAPI,
|
|
98
104
|
SecretsAPI, WorkspaceAPI)
|
|
99
105
|
|
|
106
|
+
_LOG = logging.getLogger(__name__)
|
|
107
|
+
|
|
100
108
|
|
|
101
109
|
def _make_dbutils(config: client.Config):
|
|
102
110
|
# We try to directly check if we are in runtime, instead of
|
|
@@ -114,6 +122,14 @@ def _make_dbutils(config: client.Config):
|
|
|
114
122
|
return runtime_dbutils
|
|
115
123
|
|
|
116
124
|
|
|
125
|
+
def _make_files_client(apiClient: client.ApiClient, config: client.Config):
|
|
126
|
+
if config.enable_experimental_files_api_client:
|
|
127
|
+
_LOG.info("Experimental Files API client is enabled")
|
|
128
|
+
return FilesExt(apiClient, config)
|
|
129
|
+
else:
|
|
130
|
+
return FilesAPI(apiClient)
|
|
131
|
+
|
|
132
|
+
|
|
117
133
|
class WorkspaceClient:
|
|
118
134
|
"""
|
|
119
135
|
The WorkspaceClient is a client for the workspace-level Databricks REST API.
|
|
@@ -175,101 +191,106 @@ class WorkspaceClient:
|
|
|
175
191
|
self._dbutils = _make_dbutils(self._config)
|
|
176
192
|
self._api_client = client.ApiClient(self._config)
|
|
177
193
|
serving_endpoints = ServingEndpointsExt(self._api_client)
|
|
178
|
-
self.
|
|
179
|
-
self.
|
|
180
|
-
self.
|
|
181
|
-
self.
|
|
182
|
-
self.
|
|
183
|
-
self.
|
|
184
|
-
self.
|
|
185
|
-
self.
|
|
186
|
-
self.
|
|
187
|
-
self.
|
|
194
|
+
self._access_control = service.iam.AccessControlAPI(self._api_client)
|
|
195
|
+
self._account_access_control_proxy = service.iam.AccountAccessControlProxyAPI(self._api_client)
|
|
196
|
+
self._alerts = service.sql.AlertsAPI(self._api_client)
|
|
197
|
+
self._alerts_legacy = service.sql.AlertsLegacyAPI(self._api_client)
|
|
198
|
+
self._apps = service.apps.AppsAPI(self._api_client)
|
|
199
|
+
self._artifact_allowlists = service.catalog.ArtifactAllowlistsAPI(self._api_client)
|
|
200
|
+
self._catalogs = service.catalog.CatalogsAPI(self._api_client)
|
|
201
|
+
self._clean_room_assets = service.cleanrooms.CleanRoomAssetsAPI(self._api_client)
|
|
202
|
+
self._clean_room_task_runs = service.cleanrooms.CleanRoomTaskRunsAPI(self._api_client)
|
|
203
|
+
self._clean_rooms = service.cleanrooms.CleanRoomsAPI(self._api_client)
|
|
204
|
+
self._cluster_policies = service.compute.ClusterPoliciesAPI(self._api_client)
|
|
188
205
|
self._clusters = ClustersExt(self._api_client)
|
|
189
|
-
self._command_execution = CommandExecutionAPI(self._api_client)
|
|
190
|
-
self._connections = ConnectionsAPI(self._api_client)
|
|
191
|
-
self._consumer_fulfillments = ConsumerFulfillmentsAPI(self._api_client)
|
|
192
|
-
self._consumer_installations = ConsumerInstallationsAPI(self._api_client)
|
|
193
|
-
self._consumer_listings = ConsumerListingsAPI(self._api_client)
|
|
194
|
-
self._consumer_personalization_requests = ConsumerPersonalizationRequestsAPI(
|
|
195
|
-
|
|
196
|
-
self.
|
|
197
|
-
self.
|
|
198
|
-
self.
|
|
199
|
-
self.
|
|
200
|
-
self.
|
|
201
|
-
self.
|
|
206
|
+
self._command_execution = service.compute.CommandExecutionAPI(self._api_client)
|
|
207
|
+
self._connections = service.catalog.ConnectionsAPI(self._api_client)
|
|
208
|
+
self._consumer_fulfillments = service.marketplace.ConsumerFulfillmentsAPI(self._api_client)
|
|
209
|
+
self._consumer_installations = service.marketplace.ConsumerInstallationsAPI(self._api_client)
|
|
210
|
+
self._consumer_listings = service.marketplace.ConsumerListingsAPI(self._api_client)
|
|
211
|
+
self._consumer_personalization_requests = service.marketplace.ConsumerPersonalizationRequestsAPI(
|
|
212
|
+
self._api_client)
|
|
213
|
+
self._consumer_providers = service.marketplace.ConsumerProvidersAPI(self._api_client)
|
|
214
|
+
self._credentials = service.catalog.CredentialsAPI(self._api_client)
|
|
215
|
+
self._credentials_manager = service.settings.CredentialsManagerAPI(self._api_client)
|
|
216
|
+
self._current_user = service.iam.CurrentUserAPI(self._api_client)
|
|
217
|
+
self._dashboard_widgets = service.sql.DashboardWidgetsAPI(self._api_client)
|
|
218
|
+
self._dashboards = service.sql.DashboardsAPI(self._api_client)
|
|
219
|
+
self._data_sources = service.sql.DataSourcesAPI(self._api_client)
|
|
202
220
|
self._dbfs = DbfsExt(self._api_client)
|
|
203
|
-
self._dbsql_permissions = DbsqlPermissionsAPI(self._api_client)
|
|
204
|
-
self._experiments = ExperimentsAPI(self._api_client)
|
|
205
|
-
self._external_locations = ExternalLocationsAPI(self._api_client)
|
|
206
|
-
self._files =
|
|
207
|
-
self._functions = FunctionsAPI(self._api_client)
|
|
208
|
-
self._genie = GenieAPI(self._api_client)
|
|
209
|
-
self._git_credentials = GitCredentialsAPI(self._api_client)
|
|
210
|
-
self._global_init_scripts = GlobalInitScriptsAPI(self._api_client)
|
|
211
|
-
self._grants = GrantsAPI(self._api_client)
|
|
212
|
-
self._groups = GroupsAPI(self._api_client)
|
|
213
|
-
self._instance_pools = InstancePoolsAPI(self._api_client)
|
|
214
|
-
self._instance_profiles = InstanceProfilesAPI(self._api_client)
|
|
215
|
-
self._ip_access_lists = IpAccessListsAPI(self._api_client)
|
|
221
|
+
self._dbsql_permissions = service.sql.DbsqlPermissionsAPI(self._api_client)
|
|
222
|
+
self._experiments = service.ml.ExperimentsAPI(self._api_client)
|
|
223
|
+
self._external_locations = service.catalog.ExternalLocationsAPI(self._api_client)
|
|
224
|
+
self._files = _make_files_client(self._api_client, self._config)
|
|
225
|
+
self._functions = service.catalog.FunctionsAPI(self._api_client)
|
|
226
|
+
self._genie = service.dashboards.GenieAPI(self._api_client)
|
|
227
|
+
self._git_credentials = service.workspace.GitCredentialsAPI(self._api_client)
|
|
228
|
+
self._global_init_scripts = service.compute.GlobalInitScriptsAPI(self._api_client)
|
|
229
|
+
self._grants = service.catalog.GrantsAPI(self._api_client)
|
|
230
|
+
self._groups = service.iam.GroupsAPI(self._api_client)
|
|
231
|
+
self._instance_pools = service.compute.InstancePoolsAPI(self._api_client)
|
|
232
|
+
self._instance_profiles = service.compute.InstanceProfilesAPI(self._api_client)
|
|
233
|
+
self._ip_access_lists = service.settings.IpAccessListsAPI(self._api_client)
|
|
216
234
|
self._jobs = JobsExt(self._api_client)
|
|
217
|
-
self._lakeview = LakeviewAPI(self._api_client)
|
|
218
|
-
self._libraries = LibrariesAPI(self._api_client)
|
|
219
|
-
self._metastores = MetastoresAPI(self._api_client)
|
|
220
|
-
self._model_registry = ModelRegistryAPI(self._api_client)
|
|
221
|
-
self._model_versions = ModelVersionsAPI(self._api_client)
|
|
222
|
-
self._notification_destinations = NotificationDestinationsAPI(self._api_client)
|
|
223
|
-
self._online_tables = OnlineTablesAPI(self._api_client)
|
|
224
|
-
self._permission_migration = PermissionMigrationAPI(self._api_client)
|
|
225
|
-
self._permissions = PermissionsAPI(self._api_client)
|
|
226
|
-
self._pipelines = PipelinesAPI(self._api_client)
|
|
227
|
-
self._policy_compliance_for_clusters = PolicyComplianceForClustersAPI(
|
|
228
|
-
|
|
229
|
-
self.
|
|
230
|
-
self.
|
|
231
|
-
self.
|
|
232
|
-
self.
|
|
233
|
-
self.
|
|
234
|
-
self.
|
|
235
|
-
self.
|
|
235
|
+
self._lakeview = service.dashboards.LakeviewAPI(self._api_client)
|
|
236
|
+
self._libraries = service.compute.LibrariesAPI(self._api_client)
|
|
237
|
+
self._metastores = service.catalog.MetastoresAPI(self._api_client)
|
|
238
|
+
self._model_registry = service.ml.ModelRegistryAPI(self._api_client)
|
|
239
|
+
self._model_versions = service.catalog.ModelVersionsAPI(self._api_client)
|
|
240
|
+
self._notification_destinations = service.settings.NotificationDestinationsAPI(self._api_client)
|
|
241
|
+
self._online_tables = service.catalog.OnlineTablesAPI(self._api_client)
|
|
242
|
+
self._permission_migration = service.iam.PermissionMigrationAPI(self._api_client)
|
|
243
|
+
self._permissions = service.iam.PermissionsAPI(self._api_client)
|
|
244
|
+
self._pipelines = service.pipelines.PipelinesAPI(self._api_client)
|
|
245
|
+
self._policy_compliance_for_clusters = service.compute.PolicyComplianceForClustersAPI(
|
|
246
|
+
self._api_client)
|
|
247
|
+
self._policy_compliance_for_jobs = service.jobs.PolicyComplianceForJobsAPI(self._api_client)
|
|
248
|
+
self._policy_families = service.compute.PolicyFamiliesAPI(self._api_client)
|
|
249
|
+
self._provider_exchange_filters = service.marketplace.ProviderExchangeFiltersAPI(self._api_client)
|
|
250
|
+
self._provider_exchanges = service.marketplace.ProviderExchangesAPI(self._api_client)
|
|
251
|
+
self._provider_files = service.marketplace.ProviderFilesAPI(self._api_client)
|
|
252
|
+
self._provider_listings = service.marketplace.ProviderListingsAPI(self._api_client)
|
|
253
|
+
self._provider_personalization_requests = service.marketplace.ProviderPersonalizationRequestsAPI(
|
|
254
|
+
self._api_client)
|
|
255
|
+
self._provider_provider_analytics_dashboards = service.marketplace.ProviderProviderAnalyticsDashboardsAPI(
|
|
236
256
|
self._api_client)
|
|
237
|
-
self._provider_providers = ProviderProvidersAPI(self._api_client)
|
|
238
|
-
self._providers = ProvidersAPI(self._api_client)
|
|
239
|
-
self._quality_monitors = QualityMonitorsAPI(self._api_client)
|
|
240
|
-
self._queries = QueriesAPI(self._api_client)
|
|
241
|
-
self._queries_legacy = QueriesLegacyAPI(self._api_client)
|
|
242
|
-
self._query_history = QueryHistoryAPI(self._api_client)
|
|
243
|
-
self._query_visualizations = QueryVisualizationsAPI(self._api_client)
|
|
244
|
-
self._query_visualizations_legacy = QueryVisualizationsLegacyAPI(self._api_client)
|
|
245
|
-
self._recipient_activation = RecipientActivationAPI(self._api_client)
|
|
246
|
-
self._recipients = RecipientsAPI(self._api_client)
|
|
247
|
-
self._registered_models = RegisteredModelsAPI(self._api_client)
|
|
248
|
-
self._repos = ReposAPI(self._api_client)
|
|
249
|
-
self._resource_quotas = ResourceQuotasAPI(self._api_client)
|
|
250
|
-
self._schemas = SchemasAPI(self._api_client)
|
|
251
|
-
self._secrets = SecretsAPI(self._api_client)
|
|
252
|
-
self._service_principals = ServicePrincipalsAPI(self._api_client)
|
|
257
|
+
self._provider_providers = service.marketplace.ProviderProvidersAPI(self._api_client)
|
|
258
|
+
self._providers = service.sharing.ProvidersAPI(self._api_client)
|
|
259
|
+
self._quality_monitors = service.catalog.QualityMonitorsAPI(self._api_client)
|
|
260
|
+
self._queries = service.sql.QueriesAPI(self._api_client)
|
|
261
|
+
self._queries_legacy = service.sql.QueriesLegacyAPI(self._api_client)
|
|
262
|
+
self._query_history = service.sql.QueryHistoryAPI(self._api_client)
|
|
263
|
+
self._query_visualizations = service.sql.QueryVisualizationsAPI(self._api_client)
|
|
264
|
+
self._query_visualizations_legacy = service.sql.QueryVisualizationsLegacyAPI(self._api_client)
|
|
265
|
+
self._recipient_activation = service.sharing.RecipientActivationAPI(self._api_client)
|
|
266
|
+
self._recipients = service.sharing.RecipientsAPI(self._api_client)
|
|
267
|
+
self._registered_models = service.catalog.RegisteredModelsAPI(self._api_client)
|
|
268
|
+
self._repos = service.workspace.ReposAPI(self._api_client)
|
|
269
|
+
self._resource_quotas = service.catalog.ResourceQuotasAPI(self._api_client)
|
|
270
|
+
self._schemas = service.catalog.SchemasAPI(self._api_client)
|
|
271
|
+
self._secrets = service.workspace.SecretsAPI(self._api_client)
|
|
272
|
+
self._service_principals = service.iam.ServicePrincipalsAPI(self._api_client)
|
|
253
273
|
self._serving_endpoints = serving_endpoints
|
|
254
|
-
self._serving_endpoints_data_plane = ServingEndpointsDataPlaneAPI(
|
|
255
|
-
|
|
256
|
-
self.
|
|
257
|
-
self.
|
|
258
|
-
self.
|
|
259
|
-
self.
|
|
260
|
-
self.
|
|
261
|
-
self.
|
|
262
|
-
self.
|
|
263
|
-
self.
|
|
264
|
-
self.
|
|
265
|
-
self.
|
|
266
|
-
self.
|
|
267
|
-
self.
|
|
268
|
-
self.
|
|
269
|
-
self.
|
|
274
|
+
self._serving_endpoints_data_plane = service.serving.ServingEndpointsDataPlaneAPI(
|
|
275
|
+
self._api_client, serving_endpoints)
|
|
276
|
+
self._settings = service.settings.SettingsAPI(self._api_client)
|
|
277
|
+
self._shares = service.sharing.SharesAPI(self._api_client)
|
|
278
|
+
self._statement_execution = service.sql.StatementExecutionAPI(self._api_client)
|
|
279
|
+
self._storage_credentials = service.catalog.StorageCredentialsAPI(self._api_client)
|
|
280
|
+
self._system_schemas = service.catalog.SystemSchemasAPI(self._api_client)
|
|
281
|
+
self._table_constraints = service.catalog.TableConstraintsAPI(self._api_client)
|
|
282
|
+
self._tables = service.catalog.TablesAPI(self._api_client)
|
|
283
|
+
self._temporary_table_credentials = service.catalog.TemporaryTableCredentialsAPI(self._api_client)
|
|
284
|
+
self._token_management = service.settings.TokenManagementAPI(self._api_client)
|
|
285
|
+
self._tokens = service.settings.TokensAPI(self._api_client)
|
|
286
|
+
self._users = service.iam.UsersAPI(self._api_client)
|
|
287
|
+
self._vector_search_endpoints = service.vectorsearch.VectorSearchEndpointsAPI(self._api_client)
|
|
288
|
+
self._vector_search_indexes = service.vectorsearch.VectorSearchIndexesAPI(self._api_client)
|
|
289
|
+
self._volumes = service.catalog.VolumesAPI(self._api_client)
|
|
290
|
+
self._warehouses = service.sql.WarehousesAPI(self._api_client)
|
|
270
291
|
self._workspace = WorkspaceExt(self._api_client)
|
|
271
|
-
self._workspace_bindings = WorkspaceBindingsAPI(self._api_client)
|
|
272
|
-
self._workspace_conf = WorkspaceConfAPI(self._api_client)
|
|
292
|
+
self._workspace_bindings = service.catalog.WorkspaceBindingsAPI(self._api_client)
|
|
293
|
+
self._workspace_conf = service.settings.WorkspaceConfAPI(self._api_client)
|
|
273
294
|
|
|
274
295
|
@property
|
|
275
296
|
def config(self) -> client.Config:
|
|
@@ -284,52 +305,57 @@ class WorkspaceClient:
|
|
|
284
305
|
return self._dbutils
|
|
285
306
|
|
|
286
307
|
@property
|
|
287
|
-
def
|
|
308
|
+
def access_control(self) -> service.iam.AccessControlAPI:
|
|
309
|
+
"""Rule based Access Control for Databricks Resources."""
|
|
310
|
+
return self._access_control
|
|
311
|
+
|
|
312
|
+
@property
|
|
313
|
+
def account_access_control_proxy(self) -> service.iam.AccountAccessControlProxyAPI:
|
|
288
314
|
"""These APIs manage access rules on resources in an account."""
|
|
289
315
|
return self._account_access_control_proxy
|
|
290
316
|
|
|
291
317
|
@property
|
|
292
|
-
def alerts(self) -> AlertsAPI:
|
|
318
|
+
def alerts(self) -> service.sql.AlertsAPI:
|
|
293
319
|
"""The alerts API can be used to perform CRUD operations on alerts."""
|
|
294
320
|
return self._alerts
|
|
295
321
|
|
|
296
322
|
@property
|
|
297
|
-
def alerts_legacy(self) -> AlertsLegacyAPI:
|
|
323
|
+
def alerts_legacy(self) -> service.sql.AlertsLegacyAPI:
|
|
298
324
|
"""The alerts API can be used to perform CRUD operations on alerts."""
|
|
299
325
|
return self._alerts_legacy
|
|
300
326
|
|
|
301
327
|
@property
|
|
302
|
-
def apps(self) -> AppsAPI:
|
|
328
|
+
def apps(self) -> service.apps.AppsAPI:
|
|
303
329
|
"""Apps run directly on a customer’s Databricks instance, integrate with their data, use and extend Databricks services, and enable users to interact through single sign-on."""
|
|
304
330
|
return self._apps
|
|
305
331
|
|
|
306
332
|
@property
|
|
307
|
-
def artifact_allowlists(self) -> ArtifactAllowlistsAPI:
|
|
333
|
+
def artifact_allowlists(self) -> service.catalog.ArtifactAllowlistsAPI:
|
|
308
334
|
"""In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the `allowlist` in UC so that users can leverage these artifacts on compute configured with shared access mode."""
|
|
309
335
|
return self._artifact_allowlists
|
|
310
336
|
|
|
311
337
|
@property
|
|
312
|
-
def catalogs(self) -> CatalogsAPI:
|
|
338
|
+
def catalogs(self) -> service.catalog.CatalogsAPI:
|
|
313
339
|
"""A catalog is the first layer of Unity Catalog’s three-level namespace."""
|
|
314
340
|
return self._catalogs
|
|
315
341
|
|
|
316
342
|
@property
|
|
317
|
-
def clean_room_assets(self) -> CleanRoomAssetsAPI:
|
|
343
|
+
def clean_room_assets(self) -> service.cleanrooms.CleanRoomAssetsAPI:
|
|
318
344
|
"""Clean room assets are data and code objects — Tables, volumes, and notebooks that are shared with the clean room."""
|
|
319
345
|
return self._clean_room_assets
|
|
320
346
|
|
|
321
347
|
@property
|
|
322
|
-
def clean_room_task_runs(self) -> CleanRoomTaskRunsAPI:
|
|
348
|
+
def clean_room_task_runs(self) -> service.cleanrooms.CleanRoomTaskRunsAPI:
|
|
323
349
|
"""Clean room task runs are the executions of notebooks in a clean room."""
|
|
324
350
|
return self._clean_room_task_runs
|
|
325
351
|
|
|
326
352
|
@property
|
|
327
|
-
def clean_rooms(self) -> CleanRoomsAPI:
|
|
353
|
+
def clean_rooms(self) -> service.cleanrooms.CleanRoomsAPI:
|
|
328
354
|
"""A clean room uses Delta Sharing and serverless compute to provide a secure and privacy-protecting environment where multiple parties can work together on sensitive enterprise data without direct access to each other’s data."""
|
|
329
355
|
return self._clean_rooms
|
|
330
356
|
|
|
331
357
|
@property
|
|
332
|
-
def cluster_policies(self) -> ClusterPoliciesAPI:
|
|
358
|
+
def cluster_policies(self) -> service.compute.ClusterPoliciesAPI:
|
|
333
359
|
"""You can use cluster policies to control users' ability to configure clusters based on a set of rules."""
|
|
334
360
|
return self._cluster_policies
|
|
335
361
|
|
|
@@ -339,67 +365,67 @@ class WorkspaceClient:
|
|
|
339
365
|
return self._clusters
|
|
340
366
|
|
|
341
367
|
@property
|
|
342
|
-
def command_execution(self) -> CommandExecutionAPI:
|
|
368
|
+
def command_execution(self) -> service.compute.CommandExecutionAPI:
|
|
343
369
|
"""This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters."""
|
|
344
370
|
return self._command_execution
|
|
345
371
|
|
|
346
372
|
@property
|
|
347
|
-
def connections(self) -> ConnectionsAPI:
|
|
373
|
+
def connections(self) -> service.catalog.ConnectionsAPI:
|
|
348
374
|
"""Connections allow for creating a connection to an external data source."""
|
|
349
375
|
return self._connections
|
|
350
376
|
|
|
351
377
|
@property
|
|
352
|
-
def consumer_fulfillments(self) -> ConsumerFulfillmentsAPI:
|
|
378
|
+
def consumer_fulfillments(self) -> service.marketplace.ConsumerFulfillmentsAPI:
|
|
353
379
|
"""Fulfillments are entities that allow consumers to preview installations."""
|
|
354
380
|
return self._consumer_fulfillments
|
|
355
381
|
|
|
356
382
|
@property
|
|
357
|
-
def consumer_installations(self) -> ConsumerInstallationsAPI:
|
|
383
|
+
def consumer_installations(self) -> service.marketplace.ConsumerInstallationsAPI:
|
|
358
384
|
"""Installations are entities that allow consumers to interact with Databricks Marketplace listings."""
|
|
359
385
|
return self._consumer_installations
|
|
360
386
|
|
|
361
387
|
@property
|
|
362
|
-
def consumer_listings(self) -> ConsumerListingsAPI:
|
|
388
|
+
def consumer_listings(self) -> service.marketplace.ConsumerListingsAPI:
|
|
363
389
|
"""Listings are the core entities in the Marketplace."""
|
|
364
390
|
return self._consumer_listings
|
|
365
391
|
|
|
366
392
|
@property
|
|
367
|
-
def consumer_personalization_requests(self) -> ConsumerPersonalizationRequestsAPI:
|
|
393
|
+
def consumer_personalization_requests(self) -> service.marketplace.ConsumerPersonalizationRequestsAPI:
|
|
368
394
|
"""Personalization Requests allow customers to interact with the individualized Marketplace listing flow."""
|
|
369
395
|
return self._consumer_personalization_requests
|
|
370
396
|
|
|
371
397
|
@property
|
|
372
|
-
def consumer_providers(self) -> ConsumerProvidersAPI:
|
|
398
|
+
def consumer_providers(self) -> service.marketplace.ConsumerProvidersAPI:
|
|
373
399
|
"""Providers are the entities that publish listings to the Marketplace."""
|
|
374
400
|
return self._consumer_providers
|
|
375
401
|
|
|
376
402
|
@property
|
|
377
|
-
def credentials(self) -> CredentialsAPI:
|
|
403
|
+
def credentials(self) -> service.catalog.CredentialsAPI:
|
|
378
404
|
"""A credential represents an authentication and authorization mechanism for accessing services on your cloud tenant."""
|
|
379
405
|
return self._credentials
|
|
380
406
|
|
|
381
407
|
@property
|
|
382
|
-
def credentials_manager(self) -> CredentialsManagerAPI:
|
|
408
|
+
def credentials_manager(self) -> service.settings.CredentialsManagerAPI:
|
|
383
409
|
"""Credentials manager interacts with with Identity Providers to to perform token exchanges using stored credentials and refresh tokens."""
|
|
384
410
|
return self._credentials_manager
|
|
385
411
|
|
|
386
412
|
@property
|
|
387
|
-
def current_user(self) -> CurrentUserAPI:
|
|
413
|
+
def current_user(self) -> service.iam.CurrentUserAPI:
|
|
388
414
|
"""This API allows retrieving information about currently authenticated user or service principal."""
|
|
389
415
|
return self._current_user
|
|
390
416
|
|
|
391
417
|
@property
|
|
392
|
-
def dashboard_widgets(self) -> DashboardWidgetsAPI:
|
|
418
|
+
def dashboard_widgets(self) -> service.sql.DashboardWidgetsAPI:
|
|
393
419
|
"""This is an evolving API that facilitates the addition and removal of widgets from existing dashboards within the Databricks Workspace."""
|
|
394
420
|
return self._dashboard_widgets
|
|
395
421
|
|
|
396
422
|
@property
|
|
397
|
-
def dashboards(self) -> DashboardsAPI:
|
|
423
|
+
def dashboards(self) -> service.sql.DashboardsAPI:
|
|
398
424
|
"""In general, there is little need to modify dashboards using the API."""
|
|
399
425
|
return self._dashboards
|
|
400
426
|
|
|
401
427
|
@property
|
|
402
|
-
def data_sources(self) -> DataSourcesAPI:
|
|
428
|
+
def data_sources(self) -> service.sql.DataSourcesAPI:
|
|
403
429
|
"""This API is provided to assist you in making new query objects."""
|
|
404
430
|
return self._data_sources
|
|
405
431
|
|
|
@@ -409,67 +435,67 @@ class WorkspaceClient:
|
|
|
409
435
|
return self._dbfs
|
|
410
436
|
|
|
411
437
|
@property
|
|
412
|
-
def dbsql_permissions(self) -> DbsqlPermissionsAPI:
|
|
438
|
+
def dbsql_permissions(self) -> service.sql.DbsqlPermissionsAPI:
|
|
413
439
|
"""The SQL Permissions API is similar to the endpoints of the :method:permissions/set."""
|
|
414
440
|
return self._dbsql_permissions
|
|
415
441
|
|
|
416
442
|
@property
|
|
417
|
-
def experiments(self) -> ExperimentsAPI:
|
|
443
|
+
def experiments(self) -> service.ml.ExperimentsAPI:
|
|
418
444
|
"""Experiments are the primary unit of organization in MLflow; all MLflow runs belong to an experiment."""
|
|
419
445
|
return self._experiments
|
|
420
446
|
|
|
421
447
|
@property
|
|
422
|
-
def external_locations(self) -> ExternalLocationsAPI:
|
|
448
|
+
def external_locations(self) -> service.catalog.ExternalLocationsAPI:
|
|
423
449
|
"""An external location is an object that combines a cloud storage path with a storage credential that authorizes access to the cloud storage path."""
|
|
424
450
|
return self._external_locations
|
|
425
451
|
|
|
426
452
|
@property
|
|
427
|
-
def files(self) -> FilesAPI:
|
|
453
|
+
def files(self) -> service.files.FilesAPI:
|
|
428
454
|
"""The Files API is a standard HTTP API that allows you to read, write, list, and delete files and directories by referring to their URI."""
|
|
429
455
|
return self._files
|
|
430
456
|
|
|
431
457
|
@property
|
|
432
|
-
def functions(self) -> FunctionsAPI:
|
|
458
|
+
def functions(self) -> service.catalog.FunctionsAPI:
|
|
433
459
|
"""Functions implement User-Defined Functions (UDFs) in Unity Catalog."""
|
|
434
460
|
return self._functions
|
|
435
461
|
|
|
436
462
|
@property
|
|
437
|
-
def genie(self) -> GenieAPI:
|
|
463
|
+
def genie(self) -> service.dashboards.GenieAPI:
|
|
438
464
|
"""Genie provides a no-code experience for business users, powered by AI/BI."""
|
|
439
465
|
return self._genie
|
|
440
466
|
|
|
441
467
|
@property
|
|
442
|
-
def git_credentials(self) -> GitCredentialsAPI:
|
|
468
|
+
def git_credentials(self) -> service.workspace.GitCredentialsAPI:
|
|
443
469
|
"""Registers personal access token for Databricks to do operations on behalf of the user."""
|
|
444
470
|
return self._git_credentials
|
|
445
471
|
|
|
446
472
|
@property
|
|
447
|
-
def global_init_scripts(self) -> GlobalInitScriptsAPI:
|
|
473
|
+
def global_init_scripts(self) -> service.compute.GlobalInitScriptsAPI:
|
|
448
474
|
"""The Global Init Scripts API enables Workspace administrators to configure global initialization scripts for their workspace."""
|
|
449
475
|
return self._global_init_scripts
|
|
450
476
|
|
|
451
477
|
@property
|
|
452
|
-
def grants(self) -> GrantsAPI:
|
|
478
|
+
def grants(self) -> service.catalog.GrantsAPI:
|
|
453
479
|
"""In Unity Catalog, data is secure by default."""
|
|
454
480
|
return self._grants
|
|
455
481
|
|
|
456
482
|
@property
|
|
457
|
-
def groups(self) -> GroupsAPI:
|
|
483
|
+
def groups(self) -> service.iam.GroupsAPI:
|
|
458
484
|
"""Groups simplify identity management, making it easier to assign access to Databricks workspace, data, and other securable objects."""
|
|
459
485
|
return self._groups
|
|
460
486
|
|
|
461
487
|
@property
|
|
462
|
-
def instance_pools(self) -> InstancePoolsAPI:
|
|
488
|
+
def instance_pools(self) -> service.compute.InstancePoolsAPI:
|
|
463
489
|
"""Instance Pools API are used to create, edit, delete and list instance pools by using ready-to-use cloud instances which reduces a cluster start and auto-scaling times."""
|
|
464
490
|
return self._instance_pools
|
|
465
491
|
|
|
466
492
|
@property
|
|
467
|
-
def instance_profiles(self) -> InstanceProfilesAPI:
|
|
493
|
+
def instance_profiles(self) -> service.compute.InstanceProfilesAPI:
|
|
468
494
|
"""The Instance Profiles API allows admins to add, list, and remove instance profiles that users can launch clusters with."""
|
|
469
495
|
return self._instance_profiles
|
|
470
496
|
|
|
471
497
|
@property
|
|
472
|
-
def ip_access_lists(self) -> IpAccessListsAPI:
|
|
498
|
+
def ip_access_lists(self) -> service.settings.IpAccessListsAPI:
|
|
473
499
|
"""IP Access List enables admins to configure IP access lists."""
|
|
474
500
|
return self._ip_access_lists
|
|
475
501
|
|
|
@@ -479,177 +505,178 @@ class WorkspaceClient:
|
|
|
479
505
|
return self._jobs
|
|
480
506
|
|
|
481
507
|
@property
|
|
482
|
-
def lakeview(self) -> LakeviewAPI:
|
|
508
|
+
def lakeview(self) -> service.dashboards.LakeviewAPI:
|
|
483
509
|
"""These APIs provide specific management operations for Lakeview dashboards."""
|
|
484
510
|
return self._lakeview
|
|
485
511
|
|
|
486
512
|
@property
|
|
487
|
-
def libraries(self) -> LibrariesAPI:
|
|
513
|
+
def libraries(self) -> service.compute.LibrariesAPI:
|
|
488
514
|
"""The Libraries API allows you to install and uninstall libraries and get the status of libraries on a cluster."""
|
|
489
515
|
return self._libraries
|
|
490
516
|
|
|
491
517
|
@property
|
|
492
|
-
def metastores(self) -> MetastoresAPI:
|
|
518
|
+
def metastores(self) -> service.catalog.MetastoresAPI:
|
|
493
519
|
"""A metastore is the top-level container of objects in Unity Catalog."""
|
|
494
520
|
return self._metastores
|
|
495
521
|
|
|
496
522
|
@property
|
|
497
|
-
def model_registry(self) -> ModelRegistryAPI:
|
|
523
|
+
def model_registry(self) -> service.ml.ModelRegistryAPI:
|
|
498
524
|
"""Note: This API reference documents APIs for the Workspace Model Registry."""
|
|
499
525
|
return self._model_registry
|
|
500
526
|
|
|
501
527
|
@property
|
|
502
|
-
def model_versions(self) -> ModelVersionsAPI:
|
|
528
|
+
def model_versions(self) -> service.catalog.ModelVersionsAPI:
|
|
503
529
|
"""Databricks provides a hosted version of MLflow Model Registry in Unity Catalog."""
|
|
504
530
|
return self._model_versions
|
|
505
531
|
|
|
506
532
|
@property
|
|
507
|
-
def notification_destinations(self) -> NotificationDestinationsAPI:
|
|
533
|
+
def notification_destinations(self) -> service.settings.NotificationDestinationsAPI:
|
|
508
534
|
"""The notification destinations API lets you programmatically manage a workspace's notification destinations."""
|
|
509
535
|
return self._notification_destinations
|
|
510
536
|
|
|
511
537
|
@property
|
|
512
|
-
def online_tables(self) -> OnlineTablesAPI:
|
|
538
|
+
def online_tables(self) -> service.catalog.OnlineTablesAPI:
|
|
513
539
|
"""Online tables provide lower latency and higher QPS access to data from Delta tables."""
|
|
514
540
|
return self._online_tables
|
|
515
541
|
|
|
516
542
|
@property
|
|
517
|
-
def permission_migration(self) -> PermissionMigrationAPI:
|
|
543
|
+
def permission_migration(self) -> service.iam.PermissionMigrationAPI:
|
|
518
544
|
"""APIs for migrating acl permissions, used only by the ucx tool: https://github.com/databrickslabs/ucx."""
|
|
519
545
|
return self._permission_migration
|
|
520
546
|
|
|
521
547
|
@property
|
|
522
|
-
def permissions(self) -> PermissionsAPI:
|
|
548
|
+
def permissions(self) -> service.iam.PermissionsAPI:
|
|
523
549
|
"""Permissions API are used to create read, write, edit, update and manage access for various users on different objects and endpoints."""
|
|
524
550
|
return self._permissions
|
|
525
551
|
|
|
526
552
|
@property
|
|
527
|
-
def pipelines(self) -> PipelinesAPI:
|
|
553
|
+
def pipelines(self) -> service.pipelines.PipelinesAPI:
|
|
528
554
|
"""The Delta Live Tables API allows you to create, edit, delete, start, and view details about pipelines."""
|
|
529
555
|
return self._pipelines
|
|
530
556
|
|
|
531
557
|
@property
|
|
532
|
-
def policy_compliance_for_clusters(self) -> PolicyComplianceForClustersAPI:
|
|
558
|
+
def policy_compliance_for_clusters(self) -> service.compute.PolicyComplianceForClustersAPI:
|
|
533
559
|
"""The policy compliance APIs allow you to view and manage the policy compliance status of clusters in your workspace."""
|
|
534
560
|
return self._policy_compliance_for_clusters
|
|
535
561
|
|
|
536
562
|
@property
|
|
537
|
-
def policy_compliance_for_jobs(self) -> PolicyComplianceForJobsAPI:
|
|
563
|
+
def policy_compliance_for_jobs(self) -> service.jobs.PolicyComplianceForJobsAPI:
|
|
538
564
|
"""The compliance APIs allow you to view and manage the policy compliance status of jobs in your workspace."""
|
|
539
565
|
return self._policy_compliance_for_jobs
|
|
540
566
|
|
|
541
567
|
@property
|
|
542
|
-
def policy_families(self) -> PolicyFamiliesAPI:
|
|
568
|
+
def policy_families(self) -> service.compute.PolicyFamiliesAPI:
|
|
543
569
|
"""View available policy families."""
|
|
544
570
|
return self._policy_families
|
|
545
571
|
|
|
546
572
|
@property
|
|
547
|
-
def provider_exchange_filters(self) -> ProviderExchangeFiltersAPI:
|
|
573
|
+
def provider_exchange_filters(self) -> service.marketplace.ProviderExchangeFiltersAPI:
|
|
548
574
|
"""Marketplace exchanges filters curate which groups can access an exchange."""
|
|
549
575
|
return self._provider_exchange_filters
|
|
550
576
|
|
|
551
577
|
@property
|
|
552
|
-
def provider_exchanges(self) -> ProviderExchangesAPI:
|
|
578
|
+
def provider_exchanges(self) -> service.marketplace.ProviderExchangesAPI:
|
|
553
579
|
"""Marketplace exchanges allow providers to share their listings with a curated set of customers."""
|
|
554
580
|
return self._provider_exchanges
|
|
555
581
|
|
|
556
582
|
@property
|
|
557
|
-
def provider_files(self) -> ProviderFilesAPI:
|
|
583
|
+
def provider_files(self) -> service.marketplace.ProviderFilesAPI:
|
|
558
584
|
"""Marketplace offers a set of file APIs for various purposes such as preview notebooks and provider icons."""
|
|
559
585
|
return self._provider_files
|
|
560
586
|
|
|
561
587
|
@property
|
|
562
|
-
def provider_listings(self) -> ProviderListingsAPI:
|
|
588
|
+
def provider_listings(self) -> service.marketplace.ProviderListingsAPI:
|
|
563
589
|
"""Listings are the core entities in the Marketplace."""
|
|
564
590
|
return self._provider_listings
|
|
565
591
|
|
|
566
592
|
@property
|
|
567
|
-
def provider_personalization_requests(self) -> ProviderPersonalizationRequestsAPI:
|
|
593
|
+
def provider_personalization_requests(self) -> service.marketplace.ProviderPersonalizationRequestsAPI:
|
|
568
594
|
"""Personalization requests are an alternate to instantly available listings."""
|
|
569
595
|
return self._provider_personalization_requests
|
|
570
596
|
|
|
571
597
|
@property
|
|
572
|
-
def provider_provider_analytics_dashboards(
|
|
598
|
+
def provider_provider_analytics_dashboards(
|
|
599
|
+
self) -> service.marketplace.ProviderProviderAnalyticsDashboardsAPI:
|
|
573
600
|
"""Manage templated analytics solution for providers."""
|
|
574
601
|
return self._provider_provider_analytics_dashboards
|
|
575
602
|
|
|
576
603
|
@property
|
|
577
|
-
def provider_providers(self) -> ProviderProvidersAPI:
|
|
604
|
+
def provider_providers(self) -> service.marketplace.ProviderProvidersAPI:
|
|
578
605
|
"""Providers are entities that manage assets in Marketplace."""
|
|
579
606
|
return self._provider_providers
|
|
580
607
|
|
|
581
608
|
@property
|
|
582
|
-
def providers(self) -> ProvidersAPI:
|
|
609
|
+
def providers(self) -> service.sharing.ProvidersAPI:
|
|
583
610
|
"""A data provider is an object representing the organization in the real world who shares the data."""
|
|
584
611
|
return self._providers
|
|
585
612
|
|
|
586
613
|
@property
|
|
587
|
-
def quality_monitors(self) -> QualityMonitorsAPI:
|
|
614
|
+
def quality_monitors(self) -> service.catalog.QualityMonitorsAPI:
|
|
588
615
|
"""A monitor computes and monitors data or model quality metrics for a table over time."""
|
|
589
616
|
return self._quality_monitors
|
|
590
617
|
|
|
591
618
|
@property
|
|
592
|
-
def queries(self) -> QueriesAPI:
|
|
619
|
+
def queries(self) -> service.sql.QueriesAPI:
|
|
593
620
|
"""The queries API can be used to perform CRUD operations on queries."""
|
|
594
621
|
return self._queries
|
|
595
622
|
|
|
596
623
|
@property
|
|
597
|
-
def queries_legacy(self) -> QueriesLegacyAPI:
|
|
624
|
+
def queries_legacy(self) -> service.sql.QueriesLegacyAPI:
|
|
598
625
|
"""These endpoints are used for CRUD operations on query definitions."""
|
|
599
626
|
return self._queries_legacy
|
|
600
627
|
|
|
601
628
|
@property
|
|
602
|
-
def query_history(self) -> QueryHistoryAPI:
|
|
629
|
+
def query_history(self) -> service.sql.QueryHistoryAPI:
|
|
603
630
|
"""A service responsible for storing and retrieving the list of queries run against SQL endpoints and serverless compute."""
|
|
604
631
|
return self._query_history
|
|
605
632
|
|
|
606
633
|
@property
|
|
607
|
-
def query_visualizations(self) -> QueryVisualizationsAPI:
|
|
634
|
+
def query_visualizations(self) -> service.sql.QueryVisualizationsAPI:
|
|
608
635
|
"""This is an evolving API that facilitates the addition and removal of visualizations from existing queries in the Databricks Workspace."""
|
|
609
636
|
return self._query_visualizations
|
|
610
637
|
|
|
611
638
|
@property
|
|
612
|
-
def query_visualizations_legacy(self) -> QueryVisualizationsLegacyAPI:
|
|
639
|
+
def query_visualizations_legacy(self) -> service.sql.QueryVisualizationsLegacyAPI:
|
|
613
640
|
"""This is an evolving API that facilitates the addition and removal of vizualisations from existing queries within the Databricks Workspace."""
|
|
614
641
|
return self._query_visualizations_legacy
|
|
615
642
|
|
|
616
643
|
@property
|
|
617
|
-
def recipient_activation(self) -> RecipientActivationAPI:
|
|
644
|
+
def recipient_activation(self) -> service.sharing.RecipientActivationAPI:
|
|
618
645
|
"""The Recipient Activation API is only applicable in the open sharing model where the recipient object has the authentication type of `TOKEN`."""
|
|
619
646
|
return self._recipient_activation
|
|
620
647
|
|
|
621
648
|
@property
|
|
622
|
-
def recipients(self) -> RecipientsAPI:
|
|
649
|
+
def recipients(self) -> service.sharing.RecipientsAPI:
|
|
623
650
|
"""A recipient is an object you create using :method:recipients/create to represent an organization which you want to allow access shares."""
|
|
624
651
|
return self._recipients
|
|
625
652
|
|
|
626
653
|
@property
|
|
627
|
-
def registered_models(self) -> RegisteredModelsAPI:
|
|
654
|
+
def registered_models(self) -> service.catalog.RegisteredModelsAPI:
|
|
628
655
|
"""Databricks provides a hosted version of MLflow Model Registry in Unity Catalog."""
|
|
629
656
|
return self._registered_models
|
|
630
657
|
|
|
631
658
|
@property
|
|
632
|
-
def repos(self) -> ReposAPI:
|
|
659
|
+
def repos(self) -> service.workspace.ReposAPI:
|
|
633
660
|
"""The Repos API allows users to manage their git repos."""
|
|
634
661
|
return self._repos
|
|
635
662
|
|
|
636
663
|
@property
|
|
637
|
-
def resource_quotas(self) -> ResourceQuotasAPI:
|
|
664
|
+
def resource_quotas(self) -> service.catalog.ResourceQuotasAPI:
|
|
638
665
|
"""Unity Catalog enforces resource quotas on all securable objects, which limits the number of resources that can be created."""
|
|
639
666
|
return self._resource_quotas
|
|
640
667
|
|
|
641
668
|
@property
|
|
642
|
-
def schemas(self) -> SchemasAPI:
|
|
669
|
+
def schemas(self) -> service.catalog.SchemasAPI:
|
|
643
670
|
"""A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace."""
|
|
644
671
|
return self._schemas
|
|
645
672
|
|
|
646
673
|
@property
|
|
647
|
-
def secrets(self) -> SecretsAPI:
|
|
674
|
+
def secrets(self) -> service.workspace.SecretsAPI:
|
|
648
675
|
"""The Secrets API allows you to manage secrets, secret scopes, and access permissions."""
|
|
649
676
|
return self._secrets
|
|
650
677
|
|
|
651
678
|
@property
|
|
652
|
-
def service_principals(self) -> ServicePrincipalsAPI:
|
|
679
|
+
def service_principals(self) -> service.iam.ServicePrincipalsAPI:
|
|
653
680
|
"""Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD platforms."""
|
|
654
681
|
return self._service_principals
|
|
655
682
|
|
|
@@ -659,82 +686,82 @@ class WorkspaceClient:
|
|
|
659
686
|
return self._serving_endpoints
|
|
660
687
|
|
|
661
688
|
@property
|
|
662
|
-
def serving_endpoints_data_plane(self) -> ServingEndpointsDataPlaneAPI:
|
|
689
|
+
def serving_endpoints_data_plane(self) -> service.serving.ServingEndpointsDataPlaneAPI:
|
|
663
690
|
"""Serving endpoints DataPlane provides a set of operations to interact with data plane endpoints for Serving endpoints service."""
|
|
664
691
|
return self._serving_endpoints_data_plane
|
|
665
692
|
|
|
666
693
|
@property
|
|
667
|
-
def settings(self) -> SettingsAPI:
|
|
694
|
+
def settings(self) -> service.settings.SettingsAPI:
|
|
668
695
|
"""Workspace Settings API allows users to manage settings at the workspace level."""
|
|
669
696
|
return self._settings
|
|
670
697
|
|
|
671
698
|
@property
|
|
672
|
-
def shares(self) -> SharesAPI:
|
|
699
|
+
def shares(self) -> service.sharing.SharesAPI:
|
|
673
700
|
"""A share is a container instantiated with :method:shares/create."""
|
|
674
701
|
return self._shares
|
|
675
702
|
|
|
676
703
|
@property
|
|
677
|
-
def statement_execution(self) -> StatementExecutionAPI:
|
|
704
|
+
def statement_execution(self) -> service.sql.StatementExecutionAPI:
|
|
678
705
|
"""The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL warehouse and fetch the result."""
|
|
679
706
|
return self._statement_execution
|
|
680
707
|
|
|
681
708
|
@property
|
|
682
|
-
def storage_credentials(self) -> StorageCredentialsAPI:
|
|
709
|
+
def storage_credentials(self) -> service.catalog.StorageCredentialsAPI:
|
|
683
710
|
"""A storage credential represents an authentication and authorization mechanism for accessing data stored on your cloud tenant."""
|
|
684
711
|
return self._storage_credentials
|
|
685
712
|
|
|
686
713
|
@property
|
|
687
|
-
def system_schemas(self) -> SystemSchemasAPI:
|
|
714
|
+
def system_schemas(self) -> service.catalog.SystemSchemasAPI:
|
|
688
715
|
"""A system schema is a schema that lives within the system catalog."""
|
|
689
716
|
return self._system_schemas
|
|
690
717
|
|
|
691
718
|
@property
|
|
692
|
-
def table_constraints(self) -> TableConstraintsAPI:
|
|
719
|
+
def table_constraints(self) -> service.catalog.TableConstraintsAPI:
|
|
693
720
|
"""Primary key and foreign key constraints encode relationships between fields in tables."""
|
|
694
721
|
return self._table_constraints
|
|
695
722
|
|
|
696
723
|
@property
|
|
697
|
-
def tables(self) -> TablesAPI:
|
|
724
|
+
def tables(self) -> service.catalog.TablesAPI:
|
|
698
725
|
"""A table resides in the third layer of Unity Catalog’s three-level namespace."""
|
|
699
726
|
return self._tables
|
|
700
727
|
|
|
701
728
|
@property
|
|
702
|
-
def temporary_table_credentials(self) -> TemporaryTableCredentialsAPI:
|
|
729
|
+
def temporary_table_credentials(self) -> service.catalog.TemporaryTableCredentialsAPI:
|
|
703
730
|
"""Temporary Table Credentials refer to short-lived, downscoped credentials used to access cloud storage locationswhere table data is stored in Databricks."""
|
|
704
731
|
return self._temporary_table_credentials
|
|
705
732
|
|
|
706
733
|
@property
|
|
707
|
-
def token_management(self) -> TokenManagementAPI:
|
|
734
|
+
def token_management(self) -> service.settings.TokenManagementAPI:
|
|
708
735
|
"""Enables administrators to get all tokens and delete tokens for other users."""
|
|
709
736
|
return self._token_management
|
|
710
737
|
|
|
711
738
|
@property
|
|
712
|
-
def tokens(self) -> TokensAPI:
|
|
739
|
+
def tokens(self) -> service.settings.TokensAPI:
|
|
713
740
|
"""The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs."""
|
|
714
741
|
return self._tokens
|
|
715
742
|
|
|
716
743
|
@property
|
|
717
|
-
def users(self) -> UsersAPI:
|
|
744
|
+
def users(self) -> service.iam.UsersAPI:
|
|
718
745
|
"""User identities recognized by Databricks and represented by email addresses."""
|
|
719
746
|
return self._users
|
|
720
747
|
|
|
721
748
|
@property
|
|
722
|
-
def vector_search_endpoints(self) -> VectorSearchEndpointsAPI:
|
|
749
|
+
def vector_search_endpoints(self) -> service.vectorsearch.VectorSearchEndpointsAPI:
|
|
723
750
|
"""**Endpoint**: Represents the compute resources to host vector search indexes."""
|
|
724
751
|
return self._vector_search_endpoints
|
|
725
752
|
|
|
726
753
|
@property
|
|
727
|
-
def vector_search_indexes(self) -> VectorSearchIndexesAPI:
|
|
754
|
+
def vector_search_indexes(self) -> service.vectorsearch.VectorSearchIndexesAPI:
|
|
728
755
|
"""**Index**: An efficient representation of your embedding vectors that supports real-time and efficient approximate nearest neighbor (ANN) search queries."""
|
|
729
756
|
return self._vector_search_indexes
|
|
730
757
|
|
|
731
758
|
@property
|
|
732
|
-
def volumes(self) -> VolumesAPI:
|
|
759
|
+
def volumes(self) -> service.catalog.VolumesAPI:
|
|
733
760
|
"""Volumes are a Unity Catalog (UC) capability for accessing, storing, governing, organizing and processing files."""
|
|
734
761
|
return self._volumes
|
|
735
762
|
|
|
736
763
|
@property
|
|
737
|
-
def warehouses(self) -> WarehousesAPI:
|
|
764
|
+
def warehouses(self) -> service.sql.WarehousesAPI:
|
|
738
765
|
"""A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL."""
|
|
739
766
|
return self._warehouses
|
|
740
767
|
|
|
@@ -744,12 +771,12 @@ class WorkspaceClient:
|
|
|
744
771
|
return self._workspace
|
|
745
772
|
|
|
746
773
|
@property
|
|
747
|
-
def workspace_bindings(self) -> WorkspaceBindingsAPI:
|
|
774
|
+
def workspace_bindings(self) -> service.catalog.WorkspaceBindingsAPI:
|
|
748
775
|
"""A securable in Databricks can be configured as __OPEN__ or __ISOLATED__."""
|
|
749
776
|
return self._workspace_bindings
|
|
750
777
|
|
|
751
778
|
@property
|
|
752
|
-
def workspace_conf(self) -> WorkspaceConfAPI:
|
|
779
|
+
def workspace_conf(self) -> service.settings.WorkspaceConfAPI:
|
|
753
780
|
"""This API allows updating known workspace settings for advanced users."""
|
|
754
781
|
return self._workspace_conf
|
|
755
782
|
|
|
@@ -823,34 +850,36 @@ class AccountClient:
|
|
|
823
850
|
product_version=product_version)
|
|
824
851
|
self._config = config.copy()
|
|
825
852
|
self._api_client = client.ApiClient(self._config)
|
|
826
|
-
self._access_control = AccountAccessControlAPI(self._api_client)
|
|
827
|
-
self._billable_usage = BillableUsageAPI(self._api_client)
|
|
828
|
-
self.
|
|
829
|
-
self.
|
|
830
|
-
self.
|
|
831
|
-
self.
|
|
832
|
-
self.
|
|
833
|
-
self.
|
|
834
|
-
self.
|
|
835
|
-
self.
|
|
836
|
-
self.
|
|
837
|
-
self.
|
|
838
|
-
self.
|
|
839
|
-
self.
|
|
840
|
-
self.
|
|
841
|
-
self.
|
|
842
|
-
self.
|
|
843
|
-
self.
|
|
844
|
-
|
|
845
|
-
self.
|
|
846
|
-
self.
|
|
847
|
-
self.
|
|
848
|
-
self.
|
|
849
|
-
self.
|
|
850
|
-
self.
|
|
851
|
-
self.
|
|
852
|
-
self.
|
|
853
|
-
self.
|
|
853
|
+
self._access_control = service.iam.AccountAccessControlAPI(self._api_client)
|
|
854
|
+
self._billable_usage = service.billing.BillableUsageAPI(self._api_client)
|
|
855
|
+
self._budget_policy = service.billing.BudgetPolicyAPI(self._api_client)
|
|
856
|
+
self._credentials = service.provisioning.CredentialsAPI(self._api_client)
|
|
857
|
+
self._custom_app_integration = service.oauth2.CustomAppIntegrationAPI(self._api_client)
|
|
858
|
+
self._encryption_keys = service.provisioning.EncryptionKeysAPI(self._api_client)
|
|
859
|
+
self._federation_policy = service.oauth2.AccountFederationPolicyAPI(self._api_client)
|
|
860
|
+
self._groups = service.iam.AccountGroupsAPI(self._api_client)
|
|
861
|
+
self._ip_access_lists = service.settings.AccountIpAccessListsAPI(self._api_client)
|
|
862
|
+
self._log_delivery = service.billing.LogDeliveryAPI(self._api_client)
|
|
863
|
+
self._metastore_assignments = service.catalog.AccountMetastoreAssignmentsAPI(self._api_client)
|
|
864
|
+
self._metastores = service.catalog.AccountMetastoresAPI(self._api_client)
|
|
865
|
+
self._network_connectivity = service.settings.NetworkConnectivityAPI(self._api_client)
|
|
866
|
+
self._networks = service.provisioning.NetworksAPI(self._api_client)
|
|
867
|
+
self._o_auth_published_apps = service.oauth2.OAuthPublishedAppsAPI(self._api_client)
|
|
868
|
+
self._private_access = service.provisioning.PrivateAccessAPI(self._api_client)
|
|
869
|
+
self._published_app_integration = service.oauth2.PublishedAppIntegrationAPI(self._api_client)
|
|
870
|
+
self._service_principal_federation_policy = service.oauth2.ServicePrincipalFederationPolicyAPI(
|
|
871
|
+
self._api_client)
|
|
872
|
+
self._service_principal_secrets = service.oauth2.ServicePrincipalSecretsAPI(self._api_client)
|
|
873
|
+
self._service_principals = service.iam.AccountServicePrincipalsAPI(self._api_client)
|
|
874
|
+
self._settings = service.settings.AccountSettingsAPI(self._api_client)
|
|
875
|
+
self._storage = service.provisioning.StorageAPI(self._api_client)
|
|
876
|
+
self._storage_credentials = service.catalog.AccountStorageCredentialsAPI(self._api_client)
|
|
877
|
+
self._usage_dashboards = service.billing.UsageDashboardsAPI(self._api_client)
|
|
878
|
+
self._users = service.iam.AccountUsersAPI(self._api_client)
|
|
879
|
+
self._vpc_endpoints = service.provisioning.VpcEndpointsAPI(self._api_client)
|
|
880
|
+
self._workspace_assignment = service.iam.WorkspaceAssignmentAPI(self._api_client)
|
|
881
|
+
self._workspaces = service.provisioning.WorkspacesAPI(self._api_client)
|
|
882
|
+
self._budgets = service.billing.BudgetsAPI(self._api_client)
|
|
854
883
|
|
|
855
884
|
@property
|
|
856
885
|
def config(self) -> client.Config:
|
|
@@ -861,142 +890,147 @@ class AccountClient:
|
|
|
861
890
|
return self._api_client
|
|
862
891
|
|
|
863
892
|
@property
|
|
864
|
-
def access_control(self) -> AccountAccessControlAPI:
|
|
893
|
+
def access_control(self) -> service.iam.AccountAccessControlAPI:
|
|
865
894
|
"""These APIs manage access rules on resources in an account."""
|
|
866
895
|
return self._access_control
|
|
867
896
|
|
|
868
897
|
@property
|
|
869
|
-
def billable_usage(self) -> BillableUsageAPI:
|
|
898
|
+
def billable_usage(self) -> service.billing.BillableUsageAPI:
|
|
870
899
|
"""This API allows you to download billable usage logs for the specified account and date range."""
|
|
871
900
|
return self._billable_usage
|
|
872
901
|
|
|
873
902
|
@property
|
|
874
|
-
def
|
|
903
|
+
def budget_policy(self) -> service.billing.BudgetPolicyAPI:
|
|
904
|
+
"""A service serves REST API about Budget policies."""
|
|
905
|
+
return self._budget_policy
|
|
906
|
+
|
|
907
|
+
@property
|
|
908
|
+
def credentials(self) -> service.provisioning.CredentialsAPI:
|
|
875
909
|
"""These APIs manage credential configurations for this workspace."""
|
|
876
910
|
return self._credentials
|
|
877
911
|
|
|
878
912
|
@property
|
|
879
|
-
def custom_app_integration(self) -> CustomAppIntegrationAPI:
|
|
913
|
+
def custom_app_integration(self) -> service.oauth2.CustomAppIntegrationAPI:
|
|
880
914
|
"""These APIs enable administrators to manage custom OAuth app integrations, which is required for adding/using Custom OAuth App Integration like Tableau Cloud for Databricks in AWS cloud."""
|
|
881
915
|
return self._custom_app_integration
|
|
882
916
|
|
|
883
917
|
@property
|
|
884
|
-
def encryption_keys(self) -> EncryptionKeysAPI:
|
|
918
|
+
def encryption_keys(self) -> service.provisioning.EncryptionKeysAPI:
|
|
885
919
|
"""These APIs manage encryption key configurations for this workspace (optional)."""
|
|
886
920
|
return self._encryption_keys
|
|
887
921
|
|
|
888
922
|
@property
|
|
889
|
-
def federation_policy(self) -> AccountFederationPolicyAPI:
|
|
923
|
+
def federation_policy(self) -> service.oauth2.AccountFederationPolicyAPI:
|
|
890
924
|
"""These APIs manage account federation policies."""
|
|
891
925
|
return self._federation_policy
|
|
892
926
|
|
|
893
927
|
@property
|
|
894
|
-
def groups(self) -> AccountGroupsAPI:
|
|
928
|
+
def groups(self) -> service.iam.AccountGroupsAPI:
|
|
895
929
|
"""Groups simplify identity management, making it easier to assign access to Databricks account, data, and other securable objects."""
|
|
896
930
|
return self._groups
|
|
897
931
|
|
|
898
932
|
@property
|
|
899
|
-
def ip_access_lists(self) -> AccountIpAccessListsAPI:
|
|
933
|
+
def ip_access_lists(self) -> service.settings.AccountIpAccessListsAPI:
|
|
900
934
|
"""The Accounts IP Access List API enables account admins to configure IP access lists for access to the account console."""
|
|
901
935
|
return self._ip_access_lists
|
|
902
936
|
|
|
903
937
|
@property
|
|
904
|
-
def log_delivery(self) -> LogDeliveryAPI:
|
|
938
|
+
def log_delivery(self) -> service.billing.LogDeliveryAPI:
|
|
905
939
|
"""These APIs manage log delivery configurations for this account."""
|
|
906
940
|
return self._log_delivery
|
|
907
941
|
|
|
908
942
|
@property
|
|
909
|
-
def metastore_assignments(self) -> AccountMetastoreAssignmentsAPI:
|
|
943
|
+
def metastore_assignments(self) -> service.catalog.AccountMetastoreAssignmentsAPI:
|
|
910
944
|
"""These APIs manage metastore assignments to a workspace."""
|
|
911
945
|
return self._metastore_assignments
|
|
912
946
|
|
|
913
947
|
@property
|
|
914
|
-
def metastores(self) -> AccountMetastoresAPI:
|
|
948
|
+
def metastores(self) -> service.catalog.AccountMetastoresAPI:
|
|
915
949
|
"""These APIs manage Unity Catalog metastores for an account."""
|
|
916
950
|
return self._metastores
|
|
917
951
|
|
|
918
952
|
@property
|
|
919
|
-
def network_connectivity(self) -> NetworkConnectivityAPI:
|
|
953
|
+
def network_connectivity(self) -> service.settings.NetworkConnectivityAPI:
|
|
920
954
|
"""These APIs provide configurations for the network connectivity of your workspaces for serverless compute resources."""
|
|
921
955
|
return self._network_connectivity
|
|
922
956
|
|
|
923
957
|
@property
|
|
924
|
-
def networks(self) -> NetworksAPI:
|
|
958
|
+
def networks(self) -> service.provisioning.NetworksAPI:
|
|
925
959
|
"""These APIs manage network configurations for customer-managed VPCs (optional)."""
|
|
926
960
|
return self._networks
|
|
927
961
|
|
|
928
962
|
@property
|
|
929
|
-
def o_auth_published_apps(self) -> OAuthPublishedAppsAPI:
|
|
963
|
+
def o_auth_published_apps(self) -> service.oauth2.OAuthPublishedAppsAPI:
|
|
930
964
|
"""These APIs enable administrators to view all the available published OAuth applications in Databricks."""
|
|
931
965
|
return self._o_auth_published_apps
|
|
932
966
|
|
|
933
967
|
@property
|
|
934
|
-
def private_access(self) -> PrivateAccessAPI:
|
|
968
|
+
def private_access(self) -> service.provisioning.PrivateAccessAPI:
|
|
935
969
|
"""These APIs manage private access settings for this account."""
|
|
936
970
|
return self._private_access
|
|
937
971
|
|
|
938
972
|
@property
|
|
939
|
-
def published_app_integration(self) -> PublishedAppIntegrationAPI:
|
|
973
|
+
def published_app_integration(self) -> service.oauth2.PublishedAppIntegrationAPI:
|
|
940
974
|
"""These APIs enable administrators to manage published OAuth app integrations, which is required for adding/using Published OAuth App Integration like Tableau Desktop for Databricks in AWS cloud."""
|
|
941
975
|
return self._published_app_integration
|
|
942
976
|
|
|
943
977
|
@property
|
|
944
|
-
def service_principal_federation_policy(self) -> ServicePrincipalFederationPolicyAPI:
|
|
978
|
+
def service_principal_federation_policy(self) -> service.oauth2.ServicePrincipalFederationPolicyAPI:
|
|
945
979
|
"""These APIs manage service principal federation policies."""
|
|
946
980
|
return self._service_principal_federation_policy
|
|
947
981
|
|
|
948
982
|
@property
|
|
949
|
-
def service_principal_secrets(self) -> ServicePrincipalSecretsAPI:
|
|
983
|
+
def service_principal_secrets(self) -> service.oauth2.ServicePrincipalSecretsAPI:
|
|
950
984
|
"""These APIs enable administrators to manage service principal secrets."""
|
|
951
985
|
return self._service_principal_secrets
|
|
952
986
|
|
|
953
987
|
@property
|
|
954
|
-
def service_principals(self) -> AccountServicePrincipalsAPI:
|
|
988
|
+
def service_principals(self) -> service.iam.AccountServicePrincipalsAPI:
|
|
955
989
|
"""Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD platforms."""
|
|
956
990
|
return self._service_principals
|
|
957
991
|
|
|
958
992
|
@property
|
|
959
|
-
def settings(self) -> AccountSettingsAPI:
|
|
993
|
+
def settings(self) -> service.settings.AccountSettingsAPI:
|
|
960
994
|
"""Accounts Settings API allows users to manage settings at the account level."""
|
|
961
995
|
return self._settings
|
|
962
996
|
|
|
963
997
|
@property
|
|
964
|
-
def storage(self) -> StorageAPI:
|
|
998
|
+
def storage(self) -> service.provisioning.StorageAPI:
|
|
965
999
|
"""These APIs manage storage configurations for this workspace."""
|
|
966
1000
|
return self._storage
|
|
967
1001
|
|
|
968
1002
|
@property
|
|
969
|
-
def storage_credentials(self) -> AccountStorageCredentialsAPI:
|
|
1003
|
+
def storage_credentials(self) -> service.catalog.AccountStorageCredentialsAPI:
|
|
970
1004
|
"""These APIs manage storage credentials for a particular metastore."""
|
|
971
1005
|
return self._storage_credentials
|
|
972
1006
|
|
|
973
1007
|
@property
|
|
974
|
-
def usage_dashboards(self) -> UsageDashboardsAPI:
|
|
1008
|
+
def usage_dashboards(self) -> service.billing.UsageDashboardsAPI:
|
|
975
1009
|
"""These APIs manage usage dashboards for this account."""
|
|
976
1010
|
return self._usage_dashboards
|
|
977
1011
|
|
|
978
1012
|
@property
|
|
979
|
-
def users(self) -> AccountUsersAPI:
|
|
1013
|
+
def users(self) -> service.iam.AccountUsersAPI:
|
|
980
1014
|
"""User identities recognized by Databricks and represented by email addresses."""
|
|
981
1015
|
return self._users
|
|
982
1016
|
|
|
983
1017
|
@property
|
|
984
|
-
def vpc_endpoints(self) -> VpcEndpointsAPI:
|
|
1018
|
+
def vpc_endpoints(self) -> service.provisioning.VpcEndpointsAPI:
|
|
985
1019
|
"""These APIs manage VPC endpoint configurations for this account."""
|
|
986
1020
|
return self._vpc_endpoints
|
|
987
1021
|
|
|
988
1022
|
@property
|
|
989
|
-
def workspace_assignment(self) -> WorkspaceAssignmentAPI:
|
|
1023
|
+
def workspace_assignment(self) -> service.iam.WorkspaceAssignmentAPI:
|
|
990
1024
|
"""The Workspace Permission Assignment API allows you to manage workspace permissions for principals in your account."""
|
|
991
1025
|
return self._workspace_assignment
|
|
992
1026
|
|
|
993
1027
|
@property
|
|
994
|
-
def workspaces(self) -> WorkspacesAPI:
|
|
1028
|
+
def workspaces(self) -> service.provisioning.WorkspacesAPI:
|
|
995
1029
|
"""These APIs manage workspaces for this account."""
|
|
996
1030
|
return self._workspaces
|
|
997
1031
|
|
|
998
1032
|
@property
|
|
999
|
-
def budgets(self) -> BudgetsAPI:
|
|
1033
|
+
def budgets(self) -> service.billing.BudgetsAPI:
|
|
1000
1034
|
"""These APIs manage budget configurations for this account."""
|
|
1001
1035
|
return self._budgets
|
|
1002
1036
|
|