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