databricks-sdk 0.56.0__py3-none-any.whl → 0.57.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.

Files changed (31) hide show
  1. databricks/sdk/__init__.py +15 -9
  2. databricks/sdk/service/aibuilder.py +157 -16
  3. databricks/sdk/service/apps.py +14 -42
  4. databricks/sdk/service/billing.py +17 -51
  5. databricks/sdk/service/catalog.py +198 -399
  6. databricks/sdk/service/cleanrooms.py +11 -33
  7. databricks/sdk/service/compute.py +63 -189
  8. databricks/sdk/service/dashboards.py +21 -63
  9. databricks/sdk/service/database.py +45 -30
  10. databricks/sdk/service/files.py +18 -54
  11. databricks/sdk/service/iam.py +55 -165
  12. databricks/sdk/service/jobs.py +232 -85
  13. databricks/sdk/service/marketplace.py +46 -146
  14. databricks/sdk/service/ml.py +455 -216
  15. databricks/sdk/service/oauth2.py +17 -45
  16. databricks/sdk/service/pipelines.py +81 -40
  17. databricks/sdk/service/provisioning.py +30 -90
  18. databricks/sdk/service/qualitymonitorv2.py +5 -15
  19. databricks/sdk/service/serving.py +30 -42
  20. databricks/sdk/service/settings.py +103 -314
  21. databricks/sdk/service/sharing.py +30 -86
  22. databricks/sdk/service/sql.py +74 -184
  23. databricks/sdk/service/vectorsearch.py +13 -43
  24. databricks/sdk/service/workspace.py +35 -105
  25. databricks/sdk/version.py +1 -1
  26. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/METADATA +1 -1
  27. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/RECORD +31 -31
  28. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/WHEEL +0 -0
  29. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/licenses/LICENSE +0 -0
  30. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/licenses/NOTICE +0 -0
  31. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/top_level.txt +0 -0
@@ -2544,7 +2544,6 @@ class EgressNetworkPolicyNetworkAccessPolicyStorageDestination:
2544
2544
  bucket_name: Optional[str] = None
2545
2545
 
2546
2546
  region: Optional[str] = None
2547
- """The region of the S3 bucket."""
2548
2547
 
2549
2548
  storage_destination_type: Optional[
2550
2549
  EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType
@@ -6750,9 +6749,7 @@ class AccountIpAccessListsAPI:
6750
6749
  def create(
6751
6750
  self, label: str, list_type: ListType, *, ip_addresses: Optional[List[str]] = None
6752
6751
  ) -> CreateIpAccessListResponse:
6753
- """Create access list.
6754
-
6755
- Creates an IP access list for the account.
6752
+ """Creates an IP access list for the account.
6756
6753
 
6757
6754
  A list can be an allow list or a block list. See the top of this file for a description of how the
6758
6755
  server treats allow lists and block lists at runtime.
@@ -6795,9 +6792,7 @@ class AccountIpAccessListsAPI:
6795
6792
  return CreateIpAccessListResponse.from_dict(res)
6796
6793
 
6797
6794
  def delete(self, ip_access_list_id: str):
6798
- """Delete access list.
6799
-
6800
- Deletes an IP access list, specified by its list ID.
6795
+ """Deletes an IP access list, specified by its list ID.
6801
6796
 
6802
6797
  :param ip_access_list_id: str
6803
6798
  The ID for the corresponding IP access list
@@ -6812,9 +6807,7 @@ class AccountIpAccessListsAPI:
6812
6807
  )
6813
6808
 
6814
6809
  def get(self, ip_access_list_id: str) -> GetIpAccessListResponse:
6815
- """Get IP access list.
6816
-
6817
- Gets an IP access list, specified by its list ID.
6810
+ """Gets an IP access list, specified by its list ID.
6818
6811
 
6819
6812
  :param ip_access_list_id: str
6820
6813
  The ID for the corresponding IP access list
@@ -6832,9 +6825,7 @@ class AccountIpAccessListsAPI:
6832
6825
  return GetIpAccessListResponse.from_dict(res)
6833
6826
 
6834
6827
  def list(self) -> Iterator[IpAccessListInfo]:
6835
- """Get access lists.
6836
-
6837
- Gets all IP access lists for the specified account.
6828
+ """Gets all IP access lists for the specified account.
6838
6829
 
6839
6830
  :returns: Iterator over :class:`IpAccessListInfo`
6840
6831
  """
@@ -6856,9 +6847,7 @@ class AccountIpAccessListsAPI:
6856
6847
  *,
6857
6848
  ip_addresses: Optional[List[str]] = None,
6858
6849
  ):
6859
- """Replace access list.
6860
-
6861
- Replaces an IP access list, specified by its ID.
6850
+ """Replaces an IP access list, specified by its ID.
6862
6851
 
6863
6852
  A list can include allow lists and block lists. See the top of this file for a description of how the
6864
6853
  server treats allow lists and block lists at run time. When replacing an IP access list: * For all
@@ -6912,9 +6901,7 @@ class AccountIpAccessListsAPI:
6912
6901
  label: Optional[str] = None,
6913
6902
  list_type: Optional[ListType] = None,
6914
6903
  ):
6915
- """Update access list.
6916
-
6917
- Updates an existing IP access list, specified by its ID.
6904
+ """Updates an existing IP access list, specified by its ID.
6918
6905
 
6919
6906
  A list can include allow lists and block lists. See the top of this file for a description of how the
6920
6907
  server treats allow lists and block lists at run time.
@@ -7022,9 +7009,7 @@ class AibiDashboardEmbeddingAccessPolicyAPI:
7022
7009
  self._api = api_client
7023
7010
 
7024
7011
  def delete(self, *, etag: Optional[str] = None) -> DeleteAibiDashboardEmbeddingAccessPolicySettingResponse:
7025
- """Delete the AI/BI dashboard embedding access policy.
7026
-
7027
- Delete the AI/BI dashboard embedding access policy, reverting back to the default.
7012
+ """Delete the AI/BI dashboard embedding access policy, reverting back to the default.
7028
7013
 
7029
7014
  :param etag: str (optional)
7030
7015
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7052,9 +7037,7 @@ class AibiDashboardEmbeddingAccessPolicyAPI:
7052
7037
  return DeleteAibiDashboardEmbeddingAccessPolicySettingResponse.from_dict(res)
7053
7038
 
7054
7039
  def get(self, *, etag: Optional[str] = None) -> AibiDashboardEmbeddingAccessPolicySetting:
7055
- """Retrieve the AI/BI dashboard embedding access policy.
7056
-
7057
- Retrieves the AI/BI dashboard embedding access policy. The default setting is ALLOW_APPROVED_DOMAINS,
7040
+ """Retrieves the AI/BI dashboard embedding access policy. The default setting is ALLOW_APPROVED_DOMAINS,
7058
7041
  permitting AI/BI dashboards to be embedded on approved domains.
7059
7042
 
7060
7043
  :param etag: str (optional)
@@ -7082,9 +7065,7 @@ class AibiDashboardEmbeddingAccessPolicyAPI:
7082
7065
  def update(
7083
7066
  self, allow_missing: bool, setting: AibiDashboardEmbeddingAccessPolicySetting, field_mask: str
7084
7067
  ) -> AibiDashboardEmbeddingAccessPolicySetting:
7085
- """Update the AI/BI dashboard embedding access policy.
7086
-
7087
- Updates the AI/BI dashboard embedding access policy at the workspace level.
7068
+ """Updates the AI/BI dashboard embedding access policy at the workspace level.
7088
7069
 
7089
7070
  :param allow_missing: bool
7090
7071
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -7128,9 +7109,7 @@ class AibiDashboardEmbeddingApprovedDomainsAPI:
7128
7109
  self._api = api_client
7129
7110
 
7130
7111
  def delete(self, *, etag: Optional[str] = None) -> DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse:
7131
- """Delete AI/BI dashboard embedding approved domains.
7132
-
7133
- Delete the list of domains approved to host embedded AI/BI dashboards, reverting back to the default
7112
+ """Delete the list of domains approved to host embedded AI/BI dashboards, reverting back to the default
7134
7113
  empty list.
7135
7114
 
7136
7115
  :param etag: str (optional)
@@ -7159,9 +7138,7 @@ class AibiDashboardEmbeddingApprovedDomainsAPI:
7159
7138
  return DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse.from_dict(res)
7160
7139
 
7161
7140
  def get(self, *, etag: Optional[str] = None) -> AibiDashboardEmbeddingApprovedDomainsSetting:
7162
- """Retrieve the list of domains approved to host embedded AI/BI dashboards.
7163
-
7164
- Retrieves the list of domains approved to host embedded AI/BI dashboards.
7141
+ """Retrieves the list of domains approved to host embedded AI/BI dashboards.
7165
7142
 
7166
7143
  :param etag: str (optional)
7167
7144
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7191,9 +7168,7 @@ class AibiDashboardEmbeddingApprovedDomainsAPI:
7191
7168
  def update(
7192
7169
  self, allow_missing: bool, setting: AibiDashboardEmbeddingApprovedDomainsSetting, field_mask: str
7193
7170
  ) -> AibiDashboardEmbeddingApprovedDomainsSetting:
7194
- """Update the list of domains approved to host embedded AI/BI dashboards.
7195
-
7196
- Updates the list of domains approved to host embedded AI/BI dashboards. This update will fail if the
7171
+ """Updates the list of domains approved to host embedded AI/BI dashboards. This update will fail if the
7197
7172
  current workspace access policy is not ALLOW_APPROVED_DOMAINS.
7198
7173
 
7199
7174
  :param allow_missing: bool
@@ -7241,9 +7216,7 @@ class AutomaticClusterUpdateAPI:
7241
7216
  self._api = api_client
7242
7217
 
7243
7218
  def get(self, *, etag: Optional[str] = None) -> AutomaticClusterUpdateSetting:
7244
- """Get the automatic cluster update setting.
7245
-
7246
- Gets the automatic cluster update setting.
7219
+ """Gets the automatic cluster update setting.
7247
7220
 
7248
7221
  :param etag: str (optional)
7249
7222
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7270,9 +7243,7 @@ class AutomaticClusterUpdateAPI:
7270
7243
  def update(
7271
7244
  self, allow_missing: bool, setting: AutomaticClusterUpdateSetting, field_mask: str
7272
7245
  ) -> AutomaticClusterUpdateSetting:
7273
- """Update the automatic cluster update setting.
7274
-
7275
- Updates the automatic cluster update setting for the workspace. A fresh etag needs to be provided in
7246
+ """Updates the automatic cluster update setting for the workspace. A fresh etag needs to be provided in
7276
7247
  `PATCH` requests (as part of the setting field). The etag can be retrieved by making a `GET` request
7277
7248
  before the `PATCH` request. If the setting is updated concurrently, `PATCH` fails with 409 and the
7278
7249
  request must be retried by using the fresh etag in the 409 response.
@@ -7321,9 +7292,7 @@ class ComplianceSecurityProfileAPI:
7321
7292
  self._api = api_client
7322
7293
 
7323
7294
  def get(self, *, etag: Optional[str] = None) -> ComplianceSecurityProfileSetting:
7324
- """Get the compliance security profile setting.
7325
-
7326
- Gets the compliance security profile setting.
7295
+ """Gets the compliance security profile setting.
7327
7296
 
7328
7297
  :param etag: str (optional)
7329
7298
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7350,9 +7319,7 @@ class ComplianceSecurityProfileAPI:
7350
7319
  def update(
7351
7320
  self, allow_missing: bool, setting: ComplianceSecurityProfileSetting, field_mask: str
7352
7321
  ) -> ComplianceSecurityProfileSetting:
7353
- """Update the compliance security profile setting.
7354
-
7355
- Updates the compliance security profile setting for the workspace. A fresh etag needs to be provided
7322
+ """Updates the compliance security profile setting for the workspace. A fresh etag needs to be provided
7356
7323
  in `PATCH` requests (as part of the setting field). The etag can be retrieved by making a `GET`
7357
7324
  request before the `PATCH` request. If the setting is updated concurrently, `PATCH` fails with 409 and
7358
7325
  the request must be retried by using the fresh etag in the 409 response.
@@ -7401,9 +7368,7 @@ class CredentialsManagerAPI:
7401
7368
  def exchange_token(
7402
7369
  self, partition_id: PartitionId, token_type: List[TokenType], scopes: List[str]
7403
7370
  ) -> ExchangeTokenResponse:
7404
- """Exchange token.
7405
-
7406
- Exchange tokens with an Identity Provider to get a new access token. It allows specifying scopes to
7371
+ """Exchange tokens with an Identity Provider to get a new access token. It allows specifying scopes to
7407
7372
  determine token permissions.
7408
7373
 
7409
7374
  :param partition_id: :class:`PartitionId`
@@ -7443,9 +7408,7 @@ class CspEnablementAccountAPI:
7443
7408
  self._api = api_client
7444
7409
 
7445
7410
  def get(self, *, etag: Optional[str] = None) -> CspEnablementAccountSetting:
7446
- """Get the compliance security profile setting for new workspaces.
7447
-
7448
- Gets the compliance security profile setting for new workspaces.
7411
+ """Gets the compliance security profile setting for new workspaces.
7449
7412
 
7450
7413
  :param etag: str (optional)
7451
7414
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7475,9 +7438,7 @@ class CspEnablementAccountAPI:
7475
7438
  def update(
7476
7439
  self, allow_missing: bool, setting: CspEnablementAccountSetting, field_mask: str
7477
7440
  ) -> CspEnablementAccountSetting:
7478
- """Update the compliance security profile setting for new workspaces.
7479
-
7480
- Updates the value of the compliance security profile setting for new workspaces.
7441
+ """Updates the value of the compliance security profile setting for new workspaces.
7481
7442
 
7482
7443
  :param allow_missing: bool
7483
7444
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -7525,9 +7486,7 @@ class DashboardEmailSubscriptionsAPI:
7525
7486
  self._api = api_client
7526
7487
 
7527
7488
  def delete(self, *, etag: Optional[str] = None) -> DeleteDashboardEmailSubscriptionsResponse:
7528
- """Delete the Dashboard Email Subscriptions setting.
7529
-
7530
- Reverts the Dashboard Email Subscriptions setting to its default value.
7489
+ """Reverts the Dashboard Email Subscriptions setting to its default value.
7531
7490
 
7532
7491
  :param etag: str (optional)
7533
7492
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7555,9 +7514,7 @@ class DashboardEmailSubscriptionsAPI:
7555
7514
  return DeleteDashboardEmailSubscriptionsResponse.from_dict(res)
7556
7515
 
7557
7516
  def get(self, *, etag: Optional[str] = None) -> DashboardEmailSubscriptions:
7558
- """Get the Dashboard Email Subscriptions setting.
7559
-
7560
- Gets the Dashboard Email Subscriptions setting.
7517
+ """Gets the Dashboard Email Subscriptions setting.
7561
7518
 
7562
7519
  :param etag: str (optional)
7563
7520
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7584,9 +7541,7 @@ class DashboardEmailSubscriptionsAPI:
7584
7541
  def update(
7585
7542
  self, allow_missing: bool, setting: DashboardEmailSubscriptions, field_mask: str
7586
7543
  ) -> DashboardEmailSubscriptions:
7587
- """Update the Dashboard Email Subscriptions setting.
7588
-
7589
- Updates the Dashboard Email Subscriptions setting.
7544
+ """Updates the Dashboard Email Subscriptions setting.
7590
7545
 
7591
7546
  :param allow_missing: bool
7592
7547
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -7638,9 +7593,7 @@ class DefaultNamespaceAPI:
7638
7593
  self._api = api_client
7639
7594
 
7640
7595
  def delete(self, *, etag: Optional[str] = None) -> DeleteDefaultNamespaceSettingResponse:
7641
- """Delete the default namespace setting.
7642
-
7643
- Deletes the default namespace setting for the workspace. A fresh etag needs to be provided in `DELETE`
7596
+ """Deletes the default namespace setting for the workspace. A fresh etag needs to be provided in `DELETE`
7644
7597
  requests (as a query parameter). The etag can be retrieved by making a `GET` request before the
7645
7598
  `DELETE` request. If the setting is updated/deleted concurrently, `DELETE` fails with 409 and the
7646
7599
  request must be retried by using the fresh etag in the 409 response.
@@ -7668,9 +7621,7 @@ class DefaultNamespaceAPI:
7668
7621
  return DeleteDefaultNamespaceSettingResponse.from_dict(res)
7669
7622
 
7670
7623
  def get(self, *, etag: Optional[str] = None) -> DefaultNamespaceSetting:
7671
- """Get the default namespace setting.
7672
-
7673
- Gets the default namespace setting.
7624
+ """Gets the default namespace setting.
7674
7625
 
7675
7626
  :param etag: str (optional)
7676
7627
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7695,9 +7646,7 @@ class DefaultNamespaceAPI:
7695
7646
  return DefaultNamespaceSetting.from_dict(res)
7696
7647
 
7697
7648
  def update(self, allow_missing: bool, setting: DefaultNamespaceSetting, field_mask: str) -> DefaultNamespaceSetting:
7698
- """Update the default namespace setting.
7699
-
7700
- Updates the default namespace setting for the workspace. A fresh etag needs to be provided in `PATCH`
7649
+ """Updates the default namespace setting for the workspace. A fresh etag needs to be provided in `PATCH`
7701
7650
  requests (as part of the setting field). The etag can be retrieved by making a `GET` request before
7702
7651
  the `PATCH` request. Note that if the setting does not exist, `GET` returns a NOT_FOUND error and the
7703
7652
  etag is present in the error response, which should be set in the `PATCH` request. If the setting is
@@ -7756,9 +7705,7 @@ class DisableLegacyAccessAPI:
7756
7705
  self._api = api_client
7757
7706
 
7758
7707
  def delete(self, *, etag: Optional[str] = None) -> DeleteDisableLegacyAccessResponse:
7759
- """Delete Legacy Access Disablement Status.
7760
-
7761
- Deletes legacy access disablement status.
7708
+ """Deletes legacy access disablement status.
7762
7709
 
7763
7710
  :param etag: str (optional)
7764
7711
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7783,9 +7730,7 @@ class DisableLegacyAccessAPI:
7783
7730
  return DeleteDisableLegacyAccessResponse.from_dict(res)
7784
7731
 
7785
7732
  def get(self, *, etag: Optional[str] = None) -> DisableLegacyAccess:
7786
- """Retrieve Legacy Access Disablement Status.
7787
-
7788
- Retrieves legacy access disablement Status.
7733
+ """Retrieves legacy access disablement Status.
7789
7734
 
7790
7735
  :param etag: str (optional)
7791
7736
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7810,9 +7755,7 @@ class DisableLegacyAccessAPI:
7810
7755
  return DisableLegacyAccess.from_dict(res)
7811
7756
 
7812
7757
  def update(self, allow_missing: bool, setting: DisableLegacyAccess, field_mask: str) -> DisableLegacyAccess:
7813
- """Update Legacy Access Disablement Status.
7814
-
7815
- Updates legacy access disablement status.
7758
+ """Updates legacy access disablement status.
7816
7759
 
7817
7760
  :param allow_missing: bool
7818
7761
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -7862,9 +7805,7 @@ class DisableLegacyDbfsAPI:
7862
7805
  self._api = api_client
7863
7806
 
7864
7807
  def delete(self, *, etag: Optional[str] = None) -> DeleteDisableLegacyDbfsResponse:
7865
- """Delete the disable legacy DBFS setting.
7866
-
7867
- Deletes the disable legacy DBFS setting for a workspace, reverting back to the default.
7808
+ """Deletes the disable legacy DBFS setting for a workspace, reverting back to the default.
7868
7809
 
7869
7810
  :param etag: str (optional)
7870
7811
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7889,9 +7830,7 @@ class DisableLegacyDbfsAPI:
7889
7830
  return DeleteDisableLegacyDbfsResponse.from_dict(res)
7890
7831
 
7891
7832
  def get(self, *, etag: Optional[str] = None) -> DisableLegacyDbfs:
7892
- """Get the disable legacy DBFS setting.
7893
-
7894
- Gets the disable legacy DBFS setting.
7833
+ """Gets the disable legacy DBFS setting.
7895
7834
 
7896
7835
  :param etag: str (optional)
7897
7836
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7916,9 +7855,7 @@ class DisableLegacyDbfsAPI:
7916
7855
  return DisableLegacyDbfs.from_dict(res)
7917
7856
 
7918
7857
  def update(self, allow_missing: bool, setting: DisableLegacyDbfs, field_mask: str) -> DisableLegacyDbfs:
7919
- """Update the disable legacy DBFS setting.
7920
-
7921
- Updates the disable legacy DBFS setting for the workspace.
7858
+ """Updates the disable legacy DBFS setting for the workspace.
7922
7859
 
7923
7860
  :param allow_missing: bool
7924
7861
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -7965,9 +7902,7 @@ class DisableLegacyFeaturesAPI:
7965
7902
  self._api = api_client
7966
7903
 
7967
7904
  def delete(self, *, etag: Optional[str] = None) -> DeleteDisableLegacyFeaturesResponse:
7968
- """Delete the disable legacy features setting.
7969
-
7970
- Deletes the disable legacy features setting.
7905
+ """Deletes the disable legacy features setting.
7971
7906
 
7972
7907
  :param etag: str (optional)
7973
7908
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7995,9 +7930,7 @@ class DisableLegacyFeaturesAPI:
7995
7930
  return DeleteDisableLegacyFeaturesResponse.from_dict(res)
7996
7931
 
7997
7932
  def get(self, *, etag: Optional[str] = None) -> DisableLegacyFeatures:
7998
- """Get the disable legacy features setting.
7999
-
8000
- Gets the value of the disable legacy features setting.
7933
+ """Gets the value of the disable legacy features setting.
8001
7934
 
8002
7935
  :param etag: str (optional)
8003
7936
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8025,9 +7958,7 @@ class DisableLegacyFeaturesAPI:
8025
7958
  return DisableLegacyFeatures.from_dict(res)
8026
7959
 
8027
7960
  def update(self, allow_missing: bool, setting: DisableLegacyFeatures, field_mask: str) -> DisableLegacyFeatures:
8028
- """Update the disable legacy features setting.
8029
-
8030
- Updates the value of the disable legacy features setting.
7961
+ """Updates the value of the disable legacy features setting.
8031
7962
 
8032
7963
  :param allow_missing: bool
8033
7964
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -8074,9 +8005,7 @@ class EnableExportNotebookAPI:
8074
8005
  self._api = api_client
8075
8006
 
8076
8007
  def get_enable_export_notebook(self) -> EnableExportNotebook:
8077
- """Get the Notebook and File exporting setting.
8078
-
8079
- Gets the Notebook and File exporting setting.
8008
+ """Gets the Notebook and File exporting setting.
8080
8009
 
8081
8010
  :returns: :class:`EnableExportNotebook`
8082
8011
  """
@@ -8091,9 +8020,7 @@ class EnableExportNotebookAPI:
8091
8020
  def patch_enable_export_notebook(
8092
8021
  self, allow_missing: bool, setting: EnableExportNotebook, field_mask: str
8093
8022
  ) -> EnableExportNotebook:
8094
- """Update the Notebook and File exporting setting.
8095
-
8096
- Updates the Notebook and File exporting setting. The model follows eventual consistency, which means
8023
+ """Updates the Notebook and File exporting setting. The model follows eventual consistency, which means
8097
8024
  the get after the update operation might receive stale values for some time.
8098
8025
 
8099
8026
  :param allow_missing: bool
@@ -8138,9 +8065,7 @@ class EnableIpAccessListsAPI:
8138
8065
  self._api = api_client
8139
8066
 
8140
8067
  def delete(self, *, etag: Optional[str] = None) -> DeleteAccountIpAccessEnableResponse:
8141
- """Delete the account IP access toggle setting.
8142
-
8143
- Reverts the value of the account IP access toggle setting to default (ON)
8068
+ """Reverts the value of the account IP access toggle setting to default (ON)
8144
8069
 
8145
8070
  :param etag: str (optional)
8146
8071
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8168,9 +8093,7 @@ class EnableIpAccessListsAPI:
8168
8093
  return DeleteAccountIpAccessEnableResponse.from_dict(res)
8169
8094
 
8170
8095
  def get(self, *, etag: Optional[str] = None) -> AccountIpAccessEnable:
8171
- """Get the account IP access toggle setting.
8172
-
8173
- Gets the value of the account IP access toggle setting.
8096
+ """Gets the value of the account IP access toggle setting.
8174
8097
 
8175
8098
  :param etag: str (optional)
8176
8099
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8198,9 +8121,7 @@ class EnableIpAccessListsAPI:
8198
8121
  return AccountIpAccessEnable.from_dict(res)
8199
8122
 
8200
8123
  def update(self, allow_missing: bool, setting: AccountIpAccessEnable, field_mask: str) -> AccountIpAccessEnable:
8201
- """Update the account IP access toggle setting.
8202
-
8203
- Updates the value of the account IP access toggle setting.
8124
+ """Updates the value of the account IP access toggle setting.
8204
8125
 
8205
8126
  :param allow_missing: bool
8206
8127
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -8247,9 +8168,7 @@ class EnableNotebookTableClipboardAPI:
8247
8168
  self._api = api_client
8248
8169
 
8249
8170
  def get_enable_notebook_table_clipboard(self) -> EnableNotebookTableClipboard:
8250
- """Get the Results Table Clipboard features setting.
8251
-
8252
- Gets the Results Table Clipboard features setting.
8171
+ """Gets the Results Table Clipboard features setting.
8253
8172
 
8254
8173
  :returns: :class:`EnableNotebookTableClipboard`
8255
8174
  """
@@ -8266,9 +8185,7 @@ class EnableNotebookTableClipboardAPI:
8266
8185
  def patch_enable_notebook_table_clipboard(
8267
8186
  self, allow_missing: bool, setting: EnableNotebookTableClipboard, field_mask: str
8268
8187
  ) -> EnableNotebookTableClipboard:
8269
- """Update the Results Table Clipboard features setting.
8270
-
8271
- Updates the Results Table Clipboard features setting. The model follows eventual consistency, which
8188
+ """Updates the Results Table Clipboard features setting. The model follows eventual consistency, which
8272
8189
  means the get after the update operation might receive stale values for some time.
8273
8190
 
8274
8191
  :param allow_missing: bool
@@ -8312,9 +8229,7 @@ class EnableResultsDownloadingAPI:
8312
8229
  self._api = api_client
8313
8230
 
8314
8231
  def get_enable_results_downloading(self) -> EnableResultsDownloading:
8315
- """Get the Notebook results download setting.
8316
-
8317
- Gets the Notebook results download setting.
8232
+ """Gets the Notebook results download setting.
8318
8233
 
8319
8234
  :returns: :class:`EnableResultsDownloading`
8320
8235
  """
@@ -8329,9 +8244,7 @@ class EnableResultsDownloadingAPI:
8329
8244
  def patch_enable_results_downloading(
8330
8245
  self, allow_missing: bool, setting: EnableResultsDownloading, field_mask: str
8331
8246
  ) -> EnableResultsDownloading:
8332
- """Update the Notebook results download setting.
8333
-
8334
- Updates the Notebook results download setting. The model follows eventual consistency, which means the
8247
+ """Updates the Notebook results download setting. The model follows eventual consistency, which means the
8335
8248
  get after the update operation might receive stale values for some time.
8336
8249
 
8337
8250
  :param allow_missing: bool
@@ -8380,9 +8293,7 @@ class EnhancedSecurityMonitoringAPI:
8380
8293
  self._api = api_client
8381
8294
 
8382
8295
  def get(self, *, etag: Optional[str] = None) -> EnhancedSecurityMonitoringSetting:
8383
- """Get the enhanced security monitoring setting.
8384
-
8385
- Gets the enhanced security monitoring setting.
8296
+ """Gets the enhanced security monitoring setting.
8386
8297
 
8387
8298
  :param etag: str (optional)
8388
8299
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8409,9 +8320,7 @@ class EnhancedSecurityMonitoringAPI:
8409
8320
  def update(
8410
8321
  self, allow_missing: bool, setting: EnhancedSecurityMonitoringSetting, field_mask: str
8411
8322
  ) -> EnhancedSecurityMonitoringSetting:
8412
- """Update the enhanced security monitoring setting.
8413
-
8414
- Updates the enhanced security monitoring setting for the workspace. A fresh etag needs to be provided
8323
+ """Updates the enhanced security monitoring setting for the workspace. A fresh etag needs to be provided
8415
8324
  in `PATCH` requests (as part of the setting field). The etag can be retrieved by making a `GET`
8416
8325
  request before the `PATCH` request. If the setting is updated concurrently, `PATCH` fails with 409 and
8417
8326
  the request must be retried by using the fresh etag in the 409 response.
@@ -8459,9 +8368,7 @@ class EsmEnablementAccountAPI:
8459
8368
  self._api = api_client
8460
8369
 
8461
8370
  def get(self, *, etag: Optional[str] = None) -> EsmEnablementAccountSetting:
8462
- """Get the enhanced security monitoring setting for new workspaces.
8463
-
8464
- Gets the enhanced security monitoring setting for new workspaces.
8371
+ """Gets the enhanced security monitoring setting for new workspaces.
8465
8372
 
8466
8373
  :param etag: str (optional)
8467
8374
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8491,9 +8398,7 @@ class EsmEnablementAccountAPI:
8491
8398
  def update(
8492
8399
  self, allow_missing: bool, setting: EsmEnablementAccountSetting, field_mask: str
8493
8400
  ) -> EsmEnablementAccountSetting:
8494
- """Update the enhanced security monitoring setting for new workspaces.
8495
-
8496
- Updates the value of the enhanced security monitoring setting for new workspaces.
8401
+ """Updates the value of the enhanced security monitoring setting for new workspaces.
8497
8402
 
8498
8403
  :param allow_missing: bool
8499
8404
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -8557,9 +8462,7 @@ class IpAccessListsAPI:
8557
8462
  def create(
8558
8463
  self, label: str, list_type: ListType, *, ip_addresses: Optional[List[str]] = None
8559
8464
  ) -> CreateIpAccessListResponse:
8560
- """Create access list.
8561
-
8562
- Creates an IP access list for this workspace.
8465
+ """Creates an IP access list for this workspace.
8563
8466
 
8564
8467
  A list can be an allow list or a block list. See the top of this file for a description of how the
8565
8468
  server treats allow lists and block lists at runtime.
@@ -8601,9 +8504,7 @@ class IpAccessListsAPI:
8601
8504
  return CreateIpAccessListResponse.from_dict(res)
8602
8505
 
8603
8506
  def delete(self, ip_access_list_id: str):
8604
- """Delete access list.
8605
-
8606
- Deletes an IP access list, specified by its list ID.
8507
+ """Deletes an IP access list, specified by its list ID.
8607
8508
 
8608
8509
  :param ip_access_list_id: str
8609
8510
  The ID for the corresponding IP access list
@@ -8616,9 +8517,7 @@ class IpAccessListsAPI:
8616
8517
  self._api.do("DELETE", f"/api/2.0/ip-access-lists/{ip_access_list_id}", headers=headers)
8617
8518
 
8618
8519
  def get(self, ip_access_list_id: str) -> FetchIpAccessListResponse:
8619
- """Get access list.
8620
-
8621
- Gets an IP access list, specified by its list ID.
8520
+ """Gets an IP access list, specified by its list ID.
8622
8521
 
8623
8522
  :param ip_access_list_id: str
8624
8523
  The ID for the corresponding IP access list
@@ -8634,9 +8533,7 @@ class IpAccessListsAPI:
8634
8533
  return FetchIpAccessListResponse.from_dict(res)
8635
8534
 
8636
8535
  def list(self) -> Iterator[IpAccessListInfo]:
8637
- """Get access lists.
8638
-
8639
- Gets all IP access lists for the specified workspace.
8536
+ """Gets all IP access lists for the specified workspace.
8640
8537
 
8641
8538
  :returns: Iterator over :class:`IpAccessListInfo`
8642
8539
  """
@@ -8658,9 +8555,7 @@ class IpAccessListsAPI:
8658
8555
  *,
8659
8556
  ip_addresses: Optional[List[str]] = None,
8660
8557
  ):
8661
- """Replace access list.
8662
-
8663
- Replaces an IP access list, specified by its ID.
8558
+ """Replaces an IP access list, specified by its ID.
8664
8559
 
8665
8560
  A list can include allow lists and block lists. See the top of this file for a description of how the
8666
8561
  server treats allow lists and block lists at run time. When replacing an IP access list: * For all
@@ -8710,9 +8605,7 @@ class IpAccessListsAPI:
8710
8605
  label: Optional[str] = None,
8711
8606
  list_type: Optional[ListType] = None,
8712
8607
  ):
8713
- """Update access list.
8714
-
8715
- Updates an existing IP access list, specified by its ID.
8608
+ """Updates an existing IP access list, specified by its ID.
8716
8609
 
8717
8610
  A list can include allow lists and block lists. See the top of this file for a description of how the
8718
8611
  server treats allow lists and block lists at run time.
@@ -8765,9 +8658,7 @@ class LlmProxyPartnerPoweredAccountAPI:
8765
8658
  self._api = api_client
8766
8659
 
8767
8660
  def get(self, *, etag: Optional[str] = None) -> LlmProxyPartnerPoweredAccount:
8768
- """Get the enable partner powered AI features account setting.
8769
-
8770
- Gets the enable partner powered AI features account setting.
8661
+ """Gets the enable partner powered AI features account setting.
8771
8662
 
8772
8663
  :param etag: str (optional)
8773
8664
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8797,9 +8688,7 @@ class LlmProxyPartnerPoweredAccountAPI:
8797
8688
  def update(
8798
8689
  self, allow_missing: bool, setting: LlmProxyPartnerPoweredAccount, field_mask: str
8799
8690
  ) -> LlmProxyPartnerPoweredAccount:
8800
- """Update the enable partner powered AI features account setting.
8801
-
8802
- Updates the enable partner powered AI features account setting.
8691
+ """Updates the enable partner powered AI features account setting.
8803
8692
 
8804
8693
  :param allow_missing: bool
8805
8694
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -8846,9 +8735,7 @@ class LlmProxyPartnerPoweredEnforceAPI:
8846
8735
  self._api = api_client
8847
8736
 
8848
8737
  def get(self, *, etag: Optional[str] = None) -> LlmProxyPartnerPoweredEnforce:
8849
- """Get the enforcement status of partner powered AI features account setting.
8850
-
8851
- Gets the enforcement status of partner powered AI features account setting.
8738
+ """Gets the enforcement status of partner powered AI features account setting.
8852
8739
 
8853
8740
  :param etag: str (optional)
8854
8741
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8878,9 +8765,7 @@ class LlmProxyPartnerPoweredEnforceAPI:
8878
8765
  def update(
8879
8766
  self, allow_missing: bool, setting: LlmProxyPartnerPoweredEnforce, field_mask: str
8880
8767
  ) -> LlmProxyPartnerPoweredEnforce:
8881
- """Update the enforcement status of partner powered AI features account setting.
8882
-
8883
- Updates the enable enforcement status of partner powered AI features account setting.
8768
+ """Updates the enable enforcement status of partner powered AI features account setting.
8884
8769
 
8885
8770
  :param allow_missing: bool
8886
8771
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -8926,9 +8811,7 @@ class LlmProxyPartnerPoweredWorkspaceAPI:
8926
8811
  self._api = api_client
8927
8812
 
8928
8813
  def delete(self, *, etag: Optional[str] = None) -> DeleteLlmProxyPartnerPoweredWorkspaceResponse:
8929
- """Delete the enable partner powered AI features workspace setting.
8930
-
8931
- Reverts the enable partner powered AI features workspace setting to its default value.
8814
+ """Reverts the enable partner powered AI features workspace setting to its default value.
8932
8815
 
8933
8816
  :param etag: str (optional)
8934
8817
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8953,9 +8836,7 @@ class LlmProxyPartnerPoweredWorkspaceAPI:
8953
8836
  return DeleteLlmProxyPartnerPoweredWorkspaceResponse.from_dict(res)
8954
8837
 
8955
8838
  def get(self, *, etag: Optional[str] = None) -> LlmProxyPartnerPoweredWorkspace:
8956
- """Get the enable partner powered AI features workspace setting.
8957
-
8958
- Gets the enable partner powered AI features workspace setting.
8839
+ """Gets the enable partner powered AI features workspace setting.
8959
8840
 
8960
8841
  :param etag: str (optional)
8961
8842
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8982,9 +8863,7 @@ class LlmProxyPartnerPoweredWorkspaceAPI:
8982
8863
  def update(
8983
8864
  self, allow_missing: bool, setting: LlmProxyPartnerPoweredWorkspace, field_mask: str
8984
8865
  ) -> LlmProxyPartnerPoweredWorkspace:
8985
- """Update the enable partner powered AI features workspace setting.
8986
-
8987
- Updates the enable partner powered AI features workspace setting.
8866
+ """Updates the enable partner powered AI features workspace setting.
8988
8867
 
8989
8868
  :param allow_missing: bool
8990
8869
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -9036,9 +8915,7 @@ class NetworkConnectivityAPI:
9036
8915
  def create_network_connectivity_configuration(
9037
8916
  self, network_connectivity_config: CreateNetworkConnectivityConfiguration
9038
8917
  ) -> NetworkConnectivityConfiguration:
9039
- """Create a network connectivity configuration.
9040
-
9041
- Creates a network connectivity configuration (NCC), which provides stable Azure service subnets when
8918
+ """Creates a network connectivity configuration (NCC), which provides stable Azure service subnets when
9042
8919
  accessing your Azure Storage accounts. You can also use a network connectivity configuration to create
9043
8920
  Databricks managed private endpoints so that Databricks serverless compute resources privately access
9044
8921
  your resources.
@@ -9069,9 +8946,7 @@ class NetworkConnectivityAPI:
9069
8946
  def create_private_endpoint_rule(
9070
8947
  self, network_connectivity_config_id: str, private_endpoint_rule: CreatePrivateEndpointRule
9071
8948
  ) -> NccPrivateEndpointRule:
9072
- """Create a private endpoint rule.
9073
-
9074
- Create a private endpoint rule for the specified network connectivity config object. Once the object
8949
+ """Create a private endpoint rule for the specified network connectivity config object. Once the object
9075
8950
  is created, Databricks asynchronously provisions a new Azure private endpoint to your specified Azure
9076
8951
  resource.
9077
8952
 
@@ -9104,9 +8979,7 @@ class NetworkConnectivityAPI:
9104
8979
  return NccPrivateEndpointRule.from_dict(res)
9105
8980
 
9106
8981
  def delete_network_connectivity_configuration(self, network_connectivity_config_id: str):
9107
- """Delete a network connectivity configuration.
9108
-
9109
- Deletes a network connectivity configuration.
8982
+ """Deletes a network connectivity configuration.
9110
8983
 
9111
8984
  :param network_connectivity_config_id: str
9112
8985
  Your Network Connectivity Configuration ID.
@@ -9127,9 +9000,7 @@ class NetworkConnectivityAPI:
9127
9000
  def delete_private_endpoint_rule(
9128
9001
  self, network_connectivity_config_id: str, private_endpoint_rule_id: str
9129
9002
  ) -> NccPrivateEndpointRule:
9130
- """Delete a private endpoint rule.
9131
-
9132
- Initiates deleting a private endpoint rule. If the connection state is PENDING or EXPIRED, the private
9003
+ """Initiates deleting a private endpoint rule. If the connection state is PENDING or EXPIRED, the private
9133
9004
  endpoint is immediately deleted. Otherwise, the private endpoint is deactivated and will be deleted
9134
9005
  after seven days of deactivation. When a private endpoint is deactivated, the `deactivated` field is
9135
9006
  set to `true` and the private endpoint is not available to your serverless compute resources.
@@ -9156,9 +9027,7 @@ class NetworkConnectivityAPI:
9156
9027
  def get_network_connectivity_configuration(
9157
9028
  self, network_connectivity_config_id: str
9158
9029
  ) -> NetworkConnectivityConfiguration:
9159
- """Get a network connectivity configuration.
9160
-
9161
- Gets a network connectivity configuration.
9030
+ """Gets a network connectivity configuration.
9162
9031
 
9163
9032
  :param network_connectivity_config_id: str
9164
9033
  Your Network Connectivity Configuration ID.
@@ -9180,9 +9049,7 @@ class NetworkConnectivityAPI:
9180
9049
  def get_private_endpoint_rule(
9181
9050
  self, network_connectivity_config_id: str, private_endpoint_rule_id: str
9182
9051
  ) -> NccPrivateEndpointRule:
9183
- """Gets a private endpoint rule.
9184
-
9185
- Gets the private endpoint rule.
9052
+ """Gets the private endpoint rule.
9186
9053
 
9187
9054
  :param network_connectivity_config_id: str
9188
9055
  Your Network Connectvity Configuration ID.
@@ -9206,9 +9073,7 @@ class NetworkConnectivityAPI:
9206
9073
  def list_network_connectivity_configurations(
9207
9074
  self, *, page_token: Optional[str] = None
9208
9075
  ) -> Iterator[NetworkConnectivityConfiguration]:
9209
- """List network connectivity configurations.
9210
-
9211
- Gets an array of network connectivity configurations.
9076
+ """Gets an array of network connectivity configurations.
9212
9077
 
9213
9078
  :param page_token: str (optional)
9214
9079
  Pagination token to go to next page based on previous query.
@@ -9240,9 +9105,7 @@ class NetworkConnectivityAPI:
9240
9105
  def list_private_endpoint_rules(
9241
9106
  self, network_connectivity_config_id: str, *, page_token: Optional[str] = None
9242
9107
  ) -> Iterator[NccPrivateEndpointRule]:
9243
- """List private endpoint rules.
9244
-
9245
- Gets an array of private endpoint rules.
9108
+ """Gets an array of private endpoint rules.
9246
9109
 
9247
9110
  :param network_connectivity_config_id: str
9248
9111
  Your Network Connectvity Configuration ID.
@@ -9280,9 +9143,7 @@ class NetworkConnectivityAPI:
9280
9143
  private_endpoint_rule: UpdatePrivateEndpointRule,
9281
9144
  update_mask: str,
9282
9145
  ) -> NccPrivateEndpointRule:
9283
- """Update a private endpoint rule.
9284
-
9285
- Updates a private endpoint rule. Currently only a private endpoint rule to customer-managed resources
9146
+ """Updates a private endpoint rule. Currently only a private endpoint rule to customer-managed resources
9286
9147
  is allowed to be updated.
9287
9148
 
9288
9149
  :param network_connectivity_config_id: str
@@ -9333,9 +9194,7 @@ class NetworkPoliciesAPI:
9333
9194
  self._api = api_client
9334
9195
 
9335
9196
  def create_network_policy_rpc(self, network_policy: AccountNetworkPolicy) -> AccountNetworkPolicy:
9336
- """Create a network policy.
9337
-
9338
- Creates a new network policy to manage which network destinations can be accessed from the Databricks
9197
+ """Creates a new network policy to manage which network destinations can be accessed from the Databricks
9339
9198
  environment.
9340
9199
 
9341
9200
  :param network_policy: :class:`AccountNetworkPolicy`
@@ -9354,9 +9213,7 @@ class NetworkPoliciesAPI:
9354
9213
  return AccountNetworkPolicy.from_dict(res)
9355
9214
 
9356
9215
  def delete_network_policy_rpc(self, network_policy_id: str):
9357
- """Delete a network policy.
9358
-
9359
- Deletes a network policy. Cannot be called on 'default-policy'.
9216
+ """Deletes a network policy. Cannot be called on 'default-policy'.
9360
9217
 
9361
9218
  :param network_policy_id: str
9362
9219
  The unique identifier of the network policy to delete.
@@ -9373,9 +9230,7 @@ class NetworkPoliciesAPI:
9373
9230
  )
9374
9231
 
9375
9232
  def get_network_policy_rpc(self, network_policy_id: str) -> AccountNetworkPolicy:
9376
- """Get a network policy.
9377
-
9378
- Gets a network policy.
9233
+ """Gets a network policy.
9379
9234
 
9380
9235
  :param network_policy_id: str
9381
9236
  The unique identifier of the network policy to retrieve.
@@ -9393,9 +9248,7 @@ class NetworkPoliciesAPI:
9393
9248
  return AccountNetworkPolicy.from_dict(res)
9394
9249
 
9395
9250
  def list_network_policies_rpc(self, *, page_token: Optional[str] = None) -> Iterator[AccountNetworkPolicy]:
9396
- """List network policies.
9397
-
9398
- Gets an array of network policies.
9251
+ """Gets an array of network policies.
9399
9252
 
9400
9253
  :param page_token: str (optional)
9401
9254
  Pagination token to go to next page based on previous query.
@@ -9424,9 +9277,7 @@ class NetworkPoliciesAPI:
9424
9277
  def update_network_policy_rpc(
9425
9278
  self, network_policy_id: str, network_policy: AccountNetworkPolicy
9426
9279
  ) -> AccountNetworkPolicy:
9427
- """Update a network policy.
9428
-
9429
- Updates a network policy. This allows you to modify the configuration of a network policy.
9280
+ """Updates a network policy. This allows you to modify the configuration of a network policy.
9430
9281
 
9431
9282
  :param network_policy_id: str
9432
9283
  The unique identifier for the network policy.
@@ -9459,9 +9310,7 @@ class NotificationDestinationsAPI:
9459
9310
  self._api = api_client
9460
9311
 
9461
9312
  def create(self, *, config: Optional[Config] = None, display_name: Optional[str] = None) -> NotificationDestination:
9462
- """Create a notification destination.
9463
-
9464
- Creates a notification destination. Requires workspace admin permissions.
9313
+ """Creates a notification destination. Requires workspace admin permissions.
9465
9314
 
9466
9315
  :param config: :class:`Config` (optional)
9467
9316
  The configuration for the notification destination. Must wrap EXACTLY one of the nested configs.
@@ -9484,9 +9333,7 @@ class NotificationDestinationsAPI:
9484
9333
  return NotificationDestination.from_dict(res)
9485
9334
 
9486
9335
  def delete(self, id: str):
9487
- """Delete a notification destination.
9488
-
9489
- Deletes a notification destination. Requires workspace admin permissions.
9336
+ """Deletes a notification destination. Requires workspace admin permissions.
9490
9337
 
9491
9338
  :param id: str
9492
9339
 
@@ -9500,9 +9347,7 @@ class NotificationDestinationsAPI:
9500
9347
  self._api.do("DELETE", f"/api/2.0/notification-destinations/{id}", headers=headers)
9501
9348
 
9502
9349
  def get(self, id: str) -> NotificationDestination:
9503
- """Get a notification destination.
9504
-
9505
- Gets a notification destination.
9350
+ """Gets a notification destination.
9506
9351
 
9507
9352
  :param id: str
9508
9353
 
@@ -9519,9 +9364,7 @@ class NotificationDestinationsAPI:
9519
9364
  def list(
9520
9365
  self, *, page_size: Optional[int] = None, page_token: Optional[str] = None
9521
9366
  ) -> Iterator[ListNotificationDestinationsResult]:
9522
- """List notification destinations.
9523
-
9524
- Lists notification destinations.
9367
+ """Lists notification destinations.
9525
9368
 
9526
9369
  :param page_size: int (optional)
9527
9370
  :param page_token: str (optional)
@@ -9550,9 +9393,7 @@ class NotificationDestinationsAPI:
9550
9393
  def update(
9551
9394
  self, id: str, *, config: Optional[Config] = None, display_name: Optional[str] = None
9552
9395
  ) -> NotificationDestination:
9553
- """Update a notification destination.
9554
-
9555
- Updates a notification destination. Requires workspace admin permissions. At least one field is
9396
+ """Updates a notification destination. Requires workspace admin permissions. At least one field is
9556
9397
  required in the request body.
9557
9398
 
9558
9399
  :param id: str
@@ -9591,9 +9432,7 @@ class PersonalComputeAPI:
9591
9432
  self._api = api_client
9592
9433
 
9593
9434
  def delete(self, *, etag: Optional[str] = None) -> DeletePersonalComputeSettingResponse:
9594
- """Delete Personal Compute setting.
9595
-
9596
- Reverts back the Personal Compute setting value to default (ON)
9435
+ """Reverts back the Personal Compute setting value to default (ON)
9597
9436
 
9598
9437
  :param etag: str (optional)
9599
9438
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -9621,9 +9460,7 @@ class PersonalComputeAPI:
9621
9460
  return DeletePersonalComputeSettingResponse.from_dict(res)
9622
9461
 
9623
9462
  def get(self, *, etag: Optional[str] = None) -> PersonalComputeSetting:
9624
- """Get Personal Compute setting.
9625
-
9626
- Gets the value of the Personal Compute setting.
9463
+ """Gets the value of the Personal Compute setting.
9627
9464
 
9628
9465
  :param etag: str (optional)
9629
9466
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -9651,9 +9488,7 @@ class PersonalComputeAPI:
9651
9488
  return PersonalComputeSetting.from_dict(res)
9652
9489
 
9653
9490
  def update(self, allow_missing: bool, setting: PersonalComputeSetting, field_mask: str) -> PersonalComputeSetting:
9654
- """Update Personal Compute setting.
9655
-
9656
- Updates the value of the Personal Compute setting.
9491
+ """Updates the value of the Personal Compute setting.
9657
9492
 
9658
9493
  :param allow_missing: bool
9659
9494
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -9707,9 +9542,7 @@ class RestrictWorkspaceAdminsAPI:
9707
9542
  self._api = api_client
9708
9543
 
9709
9544
  def delete(self, *, etag: Optional[str] = None) -> DeleteRestrictWorkspaceAdminsSettingResponse:
9710
- """Delete the restrict workspace admins setting.
9711
-
9712
- Reverts the restrict workspace admins setting status for the workspace. A fresh etag needs to be
9545
+ """Reverts the restrict workspace admins setting status for the workspace. A fresh etag needs to be
9713
9546
  provided in `DELETE` requests (as a query parameter). The etag can be retrieved by making a `GET`
9714
9547
  request before the DELETE request. If the setting is updated/deleted concurrently, `DELETE` fails with
9715
9548
  409 and the request must be retried by using the fresh etag in the 409 response.
@@ -9737,9 +9570,7 @@ class RestrictWorkspaceAdminsAPI:
9737
9570
  return DeleteRestrictWorkspaceAdminsSettingResponse.from_dict(res)
9738
9571
 
9739
9572
  def get(self, *, etag: Optional[str] = None) -> RestrictWorkspaceAdminsSetting:
9740
- """Get the restrict workspace admins setting.
9741
-
9742
- Gets the restrict workspace admins setting.
9573
+ """Gets the restrict workspace admins setting.
9743
9574
 
9744
9575
  :param etag: str (optional)
9745
9576
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -9766,9 +9597,7 @@ class RestrictWorkspaceAdminsAPI:
9766
9597
  def update(
9767
9598
  self, allow_missing: bool, setting: RestrictWorkspaceAdminsSetting, field_mask: str
9768
9599
  ) -> RestrictWorkspaceAdminsSetting:
9769
- """Update the restrict workspace admins setting.
9770
-
9771
- Updates the restrict workspace admins setting for the workspace. A fresh etag needs to be provided in
9600
+ """Updates the restrict workspace admins setting for the workspace. A fresh etag needs to be provided in
9772
9601
  `PATCH` requests (as part of the setting field). The etag can be retrieved by making a GET request
9773
9602
  before the `PATCH` request. If the setting is updated concurrently, `PATCH` fails with 409 and the
9774
9603
  request must be retried by using the fresh etag in the 409 response.
@@ -9913,9 +9742,7 @@ class SqlResultsDownloadAPI:
9913
9742
  self._api = api_client
9914
9743
 
9915
9744
  def delete(self, *, etag: Optional[str] = None) -> DeleteSqlResultsDownloadResponse:
9916
- """Delete the SQL Results Download setting.
9917
-
9918
- Reverts the SQL Results Download setting to its default value.
9745
+ """Reverts the SQL Results Download setting to its default value.
9919
9746
 
9920
9747
  :param etag: str (optional)
9921
9748
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -9940,9 +9767,7 @@ class SqlResultsDownloadAPI:
9940
9767
  return DeleteSqlResultsDownloadResponse.from_dict(res)
9941
9768
 
9942
9769
  def get(self, *, etag: Optional[str] = None) -> SqlResultsDownload:
9943
- """Get the SQL Results Download setting.
9944
-
9945
- Gets the SQL Results Download setting.
9770
+ """Gets the SQL Results Download setting.
9946
9771
 
9947
9772
  :param etag: str (optional)
9948
9773
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -9967,9 +9792,7 @@ class SqlResultsDownloadAPI:
9967
9792
  return SqlResultsDownload.from_dict(res)
9968
9793
 
9969
9794
  def update(self, allow_missing: bool, setting: SqlResultsDownload, field_mask: str) -> SqlResultsDownload:
9970
- """Update the SQL Results Download setting.
9971
-
9972
- Updates the SQL Results Download setting.
9795
+ """Updates the SQL Results Download setting.
9973
9796
 
9974
9797
  :param allow_missing: bool
9975
9798
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -10015,9 +9838,7 @@ class TokenManagementAPI:
10015
9838
  def create_obo_token(
10016
9839
  self, application_id: str, *, comment: Optional[str] = None, lifetime_seconds: Optional[int] = None
10017
9840
  ) -> CreateOboTokenResponse:
10018
- """Create on-behalf token.
10019
-
10020
- Creates a token on behalf of a service principal.
9841
+ """Creates a token on behalf of a service principal.
10021
9842
 
10022
9843
  :param application_id: str
10023
9844
  Application ID of the service principal.
@@ -10044,9 +9865,7 @@ class TokenManagementAPI:
10044
9865
  return CreateOboTokenResponse.from_dict(res)
10045
9866
 
10046
9867
  def delete(self, token_id: str):
10047
- """Delete a token.
10048
-
10049
- Deletes a token, specified by its ID.
9868
+ """Deletes a token, specified by its ID.
10050
9869
 
10051
9870
  :param token_id: str
10052
9871
  The ID of the token to revoke.
@@ -10059,9 +9878,7 @@ class TokenManagementAPI:
10059
9878
  self._api.do("DELETE", f"/api/2.0/token-management/tokens/{token_id}", headers=headers)
10060
9879
 
10061
9880
  def get(self, token_id: str) -> GetTokenResponse:
10062
- """Get token info.
10063
-
10064
- Gets information about a token, specified by its ID.
9881
+ """Gets information about a token, specified by its ID.
10065
9882
 
10066
9883
  :param token_id: str
10067
9884
  The ID of the token to get.
@@ -10077,9 +9894,7 @@ class TokenManagementAPI:
10077
9894
  return GetTokenResponse.from_dict(res)
10078
9895
 
10079
9896
  def get_permission_levels(self) -> GetTokenPermissionLevelsResponse:
10080
- """Get token permission levels.
10081
-
10082
- Gets the permission levels that a user can have on an object.
9897
+ """Gets the permission levels that a user can have on an object.
10083
9898
 
10084
9899
  :returns: :class:`GetTokenPermissionLevelsResponse`
10085
9900
  """
@@ -10092,9 +9907,7 @@ class TokenManagementAPI:
10092
9907
  return GetTokenPermissionLevelsResponse.from_dict(res)
10093
9908
 
10094
9909
  def get_permissions(self) -> TokenPermissions:
10095
- """Get token permissions.
10096
-
10097
- Gets the permissions of all tokens. Tokens can inherit permissions from their root object.
9910
+ """Gets the permissions of all tokens. Tokens can inherit permissions from their root object.
10098
9911
 
10099
9912
  :returns: :class:`TokenPermissions`
10100
9913
  """
@@ -10109,9 +9922,7 @@ class TokenManagementAPI:
10109
9922
  def list(
10110
9923
  self, *, created_by_id: Optional[int] = None, created_by_username: Optional[str] = None
10111
9924
  ) -> Iterator[TokenInfo]:
10112
- """List all tokens.
10113
-
10114
- Lists all tokens associated with the specified workspace or user.
9925
+ """Lists all tokens associated with the specified workspace or user.
10115
9926
 
10116
9927
  :param created_by_id: int (optional)
10117
9928
  User ID of the user that created the token.
@@ -10137,9 +9948,7 @@ class TokenManagementAPI:
10137
9948
  def set_permissions(
10138
9949
  self, *, access_control_list: Optional[List[TokenAccessControlRequest]] = None
10139
9950
  ) -> TokenPermissions:
10140
- """Set token permissions.
10141
-
10142
- Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
9951
+ """Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
10143
9952
  permissions if none are specified. Objects can inherit permissions from their root object.
10144
9953
 
10145
9954
  :param access_control_list: List[:class:`TokenAccessControlRequest`] (optional)
@@ -10160,9 +9969,7 @@ class TokenManagementAPI:
10160
9969
  def update_permissions(
10161
9970
  self, *, access_control_list: Optional[List[TokenAccessControlRequest]] = None
10162
9971
  ) -> TokenPermissions:
10163
- """Update token permissions.
10164
-
10165
- Updates the permissions on all tokens. Tokens can inherit permissions from their root object.
9972
+ """Updates the permissions on all tokens. Tokens can inherit permissions from their root object.
10166
9973
 
10167
9974
  :param access_control_list: List[:class:`TokenAccessControlRequest`] (optional)
10168
9975
 
@@ -10188,9 +9995,7 @@ class TokensAPI:
10188
9995
  self._api = api_client
10189
9996
 
10190
9997
  def create(self, *, comment: Optional[str] = None, lifetime_seconds: Optional[int] = None) -> CreateTokenResponse:
10191
- """Create a user token.
10192
-
10193
- Creates and returns a token for a user. If this call is made through token authentication, it creates
9998
+ """Creates and returns a token for a user. If this call is made through token authentication, it creates
10194
9999
  a token with the same client ID as the authenticated token. If the user's token quota is exceeded,
10195
10000
  this call returns an error **QUOTA_EXCEEDED**.
10196
10001
 
@@ -10217,9 +10022,7 @@ class TokensAPI:
10217
10022
  return CreateTokenResponse.from_dict(res)
10218
10023
 
10219
10024
  def delete(self, token_id: str):
10220
- """Revoke token.
10221
-
10222
- Revokes an access token.
10025
+ """Revokes an access token.
10223
10026
 
10224
10027
  If a token with the specified ID is not valid, this call returns an error **RESOURCE_DOES_NOT_EXIST**.
10225
10028
 
@@ -10239,9 +10042,7 @@ class TokensAPI:
10239
10042
  self._api.do("POST", "/api/2.0/token/delete", body=body, headers=headers)
10240
10043
 
10241
10044
  def list(self) -> Iterator[PublicTokenInfo]:
10242
- """List tokens.
10243
-
10244
- Lists all the valid tokens for a user-workspace pair.
10045
+ """Lists all the valid tokens for a user-workspace pair.
10245
10046
 
10246
10047
  :returns: Iterator over :class:`PublicTokenInfo`
10247
10048
  """
@@ -10262,9 +10063,7 @@ class WorkspaceConfAPI:
10262
10063
  self._api = api_client
10263
10064
 
10264
10065
  def get_status(self, keys: str) -> WorkspaceConf:
10265
- """Check configuration status.
10266
-
10267
- Gets the configuration status for a workspace.
10066
+ """Gets the configuration status for a workspace.
10268
10067
 
10269
10068
  :param keys: str
10270
10069
 
@@ -10282,13 +10081,7 @@ class WorkspaceConfAPI:
10282
10081
  return res
10283
10082
 
10284
10083
  def set_status(self, contents: Dict[str, str]):
10285
- """Enable/disable features.
10286
-
10287
- Sets the configuration status for a workspace, including enabling or disabling it.
10288
-
10289
-
10290
-
10291
- """
10084
+ """Sets the configuration status for a workspace, including enabling or disabling it."""
10292
10085
 
10293
10086
  headers = {
10294
10087
  "Content-Type": "application/json",
@@ -10308,9 +10101,7 @@ class WorkspaceNetworkConfigurationAPI:
10308
10101
  self._api = api_client
10309
10102
 
10310
10103
  def get_workspace_network_option_rpc(self, workspace_id: int) -> WorkspaceNetworkOption:
10311
- """Get workspace network option.
10312
-
10313
- Gets the network option for a workspace. Every workspace has exactly one network policy binding, with
10104
+ """Gets the network option for a workspace. Every workspace has exactly one network policy binding, with
10314
10105
  'default-policy' used if no explicit assignment exists.
10315
10106
 
10316
10107
  :param workspace_id: int
@@ -10331,9 +10122,7 @@ class WorkspaceNetworkConfigurationAPI:
10331
10122
  def update_workspace_network_option_rpc(
10332
10123
  self, workspace_id: int, workspace_network_option: WorkspaceNetworkOption
10333
10124
  ) -> WorkspaceNetworkOption:
10334
- """Update workspace network option.
10335
-
10336
- Updates the network option for a workspace. This operation associates the workspace with the specified
10125
+ """Updates the network option for a workspace. This operation associates the workspace with the specified
10337
10126
  network policy. To revert to the default policy, specify 'default-policy' as the network_policy_id.
10338
10127
 
10339
10128
  :param workspace_id: int