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