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