databricks-sdk 0.54.0__py3-none-any.whl → 0.55.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 +275 -260
- databricks/sdk/config.py +15 -4
- databricks/sdk/credentials_provider.py +101 -55
- databricks/sdk/oauth.py +0 -5
- databricks/sdk/oidc.py +206 -0
- databricks/sdk/version.py +1 -1
- {databricks_sdk-0.54.0.dist-info → databricks_sdk-0.55.0.dist-info}/METADATA +1 -1
- {databricks_sdk-0.54.0.dist-info → databricks_sdk-0.55.0.dist-info}/RECORD +12 -11
- {databricks_sdk-0.54.0.dist-info → databricks_sdk-0.55.0.dist-info}/WHEEL +1 -1
- {databricks_sdk-0.54.0.dist-info → databricks_sdk-0.55.0.dist-info}/licenses/LICENSE +0 -0
- {databricks_sdk-0.54.0.dist-info → databricks_sdk-0.55.0.dist-info}/licenses/NOTICE +0 -0
- {databricks_sdk-0.54.0.dist-info → databricks_sdk-0.55.0.dist-info}/top_level.txt +0 -0
databricks/sdk/__init__.py
CHANGED
|
@@ -5,7 +5,6 @@ from typing import Optional
|
|
|
5
5
|
|
|
6
6
|
import databricks.sdk.core as client
|
|
7
7
|
import databricks.sdk.dbutils as dbutils
|
|
8
|
-
import databricks.sdk.service as service
|
|
9
8
|
from databricks.sdk import azure
|
|
10
9
|
from databricks.sdk.credentials_provider import CredentialsStrategy
|
|
11
10
|
from databricks.sdk.data_plane import DataPlaneTokenSource
|
|
@@ -14,6 +13,26 @@ from databricks.sdk.mixins.files import DbfsExt, FilesExt
|
|
|
14
13
|
from databricks.sdk.mixins.jobs import JobsExt
|
|
15
14
|
from databricks.sdk.mixins.open_ai_client import ServingEndpointsExt
|
|
16
15
|
from databricks.sdk.mixins.workspace import WorkspaceExt
|
|
16
|
+
from databricks.sdk.service import apps as pkg_apps
|
|
17
|
+
from databricks.sdk.service import billing as pkg_billing
|
|
18
|
+
from databricks.sdk.service import catalog as pkg_catalog
|
|
19
|
+
from databricks.sdk.service import cleanrooms as pkg_cleanrooms
|
|
20
|
+
from databricks.sdk.service import compute as pkg_compute
|
|
21
|
+
from databricks.sdk.service import dashboards as pkg_dashboards
|
|
22
|
+
from databricks.sdk.service import files as pkg_files
|
|
23
|
+
from databricks.sdk.service import iam as pkg_iam
|
|
24
|
+
from databricks.sdk.service import jobs as pkg_jobs
|
|
25
|
+
from databricks.sdk.service import marketplace as pkg_marketplace
|
|
26
|
+
from databricks.sdk.service import ml as pkg_ml
|
|
27
|
+
from databricks.sdk.service import oauth2 as pkg_oauth2
|
|
28
|
+
from databricks.sdk.service import pipelines as pkg_pipelines
|
|
29
|
+
from databricks.sdk.service import provisioning as pkg_provisioning
|
|
30
|
+
from databricks.sdk.service import serving as pkg_serving
|
|
31
|
+
from databricks.sdk.service import settings as pkg_settings
|
|
32
|
+
from databricks.sdk.service import sharing as pkg_sharing
|
|
33
|
+
from databricks.sdk.service import sql as pkg_sql
|
|
34
|
+
from databricks.sdk.service import vectorsearch as pkg_vectorsearch
|
|
35
|
+
from databricks.sdk.service import workspace as pkg_workspace
|
|
17
36
|
from databricks.sdk.service.apps import AppsAPI
|
|
18
37
|
from databricks.sdk.service.billing import (BillableUsageAPI, BudgetPolicyAPI,
|
|
19
38
|
BudgetsAPI, LogDeliveryAPI,
|
|
@@ -209,119 +228,115 @@ class WorkspaceClient:
|
|
|
209
228
|
self._dbutils = _make_dbutils(self._config)
|
|
210
229
|
self._api_client = client.ApiClient(self._config)
|
|
211
230
|
serving_endpoints = ServingEndpointsExt(self._api_client)
|
|
212
|
-
self._access_control =
|
|
213
|
-
self._account_access_control_proxy =
|
|
214
|
-
self._alerts =
|
|
215
|
-
self._alerts_legacy =
|
|
216
|
-
self._alerts_v2 =
|
|
217
|
-
self._apps =
|
|
218
|
-
self._artifact_allowlists =
|
|
219
|
-
self._catalogs =
|
|
220
|
-
self._clean_room_assets =
|
|
221
|
-
self._clean_room_task_runs =
|
|
222
|
-
self._clean_rooms =
|
|
223
|
-
self._cluster_policies =
|
|
231
|
+
self._access_control = pkg_iam.AccessControlAPI(self._api_client)
|
|
232
|
+
self._account_access_control_proxy = pkg_iam.AccountAccessControlProxyAPI(self._api_client)
|
|
233
|
+
self._alerts = pkg_sql.AlertsAPI(self._api_client)
|
|
234
|
+
self._alerts_legacy = pkg_sql.AlertsLegacyAPI(self._api_client)
|
|
235
|
+
self._alerts_v2 = pkg_sql.AlertsV2API(self._api_client)
|
|
236
|
+
self._apps = pkg_apps.AppsAPI(self._api_client)
|
|
237
|
+
self._artifact_allowlists = pkg_catalog.ArtifactAllowlistsAPI(self._api_client)
|
|
238
|
+
self._catalogs = pkg_catalog.CatalogsAPI(self._api_client)
|
|
239
|
+
self._clean_room_assets = pkg_cleanrooms.CleanRoomAssetsAPI(self._api_client)
|
|
240
|
+
self._clean_room_task_runs = pkg_cleanrooms.CleanRoomTaskRunsAPI(self._api_client)
|
|
241
|
+
self._clean_rooms = pkg_cleanrooms.CleanRoomsAPI(self._api_client)
|
|
242
|
+
self._cluster_policies = pkg_compute.ClusterPoliciesAPI(self._api_client)
|
|
224
243
|
self._clusters = ClustersExt(self._api_client)
|
|
225
|
-
self._command_execution =
|
|
226
|
-
self._connections =
|
|
227
|
-
self._consumer_fulfillments =
|
|
228
|
-
self._consumer_installations =
|
|
229
|
-
self._consumer_listings =
|
|
230
|
-
self._consumer_personalization_requests =
|
|
231
|
-
|
|
232
|
-
)
|
|
233
|
-
self.
|
|
234
|
-
self.
|
|
235
|
-
self.
|
|
236
|
-
self.
|
|
237
|
-
self.
|
|
238
|
-
self.
|
|
239
|
-
self._data_sources = service.sql.DataSourcesAPI(self._api_client)
|
|
240
|
-
self._database_instances = service.catalog.DatabaseInstancesAPI(self._api_client)
|
|
244
|
+
self._command_execution = pkg_compute.CommandExecutionAPI(self._api_client)
|
|
245
|
+
self._connections = pkg_catalog.ConnectionsAPI(self._api_client)
|
|
246
|
+
self._consumer_fulfillments = pkg_marketplace.ConsumerFulfillmentsAPI(self._api_client)
|
|
247
|
+
self._consumer_installations = pkg_marketplace.ConsumerInstallationsAPI(self._api_client)
|
|
248
|
+
self._consumer_listings = pkg_marketplace.ConsumerListingsAPI(self._api_client)
|
|
249
|
+
self._consumer_personalization_requests = pkg_marketplace.ConsumerPersonalizationRequestsAPI(self._api_client)
|
|
250
|
+
self._consumer_providers = pkg_marketplace.ConsumerProvidersAPI(self._api_client)
|
|
251
|
+
self._credentials = pkg_catalog.CredentialsAPI(self._api_client)
|
|
252
|
+
self._credentials_manager = pkg_settings.CredentialsManagerAPI(self._api_client)
|
|
253
|
+
self._current_user = pkg_iam.CurrentUserAPI(self._api_client)
|
|
254
|
+
self._dashboard_widgets = pkg_sql.DashboardWidgetsAPI(self._api_client)
|
|
255
|
+
self._dashboards = pkg_sql.DashboardsAPI(self._api_client)
|
|
256
|
+
self._data_sources = pkg_sql.DataSourcesAPI(self._api_client)
|
|
257
|
+
self._database_instances = pkg_catalog.DatabaseInstancesAPI(self._api_client)
|
|
241
258
|
self._dbfs = DbfsExt(self._api_client)
|
|
242
|
-
self._dbsql_permissions =
|
|
243
|
-
self._experiments =
|
|
244
|
-
self._external_locations =
|
|
259
|
+
self._dbsql_permissions = pkg_sql.DbsqlPermissionsAPI(self._api_client)
|
|
260
|
+
self._experiments = pkg_ml.ExperimentsAPI(self._api_client)
|
|
261
|
+
self._external_locations = pkg_catalog.ExternalLocationsAPI(self._api_client)
|
|
245
262
|
self._files = _make_files_client(self._api_client, self._config)
|
|
246
|
-
self._functions =
|
|
247
|
-
self._genie =
|
|
248
|
-
self._git_credentials =
|
|
249
|
-
self._global_init_scripts =
|
|
250
|
-
self._grants =
|
|
251
|
-
self._groups =
|
|
252
|
-
self._instance_pools =
|
|
253
|
-
self._instance_profiles =
|
|
254
|
-
self._ip_access_lists =
|
|
263
|
+
self._functions = pkg_catalog.FunctionsAPI(self._api_client)
|
|
264
|
+
self._genie = pkg_dashboards.GenieAPI(self._api_client)
|
|
265
|
+
self._git_credentials = pkg_workspace.GitCredentialsAPI(self._api_client)
|
|
266
|
+
self._global_init_scripts = pkg_compute.GlobalInitScriptsAPI(self._api_client)
|
|
267
|
+
self._grants = pkg_catalog.GrantsAPI(self._api_client)
|
|
268
|
+
self._groups = pkg_iam.GroupsAPI(self._api_client)
|
|
269
|
+
self._instance_pools = pkg_compute.InstancePoolsAPI(self._api_client)
|
|
270
|
+
self._instance_profiles = pkg_compute.InstanceProfilesAPI(self._api_client)
|
|
271
|
+
self._ip_access_lists = pkg_settings.IpAccessListsAPI(self._api_client)
|
|
255
272
|
self._jobs = JobsExt(self._api_client)
|
|
256
|
-
self._lakeview =
|
|
257
|
-
self._lakeview_embedded =
|
|
258
|
-
self._libraries =
|
|
259
|
-
self._metastores =
|
|
260
|
-
self._model_registry =
|
|
261
|
-
self._model_versions =
|
|
262
|
-
self._notification_destinations =
|
|
263
|
-
self._online_tables =
|
|
264
|
-
self._permission_migration =
|
|
265
|
-
self._permissions =
|
|
266
|
-
self._pipelines =
|
|
267
|
-
self._policy_compliance_for_clusters =
|
|
268
|
-
self._policy_compliance_for_jobs =
|
|
269
|
-
self._policy_families =
|
|
270
|
-
self._provider_exchange_filters =
|
|
271
|
-
self._provider_exchanges =
|
|
272
|
-
self._provider_files =
|
|
273
|
-
self._provider_listings =
|
|
274
|
-
self._provider_personalization_requests =
|
|
275
|
-
|
|
276
|
-
)
|
|
277
|
-
self._provider_provider_analytics_dashboards = service.marketplace.ProviderProviderAnalyticsDashboardsAPI(
|
|
273
|
+
self._lakeview = pkg_dashboards.LakeviewAPI(self._api_client)
|
|
274
|
+
self._lakeview_embedded = pkg_dashboards.LakeviewEmbeddedAPI(self._api_client)
|
|
275
|
+
self._libraries = pkg_compute.LibrariesAPI(self._api_client)
|
|
276
|
+
self._metastores = pkg_catalog.MetastoresAPI(self._api_client)
|
|
277
|
+
self._model_registry = pkg_ml.ModelRegistryAPI(self._api_client)
|
|
278
|
+
self._model_versions = pkg_catalog.ModelVersionsAPI(self._api_client)
|
|
279
|
+
self._notification_destinations = pkg_settings.NotificationDestinationsAPI(self._api_client)
|
|
280
|
+
self._online_tables = pkg_catalog.OnlineTablesAPI(self._api_client)
|
|
281
|
+
self._permission_migration = pkg_iam.PermissionMigrationAPI(self._api_client)
|
|
282
|
+
self._permissions = pkg_iam.PermissionsAPI(self._api_client)
|
|
283
|
+
self._pipelines = pkg_pipelines.PipelinesAPI(self._api_client)
|
|
284
|
+
self._policy_compliance_for_clusters = pkg_compute.PolicyComplianceForClustersAPI(self._api_client)
|
|
285
|
+
self._policy_compliance_for_jobs = pkg_jobs.PolicyComplianceForJobsAPI(self._api_client)
|
|
286
|
+
self._policy_families = pkg_compute.PolicyFamiliesAPI(self._api_client)
|
|
287
|
+
self._provider_exchange_filters = pkg_marketplace.ProviderExchangeFiltersAPI(self._api_client)
|
|
288
|
+
self._provider_exchanges = pkg_marketplace.ProviderExchangesAPI(self._api_client)
|
|
289
|
+
self._provider_files = pkg_marketplace.ProviderFilesAPI(self._api_client)
|
|
290
|
+
self._provider_listings = pkg_marketplace.ProviderListingsAPI(self._api_client)
|
|
291
|
+
self._provider_personalization_requests = pkg_marketplace.ProviderPersonalizationRequestsAPI(self._api_client)
|
|
292
|
+
self._provider_provider_analytics_dashboards = pkg_marketplace.ProviderProviderAnalyticsDashboardsAPI(
|
|
278
293
|
self._api_client
|
|
279
294
|
)
|
|
280
|
-
self._provider_providers =
|
|
281
|
-
self._providers =
|
|
282
|
-
self._quality_monitors =
|
|
283
|
-
self._queries =
|
|
284
|
-
self._queries_legacy =
|
|
285
|
-
self._query_execution =
|
|
286
|
-
self._query_history =
|
|
287
|
-
self._query_visualizations =
|
|
288
|
-
self._query_visualizations_legacy =
|
|
289
|
-
self._recipient_activation =
|
|
290
|
-
self._recipient_federation_policies =
|
|
291
|
-
self._recipients =
|
|
292
|
-
self._redash_config =
|
|
293
|
-
self._registered_models =
|
|
294
|
-
self._repos =
|
|
295
|
-
self._resource_quotas =
|
|
296
|
-
self._schemas =
|
|
297
|
-
self._secrets =
|
|
298
|
-
self._service_principals =
|
|
295
|
+
self._provider_providers = pkg_marketplace.ProviderProvidersAPI(self._api_client)
|
|
296
|
+
self._providers = pkg_sharing.ProvidersAPI(self._api_client)
|
|
297
|
+
self._quality_monitors = pkg_catalog.QualityMonitorsAPI(self._api_client)
|
|
298
|
+
self._queries = pkg_sql.QueriesAPI(self._api_client)
|
|
299
|
+
self._queries_legacy = pkg_sql.QueriesLegacyAPI(self._api_client)
|
|
300
|
+
self._query_execution = pkg_dashboards.QueryExecutionAPI(self._api_client)
|
|
301
|
+
self._query_history = pkg_sql.QueryHistoryAPI(self._api_client)
|
|
302
|
+
self._query_visualizations = pkg_sql.QueryVisualizationsAPI(self._api_client)
|
|
303
|
+
self._query_visualizations_legacy = pkg_sql.QueryVisualizationsLegacyAPI(self._api_client)
|
|
304
|
+
self._recipient_activation = pkg_sharing.RecipientActivationAPI(self._api_client)
|
|
305
|
+
self._recipient_federation_policies = pkg_sharing.RecipientFederationPoliciesAPI(self._api_client)
|
|
306
|
+
self._recipients = pkg_sharing.RecipientsAPI(self._api_client)
|
|
307
|
+
self._redash_config = pkg_sql.RedashConfigAPI(self._api_client)
|
|
308
|
+
self._registered_models = pkg_catalog.RegisteredModelsAPI(self._api_client)
|
|
309
|
+
self._repos = pkg_workspace.ReposAPI(self._api_client)
|
|
310
|
+
self._resource_quotas = pkg_catalog.ResourceQuotasAPI(self._api_client)
|
|
311
|
+
self._schemas = pkg_catalog.SchemasAPI(self._api_client)
|
|
312
|
+
self._secrets = pkg_workspace.SecretsAPI(self._api_client)
|
|
313
|
+
self._service_principals = pkg_iam.ServicePrincipalsAPI(self._api_client)
|
|
299
314
|
self._serving_endpoints = serving_endpoints
|
|
300
315
|
serving_endpoints_data_plane_token_source = DataPlaneTokenSource(
|
|
301
316
|
self._config.host, self._config.oauth_token, self._config.disable_async_token_refresh
|
|
302
317
|
)
|
|
303
|
-
self._serving_endpoints_data_plane =
|
|
318
|
+
self._serving_endpoints_data_plane = pkg_serving.ServingEndpointsDataPlaneAPI(
|
|
304
319
|
self._api_client, serving_endpoints, serving_endpoints_data_plane_token_source
|
|
305
320
|
)
|
|
306
|
-
self._settings =
|
|
307
|
-
self._shares =
|
|
308
|
-
self._statement_execution =
|
|
309
|
-
self._storage_credentials =
|
|
310
|
-
self._system_schemas =
|
|
311
|
-
self._table_constraints =
|
|
312
|
-
self._tables =
|
|
313
|
-
self._temporary_table_credentials =
|
|
314
|
-
self._token_management =
|
|
315
|
-
self._tokens =
|
|
316
|
-
self._users =
|
|
317
|
-
self._vector_search_endpoints =
|
|
318
|
-
self._vector_search_indexes =
|
|
319
|
-
self._volumes =
|
|
320
|
-
self._warehouses =
|
|
321
|
+
self._settings = pkg_settings.SettingsAPI(self._api_client)
|
|
322
|
+
self._shares = pkg_sharing.SharesAPI(self._api_client)
|
|
323
|
+
self._statement_execution = pkg_sql.StatementExecutionAPI(self._api_client)
|
|
324
|
+
self._storage_credentials = pkg_catalog.StorageCredentialsAPI(self._api_client)
|
|
325
|
+
self._system_schemas = pkg_catalog.SystemSchemasAPI(self._api_client)
|
|
326
|
+
self._table_constraints = pkg_catalog.TableConstraintsAPI(self._api_client)
|
|
327
|
+
self._tables = pkg_catalog.TablesAPI(self._api_client)
|
|
328
|
+
self._temporary_table_credentials = pkg_catalog.TemporaryTableCredentialsAPI(self._api_client)
|
|
329
|
+
self._token_management = pkg_settings.TokenManagementAPI(self._api_client)
|
|
330
|
+
self._tokens = pkg_settings.TokensAPI(self._api_client)
|
|
331
|
+
self._users = pkg_iam.UsersAPI(self._api_client)
|
|
332
|
+
self._vector_search_endpoints = pkg_vectorsearch.VectorSearchEndpointsAPI(self._api_client)
|
|
333
|
+
self._vector_search_indexes = pkg_vectorsearch.VectorSearchIndexesAPI(self._api_client)
|
|
334
|
+
self._volumes = pkg_catalog.VolumesAPI(self._api_client)
|
|
335
|
+
self._warehouses = pkg_sql.WarehousesAPI(self._api_client)
|
|
321
336
|
self._workspace = WorkspaceExt(self._api_client)
|
|
322
|
-
self._workspace_bindings =
|
|
323
|
-
self._workspace_conf =
|
|
324
|
-
self._forecasting =
|
|
337
|
+
self._workspace_bindings = pkg_catalog.WorkspaceBindingsAPI(self._api_client)
|
|
338
|
+
self._workspace_conf = pkg_settings.WorkspaceConfAPI(self._api_client)
|
|
339
|
+
self._forecasting = pkg_ml.ForecastingAPI(self._api_client)
|
|
325
340
|
|
|
326
341
|
@property
|
|
327
342
|
def config(self) -> client.Config:
|
|
@@ -336,62 +351,62 @@ class WorkspaceClient:
|
|
|
336
351
|
return self._dbutils
|
|
337
352
|
|
|
338
353
|
@property
|
|
339
|
-
def access_control(self) ->
|
|
354
|
+
def access_control(self) -> pkg_iam.AccessControlAPI:
|
|
340
355
|
"""Rule based Access Control for Databricks Resources."""
|
|
341
356
|
return self._access_control
|
|
342
357
|
|
|
343
358
|
@property
|
|
344
|
-
def account_access_control_proxy(self) ->
|
|
359
|
+
def account_access_control_proxy(self) -> pkg_iam.AccountAccessControlProxyAPI:
|
|
345
360
|
"""These APIs manage access rules on resources in an account."""
|
|
346
361
|
return self._account_access_control_proxy
|
|
347
362
|
|
|
348
363
|
@property
|
|
349
|
-
def alerts(self) ->
|
|
364
|
+
def alerts(self) -> pkg_sql.AlertsAPI:
|
|
350
365
|
"""The alerts API can be used to perform CRUD operations on alerts."""
|
|
351
366
|
return self._alerts
|
|
352
367
|
|
|
353
368
|
@property
|
|
354
|
-
def alerts_legacy(self) ->
|
|
369
|
+
def alerts_legacy(self) -> pkg_sql.AlertsLegacyAPI:
|
|
355
370
|
"""The alerts API can be used to perform CRUD operations on alerts."""
|
|
356
371
|
return self._alerts_legacy
|
|
357
372
|
|
|
358
373
|
@property
|
|
359
|
-
def alerts_v2(self) ->
|
|
374
|
+
def alerts_v2(self) -> pkg_sql.AlertsV2API:
|
|
360
375
|
"""TODO: Add description."""
|
|
361
376
|
return self._alerts_v2
|
|
362
377
|
|
|
363
378
|
@property
|
|
364
|
-
def apps(self) ->
|
|
379
|
+
def apps(self) -> pkg_apps.AppsAPI:
|
|
365
380
|
"""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."""
|
|
366
381
|
return self._apps
|
|
367
382
|
|
|
368
383
|
@property
|
|
369
|
-
def artifact_allowlists(self) ->
|
|
384
|
+
def artifact_allowlists(self) -> pkg_catalog.ArtifactAllowlistsAPI:
|
|
370
385
|
"""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."""
|
|
371
386
|
return self._artifact_allowlists
|
|
372
387
|
|
|
373
388
|
@property
|
|
374
|
-
def catalogs(self) ->
|
|
389
|
+
def catalogs(self) -> pkg_catalog.CatalogsAPI:
|
|
375
390
|
"""A catalog is the first layer of Unity Catalog’s three-level namespace."""
|
|
376
391
|
return self._catalogs
|
|
377
392
|
|
|
378
393
|
@property
|
|
379
|
-
def clean_room_assets(self) ->
|
|
394
|
+
def clean_room_assets(self) -> pkg_cleanrooms.CleanRoomAssetsAPI:
|
|
380
395
|
"""Clean room assets are data and code objects — Tables, volumes, and notebooks that are shared with the clean room."""
|
|
381
396
|
return self._clean_room_assets
|
|
382
397
|
|
|
383
398
|
@property
|
|
384
|
-
def clean_room_task_runs(self) ->
|
|
399
|
+
def clean_room_task_runs(self) -> pkg_cleanrooms.CleanRoomTaskRunsAPI:
|
|
385
400
|
"""Clean room task runs are the executions of notebooks in a clean room."""
|
|
386
401
|
return self._clean_room_task_runs
|
|
387
402
|
|
|
388
403
|
@property
|
|
389
|
-
def clean_rooms(self) ->
|
|
404
|
+
def clean_rooms(self) -> pkg_cleanrooms.CleanRoomsAPI:
|
|
390
405
|
"""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."""
|
|
391
406
|
return self._clean_rooms
|
|
392
407
|
|
|
393
408
|
@property
|
|
394
|
-
def cluster_policies(self) ->
|
|
409
|
+
def cluster_policies(self) -> pkg_compute.ClusterPoliciesAPI:
|
|
395
410
|
"""You can use cluster policies to control users' ability to configure clusters based on a set of rules."""
|
|
396
411
|
return self._cluster_policies
|
|
397
412
|
|
|
@@ -401,72 +416,72 @@ class WorkspaceClient:
|
|
|
401
416
|
return self._clusters
|
|
402
417
|
|
|
403
418
|
@property
|
|
404
|
-
def command_execution(self) ->
|
|
419
|
+
def command_execution(self) -> pkg_compute.CommandExecutionAPI:
|
|
405
420
|
"""This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters."""
|
|
406
421
|
return self._command_execution
|
|
407
422
|
|
|
408
423
|
@property
|
|
409
|
-
def connections(self) ->
|
|
424
|
+
def connections(self) -> pkg_catalog.ConnectionsAPI:
|
|
410
425
|
"""Connections allow for creating a connection to an external data source."""
|
|
411
426
|
return self._connections
|
|
412
427
|
|
|
413
428
|
@property
|
|
414
|
-
def consumer_fulfillments(self) ->
|
|
429
|
+
def consumer_fulfillments(self) -> pkg_marketplace.ConsumerFulfillmentsAPI:
|
|
415
430
|
"""Fulfillments are entities that allow consumers to preview installations."""
|
|
416
431
|
return self._consumer_fulfillments
|
|
417
432
|
|
|
418
433
|
@property
|
|
419
|
-
def consumer_installations(self) ->
|
|
434
|
+
def consumer_installations(self) -> pkg_marketplace.ConsumerInstallationsAPI:
|
|
420
435
|
"""Installations are entities that allow consumers to interact with Databricks Marketplace listings."""
|
|
421
436
|
return self._consumer_installations
|
|
422
437
|
|
|
423
438
|
@property
|
|
424
|
-
def consumer_listings(self) ->
|
|
439
|
+
def consumer_listings(self) -> pkg_marketplace.ConsumerListingsAPI:
|
|
425
440
|
"""Listings are the core entities in the Marketplace."""
|
|
426
441
|
return self._consumer_listings
|
|
427
442
|
|
|
428
443
|
@property
|
|
429
|
-
def consumer_personalization_requests(self) ->
|
|
444
|
+
def consumer_personalization_requests(self) -> pkg_marketplace.ConsumerPersonalizationRequestsAPI:
|
|
430
445
|
"""Personalization Requests allow customers to interact with the individualized Marketplace listing flow."""
|
|
431
446
|
return self._consumer_personalization_requests
|
|
432
447
|
|
|
433
448
|
@property
|
|
434
|
-
def consumer_providers(self) ->
|
|
449
|
+
def consumer_providers(self) -> pkg_marketplace.ConsumerProvidersAPI:
|
|
435
450
|
"""Providers are the entities that publish listings to the Marketplace."""
|
|
436
451
|
return self._consumer_providers
|
|
437
452
|
|
|
438
453
|
@property
|
|
439
|
-
def credentials(self) ->
|
|
454
|
+
def credentials(self) -> pkg_catalog.CredentialsAPI:
|
|
440
455
|
"""A credential represents an authentication and authorization mechanism for accessing services on your cloud tenant."""
|
|
441
456
|
return self._credentials
|
|
442
457
|
|
|
443
458
|
@property
|
|
444
|
-
def credentials_manager(self) ->
|
|
459
|
+
def credentials_manager(self) -> pkg_settings.CredentialsManagerAPI:
|
|
445
460
|
"""Credentials manager interacts with with Identity Providers to to perform token exchanges using stored credentials and refresh tokens."""
|
|
446
461
|
return self._credentials_manager
|
|
447
462
|
|
|
448
463
|
@property
|
|
449
|
-
def current_user(self) ->
|
|
464
|
+
def current_user(self) -> pkg_iam.CurrentUserAPI:
|
|
450
465
|
"""This API allows retrieving information about currently authenticated user or service principal."""
|
|
451
466
|
return self._current_user
|
|
452
467
|
|
|
453
468
|
@property
|
|
454
|
-
def dashboard_widgets(self) ->
|
|
469
|
+
def dashboard_widgets(self) -> pkg_sql.DashboardWidgetsAPI:
|
|
455
470
|
"""This is an evolving API that facilitates the addition and removal of widgets from existing dashboards within the Databricks Workspace."""
|
|
456
471
|
return self._dashboard_widgets
|
|
457
472
|
|
|
458
473
|
@property
|
|
459
|
-
def dashboards(self) ->
|
|
474
|
+
def dashboards(self) -> pkg_sql.DashboardsAPI:
|
|
460
475
|
"""In general, there is little need to modify dashboards using the API."""
|
|
461
476
|
return self._dashboards
|
|
462
477
|
|
|
463
478
|
@property
|
|
464
|
-
def data_sources(self) ->
|
|
479
|
+
def data_sources(self) -> pkg_sql.DataSourcesAPI:
|
|
465
480
|
"""This API is provided to assist you in making new query objects."""
|
|
466
481
|
return self._data_sources
|
|
467
482
|
|
|
468
483
|
@property
|
|
469
|
-
def database_instances(self) ->
|
|
484
|
+
def database_instances(self) -> pkg_catalog.DatabaseInstancesAPI:
|
|
470
485
|
"""Database Instances provide access to a database via REST API or direct SQL."""
|
|
471
486
|
return self._database_instances
|
|
472
487
|
|
|
@@ -476,67 +491,67 @@ class WorkspaceClient:
|
|
|
476
491
|
return self._dbfs
|
|
477
492
|
|
|
478
493
|
@property
|
|
479
|
-
def dbsql_permissions(self) ->
|
|
494
|
+
def dbsql_permissions(self) -> pkg_sql.DbsqlPermissionsAPI:
|
|
480
495
|
"""The SQL Permissions API is similar to the endpoints of the :method:permissions/set."""
|
|
481
496
|
return self._dbsql_permissions
|
|
482
497
|
|
|
483
498
|
@property
|
|
484
|
-
def experiments(self) ->
|
|
499
|
+
def experiments(self) -> pkg_ml.ExperimentsAPI:
|
|
485
500
|
"""Experiments are the primary unit of organization in MLflow; all MLflow runs belong to an experiment."""
|
|
486
501
|
return self._experiments
|
|
487
502
|
|
|
488
503
|
@property
|
|
489
|
-
def external_locations(self) ->
|
|
504
|
+
def external_locations(self) -> pkg_catalog.ExternalLocationsAPI:
|
|
490
505
|
"""An external location is an object that combines a cloud storage path with a storage credential that authorizes access to the cloud storage path."""
|
|
491
506
|
return self._external_locations
|
|
492
507
|
|
|
493
508
|
@property
|
|
494
|
-
def files(self) ->
|
|
509
|
+
def files(self) -> pkg_files.FilesAPI:
|
|
495
510
|
"""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."""
|
|
496
511
|
return self._files
|
|
497
512
|
|
|
498
513
|
@property
|
|
499
|
-
def functions(self) ->
|
|
514
|
+
def functions(self) -> pkg_catalog.FunctionsAPI:
|
|
500
515
|
"""Functions implement User-Defined Functions (UDFs) in Unity Catalog."""
|
|
501
516
|
return self._functions
|
|
502
517
|
|
|
503
518
|
@property
|
|
504
|
-
def genie(self) ->
|
|
519
|
+
def genie(self) -> pkg_dashboards.GenieAPI:
|
|
505
520
|
"""Genie provides a no-code experience for business users, powered by AI/BI."""
|
|
506
521
|
return self._genie
|
|
507
522
|
|
|
508
523
|
@property
|
|
509
|
-
def git_credentials(self) ->
|
|
524
|
+
def git_credentials(self) -> pkg_workspace.GitCredentialsAPI:
|
|
510
525
|
"""Registers personal access token for Databricks to do operations on behalf of the user."""
|
|
511
526
|
return self._git_credentials
|
|
512
527
|
|
|
513
528
|
@property
|
|
514
|
-
def global_init_scripts(self) ->
|
|
529
|
+
def global_init_scripts(self) -> pkg_compute.GlobalInitScriptsAPI:
|
|
515
530
|
"""The Global Init Scripts API enables Workspace administrators to configure global initialization scripts for their workspace."""
|
|
516
531
|
return self._global_init_scripts
|
|
517
532
|
|
|
518
533
|
@property
|
|
519
|
-
def grants(self) ->
|
|
534
|
+
def grants(self) -> pkg_catalog.GrantsAPI:
|
|
520
535
|
"""In Unity Catalog, data is secure by default."""
|
|
521
536
|
return self._grants
|
|
522
537
|
|
|
523
538
|
@property
|
|
524
|
-
def groups(self) ->
|
|
539
|
+
def groups(self) -> pkg_iam.GroupsAPI:
|
|
525
540
|
"""Groups simplify identity management, making it easier to assign access to Databricks workspace, data, and other securable objects."""
|
|
526
541
|
return self._groups
|
|
527
542
|
|
|
528
543
|
@property
|
|
529
|
-
def instance_pools(self) ->
|
|
544
|
+
def instance_pools(self) -> pkg_compute.InstancePoolsAPI:
|
|
530
545
|
"""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."""
|
|
531
546
|
return self._instance_pools
|
|
532
547
|
|
|
533
548
|
@property
|
|
534
|
-
def instance_profiles(self) ->
|
|
549
|
+
def instance_profiles(self) -> pkg_compute.InstanceProfilesAPI:
|
|
535
550
|
"""The Instance Profiles API allows admins to add, list, and remove instance profiles that users can launch clusters with."""
|
|
536
551
|
return self._instance_profiles
|
|
537
552
|
|
|
538
553
|
@property
|
|
539
|
-
def ip_access_lists(self) ->
|
|
554
|
+
def ip_access_lists(self) -> pkg_settings.IpAccessListsAPI:
|
|
540
555
|
"""IP Access List enables admins to configure IP access lists."""
|
|
541
556
|
return self._ip_access_lists
|
|
542
557
|
|
|
@@ -546,197 +561,197 @@ class WorkspaceClient:
|
|
|
546
561
|
return self._jobs
|
|
547
562
|
|
|
548
563
|
@property
|
|
549
|
-
def lakeview(self) ->
|
|
564
|
+
def lakeview(self) -> pkg_dashboards.LakeviewAPI:
|
|
550
565
|
"""These APIs provide specific management operations for Lakeview dashboards."""
|
|
551
566
|
return self._lakeview
|
|
552
567
|
|
|
553
568
|
@property
|
|
554
|
-
def lakeview_embedded(self) ->
|
|
569
|
+
def lakeview_embedded(self) -> pkg_dashboards.LakeviewEmbeddedAPI:
|
|
555
570
|
"""Token-based Lakeview APIs for embedding dashboards in external applications."""
|
|
556
571
|
return self._lakeview_embedded
|
|
557
572
|
|
|
558
573
|
@property
|
|
559
|
-
def libraries(self) ->
|
|
574
|
+
def libraries(self) -> pkg_compute.LibrariesAPI:
|
|
560
575
|
"""The Libraries API allows you to install and uninstall libraries and get the status of libraries on a cluster."""
|
|
561
576
|
return self._libraries
|
|
562
577
|
|
|
563
578
|
@property
|
|
564
|
-
def metastores(self) ->
|
|
579
|
+
def metastores(self) -> pkg_catalog.MetastoresAPI:
|
|
565
580
|
"""A metastore is the top-level container of objects in Unity Catalog."""
|
|
566
581
|
return self._metastores
|
|
567
582
|
|
|
568
583
|
@property
|
|
569
|
-
def model_registry(self) ->
|
|
584
|
+
def model_registry(self) -> pkg_ml.ModelRegistryAPI:
|
|
570
585
|
"""Note: This API reference documents APIs for the Workspace Model Registry."""
|
|
571
586
|
return self._model_registry
|
|
572
587
|
|
|
573
588
|
@property
|
|
574
|
-
def model_versions(self) ->
|
|
589
|
+
def model_versions(self) -> pkg_catalog.ModelVersionsAPI:
|
|
575
590
|
"""Databricks provides a hosted version of MLflow Model Registry in Unity Catalog."""
|
|
576
591
|
return self._model_versions
|
|
577
592
|
|
|
578
593
|
@property
|
|
579
|
-
def notification_destinations(self) ->
|
|
594
|
+
def notification_destinations(self) -> pkg_settings.NotificationDestinationsAPI:
|
|
580
595
|
"""The notification destinations API lets you programmatically manage a workspace's notification destinations."""
|
|
581
596
|
return self._notification_destinations
|
|
582
597
|
|
|
583
598
|
@property
|
|
584
|
-
def online_tables(self) ->
|
|
599
|
+
def online_tables(self) -> pkg_catalog.OnlineTablesAPI:
|
|
585
600
|
"""Online tables provide lower latency and higher QPS access to data from Delta tables."""
|
|
586
601
|
return self._online_tables
|
|
587
602
|
|
|
588
603
|
@property
|
|
589
|
-
def permission_migration(self) ->
|
|
604
|
+
def permission_migration(self) -> pkg_iam.PermissionMigrationAPI:
|
|
590
605
|
"""APIs for migrating acl permissions, used only by the ucx tool: https://github.com/databrickslabs/ucx."""
|
|
591
606
|
return self._permission_migration
|
|
592
607
|
|
|
593
608
|
@property
|
|
594
|
-
def permissions(self) ->
|
|
609
|
+
def permissions(self) -> pkg_iam.PermissionsAPI:
|
|
595
610
|
"""Permissions API are used to create read, write, edit, update and manage access for various users on different objects and endpoints."""
|
|
596
611
|
return self._permissions
|
|
597
612
|
|
|
598
613
|
@property
|
|
599
|
-
def pipelines(self) ->
|
|
614
|
+
def pipelines(self) -> pkg_pipelines.PipelinesAPI:
|
|
600
615
|
"""The Delta Live Tables API allows you to create, edit, delete, start, and view details about pipelines."""
|
|
601
616
|
return self._pipelines
|
|
602
617
|
|
|
603
618
|
@property
|
|
604
|
-
def policy_compliance_for_clusters(self) ->
|
|
619
|
+
def policy_compliance_for_clusters(self) -> pkg_compute.PolicyComplianceForClustersAPI:
|
|
605
620
|
"""The policy compliance APIs allow you to view and manage the policy compliance status of clusters in your workspace."""
|
|
606
621
|
return self._policy_compliance_for_clusters
|
|
607
622
|
|
|
608
623
|
@property
|
|
609
|
-
def policy_compliance_for_jobs(self) ->
|
|
624
|
+
def policy_compliance_for_jobs(self) -> pkg_jobs.PolicyComplianceForJobsAPI:
|
|
610
625
|
"""The compliance APIs allow you to view and manage the policy compliance status of jobs in your workspace."""
|
|
611
626
|
return self._policy_compliance_for_jobs
|
|
612
627
|
|
|
613
628
|
@property
|
|
614
|
-
def policy_families(self) ->
|
|
629
|
+
def policy_families(self) -> pkg_compute.PolicyFamiliesAPI:
|
|
615
630
|
"""View available policy families."""
|
|
616
631
|
return self._policy_families
|
|
617
632
|
|
|
618
633
|
@property
|
|
619
|
-
def provider_exchange_filters(self) ->
|
|
634
|
+
def provider_exchange_filters(self) -> pkg_marketplace.ProviderExchangeFiltersAPI:
|
|
620
635
|
"""Marketplace exchanges filters curate which groups can access an exchange."""
|
|
621
636
|
return self._provider_exchange_filters
|
|
622
637
|
|
|
623
638
|
@property
|
|
624
|
-
def provider_exchanges(self) ->
|
|
639
|
+
def provider_exchanges(self) -> pkg_marketplace.ProviderExchangesAPI:
|
|
625
640
|
"""Marketplace exchanges allow providers to share their listings with a curated set of customers."""
|
|
626
641
|
return self._provider_exchanges
|
|
627
642
|
|
|
628
643
|
@property
|
|
629
|
-
def provider_files(self) ->
|
|
644
|
+
def provider_files(self) -> pkg_marketplace.ProviderFilesAPI:
|
|
630
645
|
"""Marketplace offers a set of file APIs for various purposes such as preview notebooks and provider icons."""
|
|
631
646
|
return self._provider_files
|
|
632
647
|
|
|
633
648
|
@property
|
|
634
|
-
def provider_listings(self) ->
|
|
649
|
+
def provider_listings(self) -> pkg_marketplace.ProviderListingsAPI:
|
|
635
650
|
"""Listings are the core entities in the Marketplace."""
|
|
636
651
|
return self._provider_listings
|
|
637
652
|
|
|
638
653
|
@property
|
|
639
|
-
def provider_personalization_requests(self) ->
|
|
654
|
+
def provider_personalization_requests(self) -> pkg_marketplace.ProviderPersonalizationRequestsAPI:
|
|
640
655
|
"""Personalization requests are an alternate to instantly available listings."""
|
|
641
656
|
return self._provider_personalization_requests
|
|
642
657
|
|
|
643
658
|
@property
|
|
644
|
-
def provider_provider_analytics_dashboards(self) ->
|
|
659
|
+
def provider_provider_analytics_dashboards(self) -> pkg_marketplace.ProviderProviderAnalyticsDashboardsAPI:
|
|
645
660
|
"""Manage templated analytics solution for providers."""
|
|
646
661
|
return self._provider_provider_analytics_dashboards
|
|
647
662
|
|
|
648
663
|
@property
|
|
649
|
-
def provider_providers(self) ->
|
|
664
|
+
def provider_providers(self) -> pkg_marketplace.ProviderProvidersAPI:
|
|
650
665
|
"""Providers are entities that manage assets in Marketplace."""
|
|
651
666
|
return self._provider_providers
|
|
652
667
|
|
|
653
668
|
@property
|
|
654
|
-
def providers(self) ->
|
|
669
|
+
def providers(self) -> pkg_sharing.ProvidersAPI:
|
|
655
670
|
"""A data provider is an object representing the organization in the real world who shares the data."""
|
|
656
671
|
return self._providers
|
|
657
672
|
|
|
658
673
|
@property
|
|
659
|
-
def quality_monitors(self) ->
|
|
674
|
+
def quality_monitors(self) -> pkg_catalog.QualityMonitorsAPI:
|
|
660
675
|
"""A monitor computes and monitors data or model quality metrics for a table over time."""
|
|
661
676
|
return self._quality_monitors
|
|
662
677
|
|
|
663
678
|
@property
|
|
664
|
-
def queries(self) ->
|
|
679
|
+
def queries(self) -> pkg_sql.QueriesAPI:
|
|
665
680
|
"""The queries API can be used to perform CRUD operations on queries."""
|
|
666
681
|
return self._queries
|
|
667
682
|
|
|
668
683
|
@property
|
|
669
|
-
def queries_legacy(self) ->
|
|
684
|
+
def queries_legacy(self) -> pkg_sql.QueriesLegacyAPI:
|
|
670
685
|
"""These endpoints are used for CRUD operations on query definitions."""
|
|
671
686
|
return self._queries_legacy
|
|
672
687
|
|
|
673
688
|
@property
|
|
674
|
-
def query_execution(self) ->
|
|
689
|
+
def query_execution(self) -> pkg_dashboards.QueryExecutionAPI:
|
|
675
690
|
"""Query execution APIs for AI / BI Dashboards."""
|
|
676
691
|
return self._query_execution
|
|
677
692
|
|
|
678
693
|
@property
|
|
679
|
-
def query_history(self) ->
|
|
694
|
+
def query_history(self) -> pkg_sql.QueryHistoryAPI:
|
|
680
695
|
"""A service responsible for storing and retrieving the list of queries run against SQL endpoints and serverless compute."""
|
|
681
696
|
return self._query_history
|
|
682
697
|
|
|
683
698
|
@property
|
|
684
|
-
def query_visualizations(self) ->
|
|
699
|
+
def query_visualizations(self) -> pkg_sql.QueryVisualizationsAPI:
|
|
685
700
|
"""This is an evolving API that facilitates the addition and removal of visualizations from existing queries in the Databricks Workspace."""
|
|
686
701
|
return self._query_visualizations
|
|
687
702
|
|
|
688
703
|
@property
|
|
689
|
-
def query_visualizations_legacy(self) ->
|
|
704
|
+
def query_visualizations_legacy(self) -> pkg_sql.QueryVisualizationsLegacyAPI:
|
|
690
705
|
"""This is an evolving API that facilitates the addition and removal of vizualisations from existing queries within the Databricks Workspace."""
|
|
691
706
|
return self._query_visualizations_legacy
|
|
692
707
|
|
|
693
708
|
@property
|
|
694
|
-
def recipient_activation(self) ->
|
|
709
|
+
def recipient_activation(self) -> pkg_sharing.RecipientActivationAPI:
|
|
695
710
|
"""The Recipient Activation API is only applicable in the open sharing model where the recipient object has the authentication type of `TOKEN`."""
|
|
696
711
|
return self._recipient_activation
|
|
697
712
|
|
|
698
713
|
@property
|
|
699
|
-
def recipient_federation_policies(self) ->
|
|
714
|
+
def recipient_federation_policies(self) -> pkg_sharing.RecipientFederationPoliciesAPI:
|
|
700
715
|
"""The Recipient Federation Policies APIs are only applicable in the open sharing model where the recipient object has the authentication type of `OIDC_RECIPIENT`, enabling data sharing from Databricks to non-Databricks recipients."""
|
|
701
716
|
return self._recipient_federation_policies
|
|
702
717
|
|
|
703
718
|
@property
|
|
704
|
-
def recipients(self) ->
|
|
719
|
+
def recipients(self) -> pkg_sharing.RecipientsAPI:
|
|
705
720
|
"""A recipient is an object you create using :method:recipients/create to represent an organization which you want to allow access shares."""
|
|
706
721
|
return self._recipients
|
|
707
722
|
|
|
708
723
|
@property
|
|
709
|
-
def redash_config(self) ->
|
|
724
|
+
def redash_config(self) -> pkg_sql.RedashConfigAPI:
|
|
710
725
|
"""Redash V2 service for workspace configurations (internal)."""
|
|
711
726
|
return self._redash_config
|
|
712
727
|
|
|
713
728
|
@property
|
|
714
|
-
def registered_models(self) ->
|
|
729
|
+
def registered_models(self) -> pkg_catalog.RegisteredModelsAPI:
|
|
715
730
|
"""Databricks provides a hosted version of MLflow Model Registry in Unity Catalog."""
|
|
716
731
|
return self._registered_models
|
|
717
732
|
|
|
718
733
|
@property
|
|
719
|
-
def repos(self) ->
|
|
734
|
+
def repos(self) -> pkg_workspace.ReposAPI:
|
|
720
735
|
"""The Repos API allows users to manage their git repos."""
|
|
721
736
|
return self._repos
|
|
722
737
|
|
|
723
738
|
@property
|
|
724
|
-
def resource_quotas(self) ->
|
|
739
|
+
def resource_quotas(self) -> pkg_catalog.ResourceQuotasAPI:
|
|
725
740
|
"""Unity Catalog enforces resource quotas on all securable objects, which limits the number of resources that can be created."""
|
|
726
741
|
return self._resource_quotas
|
|
727
742
|
|
|
728
743
|
@property
|
|
729
|
-
def schemas(self) ->
|
|
744
|
+
def schemas(self) -> pkg_catalog.SchemasAPI:
|
|
730
745
|
"""A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace."""
|
|
731
746
|
return self._schemas
|
|
732
747
|
|
|
733
748
|
@property
|
|
734
|
-
def secrets(self) ->
|
|
749
|
+
def secrets(self) -> pkg_workspace.SecretsAPI:
|
|
735
750
|
"""The Secrets API allows you to manage secrets, secret scopes, and access permissions."""
|
|
736
751
|
return self._secrets
|
|
737
752
|
|
|
738
753
|
@property
|
|
739
|
-
def service_principals(self) ->
|
|
754
|
+
def service_principals(self) -> pkg_iam.ServicePrincipalsAPI:
|
|
740
755
|
"""Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD platforms."""
|
|
741
756
|
return self._service_principals
|
|
742
757
|
|
|
@@ -746,82 +761,82 @@ class WorkspaceClient:
|
|
|
746
761
|
return self._serving_endpoints
|
|
747
762
|
|
|
748
763
|
@property
|
|
749
|
-
def serving_endpoints_data_plane(self) ->
|
|
764
|
+
def serving_endpoints_data_plane(self) -> pkg_serving.ServingEndpointsDataPlaneAPI:
|
|
750
765
|
"""Serving endpoints DataPlane provides a set of operations to interact with data plane endpoints for Serving endpoints service."""
|
|
751
766
|
return self._serving_endpoints_data_plane
|
|
752
767
|
|
|
753
768
|
@property
|
|
754
|
-
def settings(self) ->
|
|
769
|
+
def settings(self) -> pkg_settings.SettingsAPI:
|
|
755
770
|
"""Workspace Settings API allows users to manage settings at the workspace level."""
|
|
756
771
|
return self._settings
|
|
757
772
|
|
|
758
773
|
@property
|
|
759
|
-
def shares(self) ->
|
|
774
|
+
def shares(self) -> pkg_sharing.SharesAPI:
|
|
760
775
|
"""A share is a container instantiated with :method:shares/create."""
|
|
761
776
|
return self._shares
|
|
762
777
|
|
|
763
778
|
@property
|
|
764
|
-
def statement_execution(self) ->
|
|
779
|
+
def statement_execution(self) -> pkg_sql.StatementExecutionAPI:
|
|
765
780
|
"""The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL warehouse and fetch the result."""
|
|
766
781
|
return self._statement_execution
|
|
767
782
|
|
|
768
783
|
@property
|
|
769
|
-
def storage_credentials(self) ->
|
|
784
|
+
def storage_credentials(self) -> pkg_catalog.StorageCredentialsAPI:
|
|
770
785
|
"""A storage credential represents an authentication and authorization mechanism for accessing data stored on your cloud tenant."""
|
|
771
786
|
return self._storage_credentials
|
|
772
787
|
|
|
773
788
|
@property
|
|
774
|
-
def system_schemas(self) ->
|
|
789
|
+
def system_schemas(self) -> pkg_catalog.SystemSchemasAPI:
|
|
775
790
|
"""A system schema is a schema that lives within the system catalog."""
|
|
776
791
|
return self._system_schemas
|
|
777
792
|
|
|
778
793
|
@property
|
|
779
|
-
def table_constraints(self) ->
|
|
794
|
+
def table_constraints(self) -> pkg_catalog.TableConstraintsAPI:
|
|
780
795
|
"""Primary key and foreign key constraints encode relationships between fields in tables."""
|
|
781
796
|
return self._table_constraints
|
|
782
797
|
|
|
783
798
|
@property
|
|
784
|
-
def tables(self) ->
|
|
799
|
+
def tables(self) -> pkg_catalog.TablesAPI:
|
|
785
800
|
"""A table resides in the third layer of Unity Catalog’s three-level namespace."""
|
|
786
801
|
return self._tables
|
|
787
802
|
|
|
788
803
|
@property
|
|
789
|
-
def temporary_table_credentials(self) ->
|
|
804
|
+
def temporary_table_credentials(self) -> pkg_catalog.TemporaryTableCredentialsAPI:
|
|
790
805
|
"""Temporary Table Credentials refer to short-lived, downscoped credentials used to access cloud storage locationswhere table data is stored in Databricks."""
|
|
791
806
|
return self._temporary_table_credentials
|
|
792
807
|
|
|
793
808
|
@property
|
|
794
|
-
def token_management(self) ->
|
|
809
|
+
def token_management(self) -> pkg_settings.TokenManagementAPI:
|
|
795
810
|
"""Enables administrators to get all tokens and delete tokens for other users."""
|
|
796
811
|
return self._token_management
|
|
797
812
|
|
|
798
813
|
@property
|
|
799
|
-
def tokens(self) ->
|
|
814
|
+
def tokens(self) -> pkg_settings.TokensAPI:
|
|
800
815
|
"""The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs."""
|
|
801
816
|
return self._tokens
|
|
802
817
|
|
|
803
818
|
@property
|
|
804
|
-
def users(self) ->
|
|
819
|
+
def users(self) -> pkg_iam.UsersAPI:
|
|
805
820
|
"""User identities recognized by Databricks and represented by email addresses."""
|
|
806
821
|
return self._users
|
|
807
822
|
|
|
808
823
|
@property
|
|
809
|
-
def vector_search_endpoints(self) ->
|
|
824
|
+
def vector_search_endpoints(self) -> pkg_vectorsearch.VectorSearchEndpointsAPI:
|
|
810
825
|
"""**Endpoint**: Represents the compute resources to host vector search indexes."""
|
|
811
826
|
return self._vector_search_endpoints
|
|
812
827
|
|
|
813
828
|
@property
|
|
814
|
-
def vector_search_indexes(self) ->
|
|
829
|
+
def vector_search_indexes(self) -> pkg_vectorsearch.VectorSearchIndexesAPI:
|
|
815
830
|
"""**Index**: An efficient representation of your embedding vectors that supports real-time and efficient approximate nearest neighbor (ANN) search queries."""
|
|
816
831
|
return self._vector_search_indexes
|
|
817
832
|
|
|
818
833
|
@property
|
|
819
|
-
def volumes(self) ->
|
|
834
|
+
def volumes(self) -> pkg_catalog.VolumesAPI:
|
|
820
835
|
"""Volumes are a Unity Catalog (UC) capability for accessing, storing, governing, organizing and processing files."""
|
|
821
836
|
return self._volumes
|
|
822
837
|
|
|
823
838
|
@property
|
|
824
|
-
def warehouses(self) ->
|
|
839
|
+
def warehouses(self) -> pkg_sql.WarehousesAPI:
|
|
825
840
|
"""A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL."""
|
|
826
841
|
return self._warehouses
|
|
827
842
|
|
|
@@ -831,17 +846,17 @@ class WorkspaceClient:
|
|
|
831
846
|
return self._workspace
|
|
832
847
|
|
|
833
848
|
@property
|
|
834
|
-
def workspace_bindings(self) ->
|
|
849
|
+
def workspace_bindings(self) -> pkg_catalog.WorkspaceBindingsAPI:
|
|
835
850
|
"""A securable in Databricks can be configured as __OPEN__ or __ISOLATED__."""
|
|
836
851
|
return self._workspace_bindings
|
|
837
852
|
|
|
838
853
|
@property
|
|
839
|
-
def workspace_conf(self) ->
|
|
854
|
+
def workspace_conf(self) -> pkg_settings.WorkspaceConfAPI:
|
|
840
855
|
"""This API allows updating known workspace settings for advanced users."""
|
|
841
856
|
return self._workspace_conf
|
|
842
857
|
|
|
843
858
|
@property
|
|
844
|
-
def forecasting(self) ->
|
|
859
|
+
def forecasting(self) -> pkg_ml.ForecastingAPI:
|
|
845
860
|
"""The Forecasting API allows you to create and get serverless forecasting experiments."""
|
|
846
861
|
return self._forecasting
|
|
847
862
|
|
|
@@ -919,37 +934,37 @@ class AccountClient:
|
|
|
919
934
|
)
|
|
920
935
|
self._config = config.copy()
|
|
921
936
|
self._api_client = client.ApiClient(self._config)
|
|
922
|
-
self._access_control =
|
|
923
|
-
self._billable_usage =
|
|
924
|
-
self._budget_policy =
|
|
925
|
-
self._credentials =
|
|
926
|
-
self._custom_app_integration =
|
|
927
|
-
self._encryption_keys =
|
|
928
|
-
self._federation_policy =
|
|
929
|
-
self._groups =
|
|
930
|
-
self._ip_access_lists =
|
|
931
|
-
self._log_delivery =
|
|
932
|
-
self._metastore_assignments =
|
|
933
|
-
self._metastores =
|
|
934
|
-
self._network_connectivity =
|
|
935
|
-
self._network_policies =
|
|
936
|
-
self._networks =
|
|
937
|
-
self._o_auth_published_apps =
|
|
938
|
-
self._private_access =
|
|
939
|
-
self._published_app_integration =
|
|
940
|
-
self._service_principal_federation_policy =
|
|
941
|
-
self._service_principal_secrets =
|
|
942
|
-
self._service_principals =
|
|
943
|
-
self._settings =
|
|
944
|
-
self._storage =
|
|
945
|
-
self._storage_credentials =
|
|
946
|
-
self._usage_dashboards =
|
|
947
|
-
self._users =
|
|
948
|
-
self._vpc_endpoints =
|
|
949
|
-
self._workspace_assignment =
|
|
950
|
-
self._workspace_network_configuration =
|
|
951
|
-
self._workspaces =
|
|
952
|
-
self._budgets =
|
|
937
|
+
self._access_control = pkg_iam.AccountAccessControlAPI(self._api_client)
|
|
938
|
+
self._billable_usage = pkg_billing.BillableUsageAPI(self._api_client)
|
|
939
|
+
self._budget_policy = pkg_billing.BudgetPolicyAPI(self._api_client)
|
|
940
|
+
self._credentials = pkg_provisioning.CredentialsAPI(self._api_client)
|
|
941
|
+
self._custom_app_integration = pkg_oauth2.CustomAppIntegrationAPI(self._api_client)
|
|
942
|
+
self._encryption_keys = pkg_provisioning.EncryptionKeysAPI(self._api_client)
|
|
943
|
+
self._federation_policy = pkg_oauth2.AccountFederationPolicyAPI(self._api_client)
|
|
944
|
+
self._groups = pkg_iam.AccountGroupsAPI(self._api_client)
|
|
945
|
+
self._ip_access_lists = pkg_settings.AccountIpAccessListsAPI(self._api_client)
|
|
946
|
+
self._log_delivery = pkg_billing.LogDeliveryAPI(self._api_client)
|
|
947
|
+
self._metastore_assignments = pkg_catalog.AccountMetastoreAssignmentsAPI(self._api_client)
|
|
948
|
+
self._metastores = pkg_catalog.AccountMetastoresAPI(self._api_client)
|
|
949
|
+
self._network_connectivity = pkg_settings.NetworkConnectivityAPI(self._api_client)
|
|
950
|
+
self._network_policies = pkg_settings.NetworkPoliciesAPI(self._api_client)
|
|
951
|
+
self._networks = pkg_provisioning.NetworksAPI(self._api_client)
|
|
952
|
+
self._o_auth_published_apps = pkg_oauth2.OAuthPublishedAppsAPI(self._api_client)
|
|
953
|
+
self._private_access = pkg_provisioning.PrivateAccessAPI(self._api_client)
|
|
954
|
+
self._published_app_integration = pkg_oauth2.PublishedAppIntegrationAPI(self._api_client)
|
|
955
|
+
self._service_principal_federation_policy = pkg_oauth2.ServicePrincipalFederationPolicyAPI(self._api_client)
|
|
956
|
+
self._service_principal_secrets = pkg_oauth2.ServicePrincipalSecretsAPI(self._api_client)
|
|
957
|
+
self._service_principals = pkg_iam.AccountServicePrincipalsAPI(self._api_client)
|
|
958
|
+
self._settings = pkg_settings.AccountSettingsAPI(self._api_client)
|
|
959
|
+
self._storage = pkg_provisioning.StorageAPI(self._api_client)
|
|
960
|
+
self._storage_credentials = pkg_catalog.AccountStorageCredentialsAPI(self._api_client)
|
|
961
|
+
self._usage_dashboards = pkg_billing.UsageDashboardsAPI(self._api_client)
|
|
962
|
+
self._users = pkg_iam.AccountUsersAPI(self._api_client)
|
|
963
|
+
self._vpc_endpoints = pkg_provisioning.VpcEndpointsAPI(self._api_client)
|
|
964
|
+
self._workspace_assignment = pkg_iam.WorkspaceAssignmentAPI(self._api_client)
|
|
965
|
+
self._workspace_network_configuration = pkg_settings.WorkspaceNetworkConfigurationAPI(self._api_client)
|
|
966
|
+
self._workspaces = pkg_provisioning.WorkspacesAPI(self._api_client)
|
|
967
|
+
self._budgets = pkg_billing.BudgetsAPI(self._api_client)
|
|
953
968
|
|
|
954
969
|
@property
|
|
955
970
|
def config(self) -> client.Config:
|
|
@@ -960,157 +975,157 @@ class AccountClient:
|
|
|
960
975
|
return self._api_client
|
|
961
976
|
|
|
962
977
|
@property
|
|
963
|
-
def access_control(self) ->
|
|
978
|
+
def access_control(self) -> pkg_iam.AccountAccessControlAPI:
|
|
964
979
|
"""These APIs manage access rules on resources in an account."""
|
|
965
980
|
return self._access_control
|
|
966
981
|
|
|
967
982
|
@property
|
|
968
|
-
def billable_usage(self) ->
|
|
983
|
+
def billable_usage(self) -> pkg_billing.BillableUsageAPI:
|
|
969
984
|
"""This API allows you to download billable usage logs for the specified account and date range."""
|
|
970
985
|
return self._billable_usage
|
|
971
986
|
|
|
972
987
|
@property
|
|
973
|
-
def budget_policy(self) ->
|
|
988
|
+
def budget_policy(self) -> pkg_billing.BudgetPolicyAPI:
|
|
974
989
|
"""A service serves REST API about Budget policies."""
|
|
975
990
|
return self._budget_policy
|
|
976
991
|
|
|
977
992
|
@property
|
|
978
|
-
def credentials(self) ->
|
|
993
|
+
def credentials(self) -> pkg_provisioning.CredentialsAPI:
|
|
979
994
|
"""These APIs manage credential configurations for this workspace."""
|
|
980
995
|
return self._credentials
|
|
981
996
|
|
|
982
997
|
@property
|
|
983
|
-
def custom_app_integration(self) ->
|
|
998
|
+
def custom_app_integration(self) -> pkg_oauth2.CustomAppIntegrationAPI:
|
|
984
999
|
"""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."""
|
|
985
1000
|
return self._custom_app_integration
|
|
986
1001
|
|
|
987
1002
|
@property
|
|
988
|
-
def encryption_keys(self) ->
|
|
1003
|
+
def encryption_keys(self) -> pkg_provisioning.EncryptionKeysAPI:
|
|
989
1004
|
"""These APIs manage encryption key configurations for this workspace (optional)."""
|
|
990
1005
|
return self._encryption_keys
|
|
991
1006
|
|
|
992
1007
|
@property
|
|
993
|
-
def federation_policy(self) ->
|
|
1008
|
+
def federation_policy(self) -> pkg_oauth2.AccountFederationPolicyAPI:
|
|
994
1009
|
"""These APIs manage account federation policies."""
|
|
995
1010
|
return self._federation_policy
|
|
996
1011
|
|
|
997
1012
|
@property
|
|
998
|
-
def groups(self) ->
|
|
1013
|
+
def groups(self) -> pkg_iam.AccountGroupsAPI:
|
|
999
1014
|
"""Groups simplify identity management, making it easier to assign access to Databricks account, data, and other securable objects."""
|
|
1000
1015
|
return self._groups
|
|
1001
1016
|
|
|
1002
1017
|
@property
|
|
1003
|
-
def ip_access_lists(self) ->
|
|
1018
|
+
def ip_access_lists(self) -> pkg_settings.AccountIpAccessListsAPI:
|
|
1004
1019
|
"""The Accounts IP Access List API enables account admins to configure IP access lists for access to the account console."""
|
|
1005
1020
|
return self._ip_access_lists
|
|
1006
1021
|
|
|
1007
1022
|
@property
|
|
1008
|
-
def log_delivery(self) ->
|
|
1023
|
+
def log_delivery(self) -> pkg_billing.LogDeliveryAPI:
|
|
1009
1024
|
"""These APIs manage log delivery configurations for this account."""
|
|
1010
1025
|
return self._log_delivery
|
|
1011
1026
|
|
|
1012
1027
|
@property
|
|
1013
|
-
def metastore_assignments(self) ->
|
|
1028
|
+
def metastore_assignments(self) -> pkg_catalog.AccountMetastoreAssignmentsAPI:
|
|
1014
1029
|
"""These APIs manage metastore assignments to a workspace."""
|
|
1015
1030
|
return self._metastore_assignments
|
|
1016
1031
|
|
|
1017
1032
|
@property
|
|
1018
|
-
def metastores(self) ->
|
|
1033
|
+
def metastores(self) -> pkg_catalog.AccountMetastoresAPI:
|
|
1019
1034
|
"""These APIs manage Unity Catalog metastores for an account."""
|
|
1020
1035
|
return self._metastores
|
|
1021
1036
|
|
|
1022
1037
|
@property
|
|
1023
|
-
def network_connectivity(self) ->
|
|
1038
|
+
def network_connectivity(self) -> pkg_settings.NetworkConnectivityAPI:
|
|
1024
1039
|
"""These APIs provide configurations for the network connectivity of your workspaces for serverless compute resources."""
|
|
1025
1040
|
return self._network_connectivity
|
|
1026
1041
|
|
|
1027
1042
|
@property
|
|
1028
|
-
def network_policies(self) ->
|
|
1043
|
+
def network_policies(self) -> pkg_settings.NetworkPoliciesAPI:
|
|
1029
1044
|
"""These APIs manage network policies for this account."""
|
|
1030
1045
|
return self._network_policies
|
|
1031
1046
|
|
|
1032
1047
|
@property
|
|
1033
|
-
def networks(self) ->
|
|
1048
|
+
def networks(self) -> pkg_provisioning.NetworksAPI:
|
|
1034
1049
|
"""These APIs manage network configurations for customer-managed VPCs (optional)."""
|
|
1035
1050
|
return self._networks
|
|
1036
1051
|
|
|
1037
1052
|
@property
|
|
1038
|
-
def o_auth_published_apps(self) ->
|
|
1053
|
+
def o_auth_published_apps(self) -> pkg_oauth2.OAuthPublishedAppsAPI:
|
|
1039
1054
|
"""These APIs enable administrators to view all the available published OAuth applications in Databricks."""
|
|
1040
1055
|
return self._o_auth_published_apps
|
|
1041
1056
|
|
|
1042
1057
|
@property
|
|
1043
|
-
def private_access(self) ->
|
|
1058
|
+
def private_access(self) -> pkg_provisioning.PrivateAccessAPI:
|
|
1044
1059
|
"""These APIs manage private access settings for this account."""
|
|
1045
1060
|
return self._private_access
|
|
1046
1061
|
|
|
1047
1062
|
@property
|
|
1048
|
-
def published_app_integration(self) ->
|
|
1063
|
+
def published_app_integration(self) -> pkg_oauth2.PublishedAppIntegrationAPI:
|
|
1049
1064
|
"""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."""
|
|
1050
1065
|
return self._published_app_integration
|
|
1051
1066
|
|
|
1052
1067
|
@property
|
|
1053
|
-
def service_principal_federation_policy(self) ->
|
|
1068
|
+
def service_principal_federation_policy(self) -> pkg_oauth2.ServicePrincipalFederationPolicyAPI:
|
|
1054
1069
|
"""These APIs manage service principal federation policies."""
|
|
1055
1070
|
return self._service_principal_federation_policy
|
|
1056
1071
|
|
|
1057
1072
|
@property
|
|
1058
|
-
def service_principal_secrets(self) ->
|
|
1073
|
+
def service_principal_secrets(self) -> pkg_oauth2.ServicePrincipalSecretsAPI:
|
|
1059
1074
|
"""These APIs enable administrators to manage service principal secrets."""
|
|
1060
1075
|
return self._service_principal_secrets
|
|
1061
1076
|
|
|
1062
1077
|
@property
|
|
1063
|
-
def service_principals(self) ->
|
|
1078
|
+
def service_principals(self) -> pkg_iam.AccountServicePrincipalsAPI:
|
|
1064
1079
|
"""Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD platforms."""
|
|
1065
1080
|
return self._service_principals
|
|
1066
1081
|
|
|
1067
1082
|
@property
|
|
1068
|
-
def settings(self) ->
|
|
1083
|
+
def settings(self) -> pkg_settings.AccountSettingsAPI:
|
|
1069
1084
|
"""Accounts Settings API allows users to manage settings at the account level."""
|
|
1070
1085
|
return self._settings
|
|
1071
1086
|
|
|
1072
1087
|
@property
|
|
1073
|
-
def storage(self) ->
|
|
1088
|
+
def storage(self) -> pkg_provisioning.StorageAPI:
|
|
1074
1089
|
"""These APIs manage storage configurations for this workspace."""
|
|
1075
1090
|
return self._storage
|
|
1076
1091
|
|
|
1077
1092
|
@property
|
|
1078
|
-
def storage_credentials(self) ->
|
|
1093
|
+
def storage_credentials(self) -> pkg_catalog.AccountStorageCredentialsAPI:
|
|
1079
1094
|
"""These APIs manage storage credentials for a particular metastore."""
|
|
1080
1095
|
return self._storage_credentials
|
|
1081
1096
|
|
|
1082
1097
|
@property
|
|
1083
|
-
def usage_dashboards(self) ->
|
|
1098
|
+
def usage_dashboards(self) -> pkg_billing.UsageDashboardsAPI:
|
|
1084
1099
|
"""These APIs manage usage dashboards for this account."""
|
|
1085
1100
|
return self._usage_dashboards
|
|
1086
1101
|
|
|
1087
1102
|
@property
|
|
1088
|
-
def users(self) ->
|
|
1103
|
+
def users(self) -> pkg_iam.AccountUsersAPI:
|
|
1089
1104
|
"""User identities recognized by Databricks and represented by email addresses."""
|
|
1090
1105
|
return self._users
|
|
1091
1106
|
|
|
1092
1107
|
@property
|
|
1093
|
-
def vpc_endpoints(self) ->
|
|
1108
|
+
def vpc_endpoints(self) -> pkg_provisioning.VpcEndpointsAPI:
|
|
1094
1109
|
"""These APIs manage VPC endpoint configurations for this account."""
|
|
1095
1110
|
return self._vpc_endpoints
|
|
1096
1111
|
|
|
1097
1112
|
@property
|
|
1098
|
-
def workspace_assignment(self) ->
|
|
1113
|
+
def workspace_assignment(self) -> pkg_iam.WorkspaceAssignmentAPI:
|
|
1099
1114
|
"""The Workspace Permission Assignment API allows you to manage workspace permissions for principals in your account."""
|
|
1100
1115
|
return self._workspace_assignment
|
|
1101
1116
|
|
|
1102
1117
|
@property
|
|
1103
|
-
def workspace_network_configuration(self) ->
|
|
1118
|
+
def workspace_network_configuration(self) -> pkg_settings.WorkspaceNetworkConfigurationAPI:
|
|
1104
1119
|
"""These APIs allow configuration of network settings for Databricks workspaces."""
|
|
1105
1120
|
return self._workspace_network_configuration
|
|
1106
1121
|
|
|
1107
1122
|
@property
|
|
1108
|
-
def workspaces(self) ->
|
|
1123
|
+
def workspaces(self) -> pkg_provisioning.WorkspacesAPI:
|
|
1109
1124
|
"""These APIs manage workspaces for this account."""
|
|
1110
1125
|
return self._workspaces
|
|
1111
1126
|
|
|
1112
1127
|
@property
|
|
1113
|
-
def budgets(self) ->
|
|
1128
|
+
def budgets(self) -> pkg_billing.BudgetsAPI:
|
|
1114
1129
|
"""These APIs manage budget configurations for this account."""
|
|
1115
1130
|
return self._budgets
|
|
1116
1131
|
|