databricks-sdk 0.56.0__py3-none-any.whl → 0.58.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 +38 -11
  2. databricks/sdk/service/aibuilder.py +122 -17
  3. databricks/sdk/service/apps.py +15 -45
  4. databricks/sdk/service/billing.py +70 -74
  5. databricks/sdk/service/catalog.py +1898 -557
  6. databricks/sdk/service/cleanrooms.py +14 -55
  7. databricks/sdk/service/compute.py +305 -508
  8. databricks/sdk/service/dashboards.py +148 -223
  9. databricks/sdk/service/database.py +657 -127
  10. databricks/sdk/service/files.py +18 -54
  11. databricks/sdk/service/iam.py +55 -165
  12. databricks/sdk/service/jobs.py +238 -214
  13. databricks/sdk/service/marketplace.py +47 -146
  14. databricks/sdk/service/ml.py +1137 -447
  15. databricks/sdk/service/oauth2.py +17 -46
  16. databricks/sdk/service/pipelines.py +93 -69
  17. databricks/sdk/service/provisioning.py +34 -212
  18. databricks/sdk/service/qualitymonitorv2.py +5 -33
  19. databricks/sdk/service/serving.py +69 -55
  20. databricks/sdk/service/settings.py +106 -434
  21. databricks/sdk/service/sharing.py +33 -95
  22. databricks/sdk/service/sql.py +164 -254
  23. databricks/sdk/service/vectorsearch.py +13 -62
  24. databricks/sdk/service/workspace.py +36 -110
  25. databricks/sdk/version.py +1 -1
  26. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.58.0.dist-info}/METADATA +1 -1
  27. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.58.0.dist-info}/RECORD +31 -31
  28. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.58.0.dist-info}/WHEEL +0 -0
  29. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.58.0.dist-info}/licenses/LICENSE +0 -0
  30. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.58.0.dist-info}/licenses/NOTICE +0 -0
  31. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.58.0.dist-info}/top_level.txt +0 -0
@@ -352,11 +352,6 @@ class ClusterAutoRestartMessage:
352
352
  enabled: Optional[bool] = None
353
353
 
354
354
  enablement_details: Optional[ClusterAutoRestartMessageEnablementDetails] = None
355
- """Contains an information about the enablement status judging (e.g. whether the enterprise tier is
356
- enabled) This is only additional information that MUST NOT be used to decide whether the setting
357
- is enabled or not. This is intended to use only for purposes like showing an error message to
358
- the customer with the additional details. For example, using these details we can check why
359
- exactly the feature is disabled for this customer."""
360
355
 
361
356
  maintenance_window: Optional[ClusterAutoRestartMessageMaintenanceWindow] = None
362
357
 
@@ -615,7 +610,6 @@ class ComplianceSecurityProfile:
615
610
  @dataclass
616
611
  class ComplianceSecurityProfileSetting:
617
612
  compliance_security_profile_workspace: ComplianceSecurityProfile
618
- """SHIELD feature: CSP"""
619
613
 
620
614
  etag: Optional[str] = None
621
615
  """etag used for versioning. The response is at least as fresh as the eTag provided. This is used
@@ -745,10 +739,6 @@ class CreateIpAccessList:
745
739
  """Label for the IP access list. This **cannot** be empty."""
746
740
 
747
741
  list_type: ListType
748
- """Type of IP access list. Valid values are as follows and are case-sensitive:
749
-
750
- * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or
751
- range. IP addresses in the block list are excluded even if they are included in an allow list."""
752
742
 
753
743
  ip_addresses: Optional[List[str]] = None
754
744
 
@@ -789,7 +779,6 @@ class CreateIpAccessListResponse:
789
779
  """An IP access list was successfully created."""
790
780
 
791
781
  ip_access_list: Optional[IpAccessListInfo] = None
792
- """Definition of an IP Access list"""
793
782
 
794
783
  def as_dict(self) -> dict:
795
784
  """Serializes the CreateIpAccessListResponse into a dictionary suitable for use as a JSON request body."""
@@ -1138,7 +1127,6 @@ class CspEnablementAccount:
1138
1127
  @dataclass
1139
1128
  class CspEnablementAccountSetting:
1140
1129
  csp_enablement_account: CspEnablementAccount
1141
- """Account level policy for CSP"""
1142
1130
 
1143
1131
  etag: Optional[str] = None
1144
1132
  """etag used for versioning. The response is at least as fresh as the eTag provided. This is used
@@ -1745,42 +1733,6 @@ class DeleteLlmProxyPartnerPoweredWorkspaceResponse:
1745
1733
  return cls(etag=d.get("etag", None))
1746
1734
 
1747
1735
 
1748
- @dataclass
1749
- class DeleteNetworkConnectivityConfigurationResponse:
1750
- def as_dict(self) -> dict:
1751
- """Serializes the DeleteNetworkConnectivityConfigurationResponse into a dictionary suitable for use as a JSON request body."""
1752
- body = {}
1753
- return body
1754
-
1755
- def as_shallow_dict(self) -> dict:
1756
- """Serializes the DeleteNetworkConnectivityConfigurationResponse into a shallow dictionary of its immediate attributes."""
1757
- body = {}
1758
- return body
1759
-
1760
- @classmethod
1761
- def from_dict(cls, d: Dict[str, Any]) -> DeleteNetworkConnectivityConfigurationResponse:
1762
- """Deserializes the DeleteNetworkConnectivityConfigurationResponse from a dictionary."""
1763
- return cls()
1764
-
1765
-
1766
- @dataclass
1767
- class DeleteNetworkPolicyRpcResponse:
1768
- def as_dict(self) -> dict:
1769
- """Serializes the DeleteNetworkPolicyRpcResponse into a dictionary suitable for use as a JSON request body."""
1770
- body = {}
1771
- return body
1772
-
1773
- def as_shallow_dict(self) -> dict:
1774
- """Serializes the DeleteNetworkPolicyRpcResponse into a shallow dictionary of its immediate attributes."""
1775
- body = {}
1776
- return body
1777
-
1778
- @classmethod
1779
- def from_dict(cls, d: Dict[str, Any]) -> DeleteNetworkPolicyRpcResponse:
1780
- """Deserializes the DeleteNetworkPolicyRpcResponse from a dictionary."""
1781
- return cls()
1782
-
1783
-
1784
1736
  @dataclass
1785
1737
  class DeletePersonalComputeSettingResponse:
1786
1738
  """The etag is returned."""
@@ -2093,11 +2045,6 @@ class EgressNetworkPolicyInternetAccessPolicy:
2093
2045
  """Optional. If not specified, assume the policy is enforced for all workloads."""
2094
2046
 
2095
2047
  restriction_mode: Optional[EgressNetworkPolicyInternetAccessPolicyRestrictionMode] = None
2096
- """At which level can Databricks and Databricks managed compute access Internet. FULL_ACCESS:
2097
- Databricks can access Internet. No blocking rules will apply. RESTRICTED_ACCESS: Databricks can
2098
- only access explicitly allowed internet and storage destinations, as well as UC connections and
2099
- external locations. PRIVATE_ACCESS_ONLY (not used): Databricks can only access destinations via
2100
- private link."""
2101
2048
 
2102
2049
  def as_dict(self) -> dict:
2103
2050
  """Serializes the EgressNetworkPolicyInternetAccessPolicy into a dictionary suitable for use as a JSON request body."""
@@ -2151,10 +2098,6 @@ class EgressNetworkPolicyInternetAccessPolicyInternetDestination:
2151
2098
  protocol: Optional[
2152
2099
  EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol
2153
2100
  ] = None
2154
- """The filtering protocol used by the DP. For private and public preview, SEG will only support TCP
2155
- filtering (i.e. DNS based filtering, filtering by destination IP address), so protocol will be
2156
- set to TCP by default and hidden from the user. In the future, users may be able to select HTTP
2157
- filtering (i.e. SNI based filtering, filtering by FQDN)."""
2158
2101
 
2159
2102
  type: Optional[EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType] = None
2160
2103
 
@@ -2544,7 +2487,6 @@ class EgressNetworkPolicyNetworkAccessPolicyStorageDestination:
2544
2487
  bucket_name: Optional[str] = None
2545
2488
 
2546
2489
  region: Optional[str] = None
2547
- """The region of the S3 bucket."""
2548
2490
 
2549
2491
  storage_destination_type: Optional[
2550
2492
  EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType
@@ -2786,7 +2728,6 @@ class EnhancedSecurityMonitoring:
2786
2728
  @dataclass
2787
2729
  class EnhancedSecurityMonitoringSetting:
2788
2730
  enhanced_security_monitoring_workspace: EnhancedSecurityMonitoring
2789
- """SHIELD feature: ESM"""
2790
2731
 
2791
2732
  etag: Optional[str] = None
2792
2733
  """etag used for versioning. The response is at least as fresh as the eTag provided. This is used
@@ -2865,7 +2806,6 @@ class EsmEnablementAccount:
2865
2806
  @dataclass
2866
2807
  class EsmEnablementAccountSetting:
2867
2808
  esm_enablement_account: EsmEnablementAccount
2868
- """Account level policy for ESM"""
2869
2809
 
2870
2810
  etag: Optional[str] = None
2871
2811
  """etag used for versioning. The response is at least as fresh as the eTag provided. This is used
@@ -3050,7 +2990,6 @@ class FetchIpAccessListResponse:
3050
2990
  """An IP access list was successfully returned."""
3051
2991
 
3052
2992
  ip_access_list: Optional[IpAccessListInfo] = None
3053
- """Definition of an IP Access list"""
3054
2993
 
3055
2994
  def as_dict(self) -> dict:
3056
2995
  """Serializes the FetchIpAccessListResponse into a dictionary suitable for use as a JSON request body."""
@@ -3142,7 +3081,6 @@ class GenericWebhookConfig:
3142
3081
  @dataclass
3143
3082
  class GetIpAccessListResponse:
3144
3083
  ip_access_list: Optional[IpAccessListInfo] = None
3145
- """Definition of an IP Access list"""
3146
3084
 
3147
3085
  def as_dict(self) -> dict:
3148
3086
  """Serializes the GetIpAccessListResponse into a dictionary suitable for use as a JSON request body."""
@@ -3266,10 +3204,6 @@ class IpAccessListInfo:
3266
3204
  """Universally unique identifier (UUID) of the IP access list."""
3267
3205
 
3268
3206
  list_type: Optional[ListType] = None
3269
- """Type of IP access list. Valid values are as follows and are case-sensitive:
3270
-
3271
- * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or
3272
- range. IP addresses in the block list are excluded even if they are included in an allow list."""
3273
3207
 
3274
3208
  updated_at: Optional[int] = None
3275
3209
  """Update timestamp in milliseconds."""
@@ -4053,12 +3987,8 @@ class NccEgressDefaultRules:
4053
3987
  """Default rules don't have specific targets."""
4054
3988
 
4055
3989
  aws_stable_ip_rule: Optional[NccAwsStableIpRule] = None
4056
- """The stable AWS IP CIDR blocks. You can use these to configure the firewall of your resources to
4057
- allow traffic from your Databricks workspace."""
4058
3990
 
4059
3991
  azure_service_endpoint_rule: Optional[NccAzureServiceEndpointRule] = None
4060
- """The stable Azure service endpoints. You can configure the firewall of your Azure resources to
4061
- allow traffic from your Databricks serverless compute resources."""
4062
3992
 
4063
3993
  def as_dict(self) -> dict:
4064
3994
  """Serializes the NccEgressDefaultRules into a dictionary suitable for use as a JSON request body."""
@@ -4534,11 +4464,6 @@ class PartitionId:
4534
4464
  @dataclass
4535
4465
  class PersonalComputeMessage:
4536
4466
  value: PersonalComputeMessageEnum
4537
- """ON: Grants all users in all workspaces access to the Personal Compute default policy, allowing
4538
- all users to create single-machine compute resources. DELEGATE: Moves access control for the
4539
- Personal Compute default policy to individual workspaces and requires a workspace’s users or
4540
- groups to be added to the ACLs of that workspace’s Personal Compute default policy before they
4541
- will be able to create compute resources through that policy."""
4542
4467
 
4543
4468
  def as_dict(self) -> dict:
4544
4469
  """Serializes the PersonalComputeMessage into a dictionary suitable for use as a JSON request body."""
@@ -4680,10 +4605,6 @@ class ReplaceIpAccessList:
4680
4605
  """Label for the IP access list. This **cannot** be empty."""
4681
4606
 
4682
4607
  list_type: ListType
4683
- """Type of IP access list. Valid values are as follows and are case-sensitive:
4684
-
4685
- * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or
4686
- range. IP addresses in the block list are excluded even if they are included in an allow list."""
4687
4608
 
4688
4609
  enabled: bool
4689
4610
  """Specifies whether this IP access list is enabled."""
@@ -5007,7 +4928,6 @@ class TokenAccessControlRequest:
5007
4928
  """name of the group"""
5008
4929
 
5009
4930
  permission_level: Optional[TokenPermissionLevel] = None
5010
- """Permission level"""
5011
4931
 
5012
4932
  service_principal_name: Optional[str] = None
5013
4933
  """application ID of a service principal"""
@@ -5209,7 +5129,6 @@ class TokenPermission:
5209
5129
  inherited_from_object: Optional[List[str]] = None
5210
5130
 
5211
5131
  permission_level: Optional[TokenPermissionLevel] = None
5212
- """Permission level"""
5213
5132
 
5214
5133
  def as_dict(self) -> dict:
5215
5134
  """Serializes the TokenPermission into a dictionary suitable for use as a JSON request body."""
@@ -5294,7 +5213,6 @@ class TokenPermissionsDescription:
5294
5213
  description: Optional[str] = None
5295
5214
 
5296
5215
  permission_level: Optional[TokenPermissionLevel] = None
5297
- """Permission level"""
5298
5216
 
5299
5217
  def as_dict(self) -> dict:
5300
5218
  """Serializes the TokenPermissionsDescription into a dictionary suitable for use as a JSON request body."""
@@ -5730,13 +5648,6 @@ class UpdateDefaultNamespaceSettingRequest:
5730
5648
  """This should always be set to true for Settings API. Added for AIP compliance."""
5731
5649
 
5732
5650
  setting: DefaultNamespaceSetting
5733
- """This represents the setting configuration for the default namespace in the Databricks workspace.
5734
- Setting the default catalog for the workspace determines the catalog that is used when queries
5735
- do not reference a fully qualified 3 level name. For example, if the default catalog is set to
5736
- 'retail_prod' then a query 'SELECT * FROM myTable' would reference the object
5737
- 'retail_prod.default.myTable' (the schema 'default' is always assumed). This setting requires a
5738
- restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only
5739
- applies when using Unity Catalog-enabled compute."""
5740
5651
 
5741
5652
  field_mask: str
5742
5653
  """The field mask must be a single string, with multiple fields separated by commas (no spaces).
@@ -6213,10 +6124,6 @@ class UpdateIpAccessList:
6213
6124
  """Label for the IP access list. This **cannot** be empty."""
6214
6125
 
6215
6126
  list_type: Optional[ListType] = None
6216
- """Type of IP access list. Valid values are as follows and are case-sensitive:
6217
-
6218
- * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or
6219
- range. IP addresses in the block list are excluded even if they are included in an allow list."""
6220
6127
 
6221
6128
  def as_dict(self) -> dict:
6222
6129
  """Serializes the UpdateIpAccessList into a dictionary suitable for use as a JSON request body."""
@@ -6750,9 +6657,7 @@ class AccountIpAccessListsAPI:
6750
6657
  def create(
6751
6658
  self, label: str, list_type: ListType, *, ip_addresses: Optional[List[str]] = None
6752
6659
  ) -> CreateIpAccessListResponse:
6753
- """Create access list.
6754
-
6755
- Creates an IP access list for the account.
6660
+ """Creates an IP access list for the account.
6756
6661
 
6757
6662
  A list can be an allow list or a block list. See the top of this file for a description of how the
6758
6663
  server treats allow lists and block lists at runtime.
@@ -6769,10 +6674,6 @@ class AccountIpAccessListsAPI:
6769
6674
  :param label: str
6770
6675
  Label for the IP access list. This **cannot** be empty.
6771
6676
  :param list_type: :class:`ListType`
6772
- Type of IP access list. Valid values are as follows and are case-sensitive:
6773
-
6774
- * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or
6775
- range. IP addresses in the block list are excluded even if they are included in an allow list.
6776
6677
  :param ip_addresses: List[str] (optional)
6777
6678
 
6778
6679
  :returns: :class:`CreateIpAccessListResponse`
@@ -6795,9 +6696,7 @@ class AccountIpAccessListsAPI:
6795
6696
  return CreateIpAccessListResponse.from_dict(res)
6796
6697
 
6797
6698
  def delete(self, ip_access_list_id: str):
6798
- """Delete access list.
6799
-
6800
- Deletes an IP access list, specified by its list ID.
6699
+ """Deletes an IP access list, specified by its list ID.
6801
6700
 
6802
6701
  :param ip_access_list_id: str
6803
6702
  The ID for the corresponding IP access list
@@ -6812,9 +6711,7 @@ class AccountIpAccessListsAPI:
6812
6711
  )
6813
6712
 
6814
6713
  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.
6714
+ """Gets an IP access list, specified by its list ID.
6818
6715
 
6819
6716
  :param ip_access_list_id: str
6820
6717
  The ID for the corresponding IP access list
@@ -6832,9 +6729,8 @@ class AccountIpAccessListsAPI:
6832
6729
  return GetIpAccessListResponse.from_dict(res)
6833
6730
 
6834
6731
  def list(self) -> Iterator[IpAccessListInfo]:
6835
- """Get access lists.
6732
+ """Gets all IP access lists for the specified account.
6836
6733
 
6837
- Gets all IP access lists for the specified account.
6838
6734
 
6839
6735
  :returns: Iterator over :class:`IpAccessListInfo`
6840
6736
  """
@@ -6856,9 +6752,7 @@ class AccountIpAccessListsAPI:
6856
6752
  *,
6857
6753
  ip_addresses: Optional[List[str]] = None,
6858
6754
  ):
6859
- """Replace access list.
6860
-
6861
- Replaces an IP access list, specified by its ID.
6755
+ """Replaces an IP access list, specified by its ID.
6862
6756
 
6863
6757
  A list can include allow lists and block lists. See the top of this file for a description of how the
6864
6758
  server treats allow lists and block lists at run time. When replacing an IP access list: * For all
@@ -6873,10 +6767,6 @@ class AccountIpAccessListsAPI:
6873
6767
  :param label: str
6874
6768
  Label for the IP access list. This **cannot** be empty.
6875
6769
  :param list_type: :class:`ListType`
6876
- Type of IP access list. Valid values are as follows and are case-sensitive:
6877
-
6878
- * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or
6879
- range. IP addresses in the block list are excluded even if they are included in an allow list.
6880
6770
  :param enabled: bool
6881
6771
  Specifies whether this IP access list is enabled.
6882
6772
  :param ip_addresses: List[str] (optional)
@@ -6912,9 +6802,7 @@ class AccountIpAccessListsAPI:
6912
6802
  label: Optional[str] = None,
6913
6803
  list_type: Optional[ListType] = None,
6914
6804
  ):
6915
- """Update access list.
6916
-
6917
- Updates an existing IP access list, specified by its ID.
6805
+ """Updates an existing IP access list, specified by its ID.
6918
6806
 
6919
6807
  A list can include allow lists and block lists. See the top of this file for a description of how the
6920
6808
  server treats allow lists and block lists at run time.
@@ -6936,10 +6824,6 @@ class AccountIpAccessListsAPI:
6936
6824
  :param label: str (optional)
6937
6825
  Label for the IP access list. This **cannot** be empty.
6938
6826
  :param list_type: :class:`ListType` (optional)
6939
- Type of IP access list. Valid values are as follows and are case-sensitive:
6940
-
6941
- * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or
6942
- range. IP addresses in the block list are excluded even if they are included in an allow list.
6943
6827
 
6944
6828
 
6945
6829
  """
@@ -7022,9 +6906,7 @@ class AibiDashboardEmbeddingAccessPolicyAPI:
7022
6906
  self._api = api_client
7023
6907
 
7024
6908
  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.
6909
+ """Delete the AI/BI dashboard embedding access policy, reverting back to the default.
7028
6910
 
7029
6911
  :param etag: str (optional)
7030
6912
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7052,9 +6934,7 @@ class AibiDashboardEmbeddingAccessPolicyAPI:
7052
6934
  return DeleteAibiDashboardEmbeddingAccessPolicySettingResponse.from_dict(res)
7053
6935
 
7054
6936
  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,
6937
+ """Retrieves the AI/BI dashboard embedding access policy. The default setting is ALLOW_APPROVED_DOMAINS,
7058
6938
  permitting AI/BI dashboards to be embedded on approved domains.
7059
6939
 
7060
6940
  :param etag: str (optional)
@@ -7082,9 +6962,7 @@ class AibiDashboardEmbeddingAccessPolicyAPI:
7082
6962
  def update(
7083
6963
  self, allow_missing: bool, setting: AibiDashboardEmbeddingAccessPolicySetting, field_mask: str
7084
6964
  ) -> AibiDashboardEmbeddingAccessPolicySetting:
7085
- """Update the AI/BI dashboard embedding access policy.
7086
-
7087
- Updates the AI/BI dashboard embedding access policy at the workspace level.
6965
+ """Updates the AI/BI dashboard embedding access policy at the workspace level.
7088
6966
 
7089
6967
  :param allow_missing: bool
7090
6968
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -7128,9 +7006,7 @@ class AibiDashboardEmbeddingApprovedDomainsAPI:
7128
7006
  self._api = api_client
7129
7007
 
7130
7008
  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
7009
+ """Delete the list of domains approved to host embedded AI/BI dashboards, reverting back to the default
7134
7010
  empty list.
7135
7011
 
7136
7012
  :param etag: str (optional)
@@ -7159,9 +7035,7 @@ class AibiDashboardEmbeddingApprovedDomainsAPI:
7159
7035
  return DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse.from_dict(res)
7160
7036
 
7161
7037
  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.
7038
+ """Retrieves the list of domains approved to host embedded AI/BI dashboards.
7165
7039
 
7166
7040
  :param etag: str (optional)
7167
7041
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7191,9 +7065,7 @@ class AibiDashboardEmbeddingApprovedDomainsAPI:
7191
7065
  def update(
7192
7066
  self, allow_missing: bool, setting: AibiDashboardEmbeddingApprovedDomainsSetting, field_mask: str
7193
7067
  ) -> 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
7068
+ """Updates the list of domains approved to host embedded AI/BI dashboards. This update will fail if the
7197
7069
  current workspace access policy is not ALLOW_APPROVED_DOMAINS.
7198
7070
 
7199
7071
  :param allow_missing: bool
@@ -7241,9 +7113,7 @@ class AutomaticClusterUpdateAPI:
7241
7113
  self._api = api_client
7242
7114
 
7243
7115
  def get(self, *, etag: Optional[str] = None) -> AutomaticClusterUpdateSetting:
7244
- """Get the automatic cluster update setting.
7245
-
7246
- Gets the automatic cluster update setting.
7116
+ """Gets the automatic cluster update setting.
7247
7117
 
7248
7118
  :param etag: str (optional)
7249
7119
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7270,9 +7140,7 @@ class AutomaticClusterUpdateAPI:
7270
7140
  def update(
7271
7141
  self, allow_missing: bool, setting: AutomaticClusterUpdateSetting, field_mask: str
7272
7142
  ) -> 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
7143
+ """Updates the automatic cluster update setting for the workspace. A fresh etag needs to be provided in
7276
7144
  `PATCH` requests (as part of the setting field). The etag can be retrieved by making a `GET` request
7277
7145
  before the `PATCH` request. If the setting is updated concurrently, `PATCH` fails with 409 and the
7278
7146
  request must be retried by using the fresh etag in the 409 response.
@@ -7321,9 +7189,7 @@ class ComplianceSecurityProfileAPI:
7321
7189
  self._api = api_client
7322
7190
 
7323
7191
  def get(self, *, etag: Optional[str] = None) -> ComplianceSecurityProfileSetting:
7324
- """Get the compliance security profile setting.
7325
-
7326
- Gets the compliance security profile setting.
7192
+ """Gets the compliance security profile setting.
7327
7193
 
7328
7194
  :param etag: str (optional)
7329
7195
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7350,9 +7216,7 @@ class ComplianceSecurityProfileAPI:
7350
7216
  def update(
7351
7217
  self, allow_missing: bool, setting: ComplianceSecurityProfileSetting, field_mask: str
7352
7218
  ) -> 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
7219
+ """Updates the compliance security profile setting for the workspace. A fresh etag needs to be provided
7356
7220
  in `PATCH` requests (as part of the setting field). The etag can be retrieved by making a `GET`
7357
7221
  request before the `PATCH` request. If the setting is updated concurrently, `PATCH` fails with 409 and
7358
7222
  the request must be retried by using the fresh etag in the 409 response.
@@ -7401,9 +7265,7 @@ class CredentialsManagerAPI:
7401
7265
  def exchange_token(
7402
7266
  self, partition_id: PartitionId, token_type: List[TokenType], scopes: List[str]
7403
7267
  ) -> ExchangeTokenResponse:
7404
- """Exchange token.
7405
-
7406
- Exchange tokens with an Identity Provider to get a new access token. It allows specifying scopes to
7268
+ """Exchange tokens with an Identity Provider to get a new access token. It allows specifying scopes to
7407
7269
  determine token permissions.
7408
7270
 
7409
7271
  :param partition_id: :class:`PartitionId`
@@ -7443,9 +7305,7 @@ class CspEnablementAccountAPI:
7443
7305
  self._api = api_client
7444
7306
 
7445
7307
  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.
7308
+ """Gets the compliance security profile setting for new workspaces.
7449
7309
 
7450
7310
  :param etag: str (optional)
7451
7311
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7475,9 +7335,7 @@ class CspEnablementAccountAPI:
7475
7335
  def update(
7476
7336
  self, allow_missing: bool, setting: CspEnablementAccountSetting, field_mask: str
7477
7337
  ) -> 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.
7338
+ """Updates the value of the compliance security profile setting for new workspaces.
7481
7339
 
7482
7340
  :param allow_missing: bool
7483
7341
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -7525,9 +7383,7 @@ class DashboardEmailSubscriptionsAPI:
7525
7383
  self._api = api_client
7526
7384
 
7527
7385
  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.
7386
+ """Reverts the Dashboard Email Subscriptions setting to its default value.
7531
7387
 
7532
7388
  :param etag: str (optional)
7533
7389
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7555,9 +7411,7 @@ class DashboardEmailSubscriptionsAPI:
7555
7411
  return DeleteDashboardEmailSubscriptionsResponse.from_dict(res)
7556
7412
 
7557
7413
  def get(self, *, etag: Optional[str] = None) -> DashboardEmailSubscriptions:
7558
- """Get the Dashboard Email Subscriptions setting.
7559
-
7560
- Gets the Dashboard Email Subscriptions setting.
7414
+ """Gets the Dashboard Email Subscriptions setting.
7561
7415
 
7562
7416
  :param etag: str (optional)
7563
7417
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7584,9 +7438,7 @@ class DashboardEmailSubscriptionsAPI:
7584
7438
  def update(
7585
7439
  self, allow_missing: bool, setting: DashboardEmailSubscriptions, field_mask: str
7586
7440
  ) -> DashboardEmailSubscriptions:
7587
- """Update the Dashboard Email Subscriptions setting.
7588
-
7589
- Updates the Dashboard Email Subscriptions setting.
7441
+ """Updates the Dashboard Email Subscriptions setting.
7590
7442
 
7591
7443
  :param allow_missing: bool
7592
7444
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -7638,9 +7490,7 @@ class DefaultNamespaceAPI:
7638
7490
  self._api = api_client
7639
7491
 
7640
7492
  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`
7493
+ """Deletes the default namespace setting for the workspace. A fresh etag needs to be provided in `DELETE`
7644
7494
  requests (as a query parameter). The etag can be retrieved by making a `GET` request before the
7645
7495
  `DELETE` request. If the setting is updated/deleted concurrently, `DELETE` fails with 409 and the
7646
7496
  request must be retried by using the fresh etag in the 409 response.
@@ -7668,9 +7518,7 @@ class DefaultNamespaceAPI:
7668
7518
  return DeleteDefaultNamespaceSettingResponse.from_dict(res)
7669
7519
 
7670
7520
  def get(self, *, etag: Optional[str] = None) -> DefaultNamespaceSetting:
7671
- """Get the default namespace setting.
7672
-
7673
- Gets the default namespace setting.
7521
+ """Gets the default namespace setting.
7674
7522
 
7675
7523
  :param etag: str (optional)
7676
7524
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7695,9 +7543,7 @@ class DefaultNamespaceAPI:
7695
7543
  return DefaultNamespaceSetting.from_dict(res)
7696
7544
 
7697
7545
  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`
7546
+ """Updates the default namespace setting for the workspace. A fresh etag needs to be provided in `PATCH`
7701
7547
  requests (as part of the setting field). The etag can be retrieved by making a `GET` request before
7702
7548
  the `PATCH` request. Note that if the setting does not exist, `GET` returns a NOT_FOUND error and the
7703
7549
  etag is present in the error response, which should be set in the `PATCH` request. If the setting is
@@ -7707,13 +7553,6 @@ class DefaultNamespaceAPI:
7707
7553
  :param allow_missing: bool
7708
7554
  This should always be set to true for Settings API. Added for AIP compliance.
7709
7555
  :param setting: :class:`DefaultNamespaceSetting`
7710
- This represents the setting configuration for the default namespace in the Databricks workspace.
7711
- Setting the default catalog for the workspace determines the catalog that is used when queries do
7712
- not reference a fully qualified 3 level name. For example, if the default catalog is set to
7713
- 'retail_prod' then a query 'SELECT * FROM myTable' would reference the object
7714
- 'retail_prod.default.myTable' (the schema 'default' is always assumed). This setting requires a
7715
- restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only
7716
- applies when using Unity Catalog-enabled compute.
7717
7556
  :param field_mask: str
7718
7557
  The field mask must be a single string, with multiple fields separated by commas (no spaces). The
7719
7558
  field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
@@ -7756,9 +7595,7 @@ class DisableLegacyAccessAPI:
7756
7595
  self._api = api_client
7757
7596
 
7758
7597
  def delete(self, *, etag: Optional[str] = None) -> DeleteDisableLegacyAccessResponse:
7759
- """Delete Legacy Access Disablement Status.
7760
-
7761
- Deletes legacy access disablement status.
7598
+ """Deletes legacy access disablement status.
7762
7599
 
7763
7600
  :param etag: str (optional)
7764
7601
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7783,9 +7620,7 @@ class DisableLegacyAccessAPI:
7783
7620
  return DeleteDisableLegacyAccessResponse.from_dict(res)
7784
7621
 
7785
7622
  def get(self, *, etag: Optional[str] = None) -> DisableLegacyAccess:
7786
- """Retrieve Legacy Access Disablement Status.
7787
-
7788
- Retrieves legacy access disablement Status.
7623
+ """Retrieves legacy access disablement Status.
7789
7624
 
7790
7625
  :param etag: str (optional)
7791
7626
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7810,9 +7645,7 @@ class DisableLegacyAccessAPI:
7810
7645
  return DisableLegacyAccess.from_dict(res)
7811
7646
 
7812
7647
  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.
7648
+ """Updates legacy access disablement status.
7816
7649
 
7817
7650
  :param allow_missing: bool
7818
7651
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -7862,9 +7695,7 @@ class DisableLegacyDbfsAPI:
7862
7695
  self._api = api_client
7863
7696
 
7864
7697
  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.
7698
+ """Deletes the disable legacy DBFS setting for a workspace, reverting back to the default.
7868
7699
 
7869
7700
  :param etag: str (optional)
7870
7701
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7889,9 +7720,7 @@ class DisableLegacyDbfsAPI:
7889
7720
  return DeleteDisableLegacyDbfsResponse.from_dict(res)
7890
7721
 
7891
7722
  def get(self, *, etag: Optional[str] = None) -> DisableLegacyDbfs:
7892
- """Get the disable legacy DBFS setting.
7893
-
7894
- Gets the disable legacy DBFS setting.
7723
+ """Gets the disable legacy DBFS setting.
7895
7724
 
7896
7725
  :param etag: str (optional)
7897
7726
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7916,9 +7745,7 @@ class DisableLegacyDbfsAPI:
7916
7745
  return DisableLegacyDbfs.from_dict(res)
7917
7746
 
7918
7747
  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.
7748
+ """Updates the disable legacy DBFS setting for the workspace.
7922
7749
 
7923
7750
  :param allow_missing: bool
7924
7751
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -7965,9 +7792,7 @@ class DisableLegacyFeaturesAPI:
7965
7792
  self._api = api_client
7966
7793
 
7967
7794
  def delete(self, *, etag: Optional[str] = None) -> DeleteDisableLegacyFeaturesResponse:
7968
- """Delete the disable legacy features setting.
7969
-
7970
- Deletes the disable legacy features setting.
7795
+ """Deletes the disable legacy features setting.
7971
7796
 
7972
7797
  :param etag: str (optional)
7973
7798
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -7995,9 +7820,7 @@ class DisableLegacyFeaturesAPI:
7995
7820
  return DeleteDisableLegacyFeaturesResponse.from_dict(res)
7996
7821
 
7997
7822
  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.
7823
+ """Gets the value of the disable legacy features setting.
8001
7824
 
8002
7825
  :param etag: str (optional)
8003
7826
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8025,9 +7848,7 @@ class DisableLegacyFeaturesAPI:
8025
7848
  return DisableLegacyFeatures.from_dict(res)
8026
7849
 
8027
7850
  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.
7851
+ """Updates the value of the disable legacy features setting.
8031
7852
 
8032
7853
  :param allow_missing: bool
8033
7854
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -8074,9 +7895,8 @@ class EnableExportNotebookAPI:
8074
7895
  self._api = api_client
8075
7896
 
8076
7897
  def get_enable_export_notebook(self) -> EnableExportNotebook:
8077
- """Get the Notebook and File exporting setting.
7898
+ """Gets the Notebook and File exporting setting.
8078
7899
 
8079
- Gets the Notebook and File exporting setting.
8080
7900
 
8081
7901
  :returns: :class:`EnableExportNotebook`
8082
7902
  """
@@ -8091,9 +7911,7 @@ class EnableExportNotebookAPI:
8091
7911
  def patch_enable_export_notebook(
8092
7912
  self, allow_missing: bool, setting: EnableExportNotebook, field_mask: str
8093
7913
  ) -> 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
7914
+ """Updates the Notebook and File exporting setting. The model follows eventual consistency, which means
8097
7915
  the get after the update operation might receive stale values for some time.
8098
7916
 
8099
7917
  :param allow_missing: bool
@@ -8138,9 +7956,7 @@ class EnableIpAccessListsAPI:
8138
7956
  self._api = api_client
8139
7957
 
8140
7958
  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)
7959
+ """Reverts the value of the account IP access toggle setting to default (ON)
8144
7960
 
8145
7961
  :param etag: str (optional)
8146
7962
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8168,9 +7984,7 @@ class EnableIpAccessListsAPI:
8168
7984
  return DeleteAccountIpAccessEnableResponse.from_dict(res)
8169
7985
 
8170
7986
  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.
7987
+ """Gets the value of the account IP access toggle setting.
8174
7988
 
8175
7989
  :param etag: str (optional)
8176
7990
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8198,9 +8012,7 @@ class EnableIpAccessListsAPI:
8198
8012
  return AccountIpAccessEnable.from_dict(res)
8199
8013
 
8200
8014
  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.
8015
+ """Updates the value of the account IP access toggle setting.
8204
8016
 
8205
8017
  :param allow_missing: bool
8206
8018
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -8247,9 +8059,8 @@ class EnableNotebookTableClipboardAPI:
8247
8059
  self._api = api_client
8248
8060
 
8249
8061
  def get_enable_notebook_table_clipboard(self) -> EnableNotebookTableClipboard:
8250
- """Get the Results Table Clipboard features setting.
8062
+ """Gets the Results Table Clipboard features setting.
8251
8063
 
8252
- Gets the Results Table Clipboard features setting.
8253
8064
 
8254
8065
  :returns: :class:`EnableNotebookTableClipboard`
8255
8066
  """
@@ -8266,9 +8077,7 @@ class EnableNotebookTableClipboardAPI:
8266
8077
  def patch_enable_notebook_table_clipboard(
8267
8078
  self, allow_missing: bool, setting: EnableNotebookTableClipboard, field_mask: str
8268
8079
  ) -> EnableNotebookTableClipboard:
8269
- """Update the Results Table Clipboard features setting.
8270
-
8271
- Updates the Results Table Clipboard features setting. The model follows eventual consistency, which
8080
+ """Updates the Results Table Clipboard features setting. The model follows eventual consistency, which
8272
8081
  means the get after the update operation might receive stale values for some time.
8273
8082
 
8274
8083
  :param allow_missing: bool
@@ -8312,9 +8121,8 @@ class EnableResultsDownloadingAPI:
8312
8121
  self._api = api_client
8313
8122
 
8314
8123
  def get_enable_results_downloading(self) -> EnableResultsDownloading:
8315
- """Get the Notebook results download setting.
8124
+ """Gets the Notebook results download setting.
8316
8125
 
8317
- Gets the Notebook results download setting.
8318
8126
 
8319
8127
  :returns: :class:`EnableResultsDownloading`
8320
8128
  """
@@ -8329,9 +8137,7 @@ class EnableResultsDownloadingAPI:
8329
8137
  def patch_enable_results_downloading(
8330
8138
  self, allow_missing: bool, setting: EnableResultsDownloading, field_mask: str
8331
8139
  ) -> EnableResultsDownloading:
8332
- """Update the Notebook results download setting.
8333
-
8334
- Updates the Notebook results download setting. The model follows eventual consistency, which means the
8140
+ """Updates the Notebook results download setting. The model follows eventual consistency, which means the
8335
8141
  get after the update operation might receive stale values for some time.
8336
8142
 
8337
8143
  :param allow_missing: bool
@@ -8380,9 +8186,7 @@ class EnhancedSecurityMonitoringAPI:
8380
8186
  self._api = api_client
8381
8187
 
8382
8188
  def get(self, *, etag: Optional[str] = None) -> EnhancedSecurityMonitoringSetting:
8383
- """Get the enhanced security monitoring setting.
8384
-
8385
- Gets the enhanced security monitoring setting.
8189
+ """Gets the enhanced security monitoring setting.
8386
8190
 
8387
8191
  :param etag: str (optional)
8388
8192
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8409,9 +8213,7 @@ class EnhancedSecurityMonitoringAPI:
8409
8213
  def update(
8410
8214
  self, allow_missing: bool, setting: EnhancedSecurityMonitoringSetting, field_mask: str
8411
8215
  ) -> 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
8216
+ """Updates the enhanced security monitoring setting for the workspace. A fresh etag needs to be provided
8415
8217
  in `PATCH` requests (as part of the setting field). The etag can be retrieved by making a `GET`
8416
8218
  request before the `PATCH` request. If the setting is updated concurrently, `PATCH` fails with 409 and
8417
8219
  the request must be retried by using the fresh etag in the 409 response.
@@ -8459,9 +8261,7 @@ class EsmEnablementAccountAPI:
8459
8261
  self._api = api_client
8460
8262
 
8461
8263
  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.
8264
+ """Gets the enhanced security monitoring setting for new workspaces.
8465
8265
 
8466
8266
  :param etag: str (optional)
8467
8267
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8491,9 +8291,7 @@ class EsmEnablementAccountAPI:
8491
8291
  def update(
8492
8292
  self, allow_missing: bool, setting: EsmEnablementAccountSetting, field_mask: str
8493
8293
  ) -> 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.
8294
+ """Updates the value of the enhanced security monitoring setting for new workspaces.
8497
8295
 
8498
8296
  :param allow_missing: bool
8499
8297
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -8557,9 +8355,7 @@ class IpAccessListsAPI:
8557
8355
  def create(
8558
8356
  self, label: str, list_type: ListType, *, ip_addresses: Optional[List[str]] = None
8559
8357
  ) -> CreateIpAccessListResponse:
8560
- """Create access list.
8561
-
8562
- Creates an IP access list for this workspace.
8358
+ """Creates an IP access list for this workspace.
8563
8359
 
8564
8360
  A list can be an allow list or a block list. See the top of this file for a description of how the
8565
8361
  server treats allow lists and block lists at runtime.
@@ -8577,10 +8373,6 @@ class IpAccessListsAPI:
8577
8373
  :param label: str
8578
8374
  Label for the IP access list. This **cannot** be empty.
8579
8375
  :param list_type: :class:`ListType`
8580
- Type of IP access list. Valid values are as follows and are case-sensitive:
8581
-
8582
- * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or
8583
- range. IP addresses in the block list are excluded even if they are included in an allow list.
8584
8376
  :param ip_addresses: List[str] (optional)
8585
8377
 
8586
8378
  :returns: :class:`CreateIpAccessListResponse`
@@ -8601,9 +8393,7 @@ class IpAccessListsAPI:
8601
8393
  return CreateIpAccessListResponse.from_dict(res)
8602
8394
 
8603
8395
  def delete(self, ip_access_list_id: str):
8604
- """Delete access list.
8605
-
8606
- Deletes an IP access list, specified by its list ID.
8396
+ """Deletes an IP access list, specified by its list ID.
8607
8397
 
8608
8398
  :param ip_access_list_id: str
8609
8399
  The ID for the corresponding IP access list
@@ -8616,9 +8406,7 @@ class IpAccessListsAPI:
8616
8406
  self._api.do("DELETE", f"/api/2.0/ip-access-lists/{ip_access_list_id}", headers=headers)
8617
8407
 
8618
8408
  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.
8409
+ """Gets an IP access list, specified by its list ID.
8622
8410
 
8623
8411
  :param ip_access_list_id: str
8624
8412
  The ID for the corresponding IP access list
@@ -8634,9 +8422,8 @@ class IpAccessListsAPI:
8634
8422
  return FetchIpAccessListResponse.from_dict(res)
8635
8423
 
8636
8424
  def list(self) -> Iterator[IpAccessListInfo]:
8637
- """Get access lists.
8425
+ """Gets all IP access lists for the specified workspace.
8638
8426
 
8639
- Gets all IP access lists for the specified workspace.
8640
8427
 
8641
8428
  :returns: Iterator over :class:`IpAccessListInfo`
8642
8429
  """
@@ -8658,9 +8445,7 @@ class IpAccessListsAPI:
8658
8445
  *,
8659
8446
  ip_addresses: Optional[List[str]] = None,
8660
8447
  ):
8661
- """Replace access list.
8662
-
8663
- Replaces an IP access list, specified by its ID.
8448
+ """Replaces an IP access list, specified by its ID.
8664
8449
 
8665
8450
  A list can include allow lists and block lists. See the top of this file for a description of how the
8666
8451
  server treats allow lists and block lists at run time. When replacing an IP access list: * For all
@@ -8676,10 +8461,6 @@ class IpAccessListsAPI:
8676
8461
  :param label: str
8677
8462
  Label for the IP access list. This **cannot** be empty.
8678
8463
  :param list_type: :class:`ListType`
8679
- Type of IP access list. Valid values are as follows and are case-sensitive:
8680
-
8681
- * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or
8682
- range. IP addresses in the block list are excluded even if they are included in an allow list.
8683
8464
  :param enabled: bool
8684
8465
  Specifies whether this IP access list is enabled.
8685
8466
  :param ip_addresses: List[str] (optional)
@@ -8710,9 +8491,7 @@ class IpAccessListsAPI:
8710
8491
  label: Optional[str] = None,
8711
8492
  list_type: Optional[ListType] = None,
8712
8493
  ):
8713
- """Update access list.
8714
-
8715
- Updates an existing IP access list, specified by its ID.
8494
+ """Updates an existing IP access list, specified by its ID.
8716
8495
 
8717
8496
  A list can include allow lists and block lists. See the top of this file for a description of how the
8718
8497
  server treats allow lists and block lists at run time.
@@ -8735,10 +8514,6 @@ class IpAccessListsAPI:
8735
8514
  :param label: str (optional)
8736
8515
  Label for the IP access list. This **cannot** be empty.
8737
8516
  :param list_type: :class:`ListType` (optional)
8738
- Type of IP access list. Valid values are as follows and are case-sensitive:
8739
-
8740
- * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or
8741
- range. IP addresses in the block list are excluded even if they are included in an allow list.
8742
8517
 
8743
8518
 
8744
8519
  """
@@ -8765,9 +8540,7 @@ class LlmProxyPartnerPoweredAccountAPI:
8765
8540
  self._api = api_client
8766
8541
 
8767
8542
  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.
8543
+ """Gets the enable partner powered AI features account setting.
8771
8544
 
8772
8545
  :param etag: str (optional)
8773
8546
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8797,9 +8570,7 @@ class LlmProxyPartnerPoweredAccountAPI:
8797
8570
  def update(
8798
8571
  self, allow_missing: bool, setting: LlmProxyPartnerPoweredAccount, field_mask: str
8799
8572
  ) -> LlmProxyPartnerPoweredAccount:
8800
- """Update the enable partner powered AI features account setting.
8801
-
8802
- Updates the enable partner powered AI features account setting.
8573
+ """Updates the enable partner powered AI features account setting.
8803
8574
 
8804
8575
  :param allow_missing: bool
8805
8576
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -8846,9 +8617,7 @@ class LlmProxyPartnerPoweredEnforceAPI:
8846
8617
  self._api = api_client
8847
8618
 
8848
8619
  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.
8620
+ """Gets the enforcement status of partner powered AI features account setting.
8852
8621
 
8853
8622
  :param etag: str (optional)
8854
8623
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8878,9 +8647,7 @@ class LlmProxyPartnerPoweredEnforceAPI:
8878
8647
  def update(
8879
8648
  self, allow_missing: bool, setting: LlmProxyPartnerPoweredEnforce, field_mask: str
8880
8649
  ) -> 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.
8650
+ """Updates the enable enforcement status of partner powered AI features account setting.
8884
8651
 
8885
8652
  :param allow_missing: bool
8886
8653
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -8926,9 +8693,7 @@ class LlmProxyPartnerPoweredWorkspaceAPI:
8926
8693
  self._api = api_client
8927
8694
 
8928
8695
  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.
8696
+ """Reverts the enable partner powered AI features workspace setting to its default value.
8932
8697
 
8933
8698
  :param etag: str (optional)
8934
8699
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8953,9 +8718,7 @@ class LlmProxyPartnerPoweredWorkspaceAPI:
8953
8718
  return DeleteLlmProxyPartnerPoweredWorkspaceResponse.from_dict(res)
8954
8719
 
8955
8720
  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.
8721
+ """Gets the enable partner powered AI features workspace setting.
8959
8722
 
8960
8723
  :param etag: str (optional)
8961
8724
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -8982,9 +8745,7 @@ class LlmProxyPartnerPoweredWorkspaceAPI:
8982
8745
  def update(
8983
8746
  self, allow_missing: bool, setting: LlmProxyPartnerPoweredWorkspace, field_mask: str
8984
8747
  ) -> LlmProxyPartnerPoweredWorkspace:
8985
- """Update the enable partner powered AI features workspace setting.
8986
-
8987
- Updates the enable partner powered AI features workspace setting.
8748
+ """Updates the enable partner powered AI features workspace setting.
8988
8749
 
8989
8750
  :param allow_missing: bool
8990
8751
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -9036,9 +8797,7 @@ class NetworkConnectivityAPI:
9036
8797
  def create_network_connectivity_configuration(
9037
8798
  self, network_connectivity_config: CreateNetworkConnectivityConfiguration
9038
8799
  ) -> NetworkConnectivityConfiguration:
9039
- """Create a network connectivity configuration.
9040
-
9041
- Creates a network connectivity configuration (NCC), which provides stable Azure service subnets when
8800
+ """Creates a network connectivity configuration (NCC), which provides stable Azure service subnets when
9042
8801
  accessing your Azure Storage accounts. You can also use a network connectivity configuration to create
9043
8802
  Databricks managed private endpoints so that Databricks serverless compute resources privately access
9044
8803
  your resources.
@@ -9051,7 +8810,6 @@ class NetworkConnectivityAPI:
9051
8810
  [configure serverless secure connectivity]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security
9052
8811
 
9053
8812
  :param network_connectivity_config: :class:`CreateNetworkConnectivityConfiguration`
9054
- Properties of the new network connectivity configuration.
9055
8813
 
9056
8814
  :returns: :class:`NetworkConnectivityConfiguration`
9057
8815
  """
@@ -9069,9 +8827,7 @@ class NetworkConnectivityAPI:
9069
8827
  def create_private_endpoint_rule(
9070
8828
  self, network_connectivity_config_id: str, private_endpoint_rule: CreatePrivateEndpointRule
9071
8829
  ) -> NccPrivateEndpointRule:
9072
- """Create a private endpoint rule.
9073
-
9074
- Create a private endpoint rule for the specified network connectivity config object. Once the object
8830
+ """Create a private endpoint rule for the specified network connectivity config object. Once the object
9075
8831
  is created, Databricks asynchronously provisions a new Azure private endpoint to your specified Azure
9076
8832
  resource.
9077
8833
 
@@ -9084,8 +8840,6 @@ class NetworkConnectivityAPI:
9084
8840
  :param network_connectivity_config_id: str
9085
8841
  Your Network Connectivity Configuration ID.
9086
8842
  :param private_endpoint_rule: :class:`CreatePrivateEndpointRule`
9087
- Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal
9088
- after initialization.
9089
8843
 
9090
8844
  :returns: :class:`NccPrivateEndpointRule`
9091
8845
  """
@@ -9104,9 +8858,7 @@ class NetworkConnectivityAPI:
9104
8858
  return NccPrivateEndpointRule.from_dict(res)
9105
8859
 
9106
8860
  def delete_network_connectivity_configuration(self, network_connectivity_config_id: str):
9107
- """Delete a network connectivity configuration.
9108
-
9109
- Deletes a network connectivity configuration.
8861
+ """Deletes a network connectivity configuration.
9110
8862
 
9111
8863
  :param network_connectivity_config_id: str
9112
8864
  Your Network Connectivity Configuration ID.
@@ -9127,9 +8879,7 @@ class NetworkConnectivityAPI:
9127
8879
  def delete_private_endpoint_rule(
9128
8880
  self, network_connectivity_config_id: str, private_endpoint_rule_id: str
9129
8881
  ) -> 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
8882
+ """Initiates deleting a private endpoint rule. If the connection state is PENDING or EXPIRED, the private
9133
8883
  endpoint is immediately deleted. Otherwise, the private endpoint is deactivated and will be deleted
9134
8884
  after seven days of deactivation. When a private endpoint is deactivated, the `deactivated` field is
9135
8885
  set to `true` and the private endpoint is not available to your serverless compute resources.
@@ -9156,9 +8906,7 @@ class NetworkConnectivityAPI:
9156
8906
  def get_network_connectivity_configuration(
9157
8907
  self, network_connectivity_config_id: str
9158
8908
  ) -> NetworkConnectivityConfiguration:
9159
- """Get a network connectivity configuration.
9160
-
9161
- Gets a network connectivity configuration.
8909
+ """Gets a network connectivity configuration.
9162
8910
 
9163
8911
  :param network_connectivity_config_id: str
9164
8912
  Your Network Connectivity Configuration ID.
@@ -9180,9 +8928,7 @@ class NetworkConnectivityAPI:
9180
8928
  def get_private_endpoint_rule(
9181
8929
  self, network_connectivity_config_id: str, private_endpoint_rule_id: str
9182
8930
  ) -> NccPrivateEndpointRule:
9183
- """Gets a private endpoint rule.
9184
-
9185
- Gets the private endpoint rule.
8931
+ """Gets the private endpoint rule.
9186
8932
 
9187
8933
  :param network_connectivity_config_id: str
9188
8934
  Your Network Connectvity Configuration ID.
@@ -9206,9 +8952,7 @@ class NetworkConnectivityAPI:
9206
8952
  def list_network_connectivity_configurations(
9207
8953
  self, *, page_token: Optional[str] = None
9208
8954
  ) -> Iterator[NetworkConnectivityConfiguration]:
9209
- """List network connectivity configurations.
9210
-
9211
- Gets an array of network connectivity configurations.
8955
+ """Gets an array of network connectivity configurations.
9212
8956
 
9213
8957
  :param page_token: str (optional)
9214
8958
  Pagination token to go to next page based on previous query.
@@ -9240,9 +8984,7 @@ class NetworkConnectivityAPI:
9240
8984
  def list_private_endpoint_rules(
9241
8985
  self, network_connectivity_config_id: str, *, page_token: Optional[str] = None
9242
8986
  ) -> Iterator[NccPrivateEndpointRule]:
9243
- """List private endpoint rules.
9244
-
9245
- Gets an array of private endpoint rules.
8987
+ """Gets an array of private endpoint rules.
9246
8988
 
9247
8989
  :param network_connectivity_config_id: str
9248
8990
  Your Network Connectvity Configuration ID.
@@ -9280,9 +9022,7 @@ class NetworkConnectivityAPI:
9280
9022
  private_endpoint_rule: UpdatePrivateEndpointRule,
9281
9023
  update_mask: str,
9282
9024
  ) -> NccPrivateEndpointRule:
9283
- """Update a private endpoint rule.
9284
-
9285
- Updates a private endpoint rule. Currently only a private endpoint rule to customer-managed resources
9025
+ """Updates a private endpoint rule. Currently only a private endpoint rule to customer-managed resources
9286
9026
  is allowed to be updated.
9287
9027
 
9288
9028
  :param network_connectivity_config_id: str
@@ -9291,8 +9031,6 @@ class NetworkConnectivityAPI:
9291
9031
  :param private_endpoint_rule_id: str
9292
9032
  Your private endpoint rule ID.
9293
9033
  :param private_endpoint_rule: :class:`UpdatePrivateEndpointRule`
9294
- Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal
9295
- after initialization.
9296
9034
  :param update_mask: str
9297
9035
  The field mask must be a single string, with multiple fields separated by commas (no spaces). The
9298
9036
  field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
@@ -9333,12 +9071,11 @@ class NetworkPoliciesAPI:
9333
9071
  self._api = api_client
9334
9072
 
9335
9073
  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
9074
+ """Creates a new network policy to manage which network destinations can be accessed from the Databricks
9339
9075
  environment.
9340
9076
 
9341
9077
  :param network_policy: :class:`AccountNetworkPolicy`
9078
+ Network policy configuration details.
9342
9079
 
9343
9080
  :returns: :class:`AccountNetworkPolicy`
9344
9081
  """
@@ -9354,9 +9091,7 @@ class NetworkPoliciesAPI:
9354
9091
  return AccountNetworkPolicy.from_dict(res)
9355
9092
 
9356
9093
  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'.
9094
+ """Deletes a network policy. Cannot be called on 'default-policy'.
9360
9095
 
9361
9096
  :param network_policy_id: str
9362
9097
  The unique identifier of the network policy to delete.
@@ -9373,9 +9108,7 @@ class NetworkPoliciesAPI:
9373
9108
  )
9374
9109
 
9375
9110
  def get_network_policy_rpc(self, network_policy_id: str) -> AccountNetworkPolicy:
9376
- """Get a network policy.
9377
-
9378
- Gets a network policy.
9111
+ """Gets a network policy.
9379
9112
 
9380
9113
  :param network_policy_id: str
9381
9114
  The unique identifier of the network policy to retrieve.
@@ -9393,9 +9126,7 @@ class NetworkPoliciesAPI:
9393
9126
  return AccountNetworkPolicy.from_dict(res)
9394
9127
 
9395
9128
  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.
9129
+ """Gets an array of network policies.
9399
9130
 
9400
9131
  :param page_token: str (optional)
9401
9132
  Pagination token to go to next page based on previous query.
@@ -9424,13 +9155,12 @@ class NetworkPoliciesAPI:
9424
9155
  def update_network_policy_rpc(
9425
9156
  self, network_policy_id: str, network_policy: AccountNetworkPolicy
9426
9157
  ) -> AccountNetworkPolicy:
9427
- """Update a network policy.
9428
-
9429
- Updates a network policy. This allows you to modify the configuration of a network policy.
9158
+ """Updates a network policy. This allows you to modify the configuration of a network policy.
9430
9159
 
9431
9160
  :param network_policy_id: str
9432
9161
  The unique identifier for the network policy.
9433
9162
  :param network_policy: :class:`AccountNetworkPolicy`
9163
+ Updated network policy configuration details.
9434
9164
 
9435
9165
  :returns: :class:`AccountNetworkPolicy`
9436
9166
  """
@@ -9459,9 +9189,7 @@ class NotificationDestinationsAPI:
9459
9189
  self._api = api_client
9460
9190
 
9461
9191
  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.
9192
+ """Creates a notification destination. Requires workspace admin permissions.
9465
9193
 
9466
9194
  :param config: :class:`Config` (optional)
9467
9195
  The configuration for the notification destination. Must wrap EXACTLY one of the nested configs.
@@ -9484,9 +9212,7 @@ class NotificationDestinationsAPI:
9484
9212
  return NotificationDestination.from_dict(res)
9485
9213
 
9486
9214
  def delete(self, id: str):
9487
- """Delete a notification destination.
9488
-
9489
- Deletes a notification destination. Requires workspace admin permissions.
9215
+ """Deletes a notification destination. Requires workspace admin permissions.
9490
9216
 
9491
9217
  :param id: str
9492
9218
 
@@ -9500,9 +9226,7 @@ class NotificationDestinationsAPI:
9500
9226
  self._api.do("DELETE", f"/api/2.0/notification-destinations/{id}", headers=headers)
9501
9227
 
9502
9228
  def get(self, id: str) -> NotificationDestination:
9503
- """Get a notification destination.
9504
-
9505
- Gets a notification destination.
9229
+ """Gets a notification destination.
9506
9230
 
9507
9231
  :param id: str
9508
9232
 
@@ -9519,9 +9243,7 @@ class NotificationDestinationsAPI:
9519
9243
  def list(
9520
9244
  self, *, page_size: Optional[int] = None, page_token: Optional[str] = None
9521
9245
  ) -> Iterator[ListNotificationDestinationsResult]:
9522
- """List notification destinations.
9523
-
9524
- Lists notification destinations.
9246
+ """Lists notification destinations.
9525
9247
 
9526
9248
  :param page_size: int (optional)
9527
9249
  :param page_token: str (optional)
@@ -9550,9 +9272,7 @@ class NotificationDestinationsAPI:
9550
9272
  def update(
9551
9273
  self, id: str, *, config: Optional[Config] = None, display_name: Optional[str] = None
9552
9274
  ) -> NotificationDestination:
9553
- """Update a notification destination.
9554
-
9555
- Updates a notification destination. Requires workspace admin permissions. At least one field is
9275
+ """Updates a notification destination. Requires workspace admin permissions. At least one field is
9556
9276
  required in the request body.
9557
9277
 
9558
9278
  :param id: str
@@ -9591,9 +9311,7 @@ class PersonalComputeAPI:
9591
9311
  self._api = api_client
9592
9312
 
9593
9313
  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)
9314
+ """Reverts back the Personal Compute setting value to default (ON)
9597
9315
 
9598
9316
  :param etag: str (optional)
9599
9317
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -9621,9 +9339,7 @@ class PersonalComputeAPI:
9621
9339
  return DeletePersonalComputeSettingResponse.from_dict(res)
9622
9340
 
9623
9341
  def get(self, *, etag: Optional[str] = None) -> PersonalComputeSetting:
9624
- """Get Personal Compute setting.
9625
-
9626
- Gets the value of the Personal Compute setting.
9342
+ """Gets the value of the Personal Compute setting.
9627
9343
 
9628
9344
  :param etag: str (optional)
9629
9345
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -9651,9 +9367,7 @@ class PersonalComputeAPI:
9651
9367
  return PersonalComputeSetting.from_dict(res)
9652
9368
 
9653
9369
  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.
9370
+ """Updates the value of the Personal Compute setting.
9657
9371
 
9658
9372
  :param allow_missing: bool
9659
9373
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -9707,9 +9421,7 @@ class RestrictWorkspaceAdminsAPI:
9707
9421
  self._api = api_client
9708
9422
 
9709
9423
  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
9424
+ """Reverts the restrict workspace admins setting status for the workspace. A fresh etag needs to be
9713
9425
  provided in `DELETE` requests (as a query parameter). The etag can be retrieved by making a `GET`
9714
9426
  request before the DELETE request. If the setting is updated/deleted concurrently, `DELETE` fails with
9715
9427
  409 and the request must be retried by using the fresh etag in the 409 response.
@@ -9737,9 +9449,7 @@ class RestrictWorkspaceAdminsAPI:
9737
9449
  return DeleteRestrictWorkspaceAdminsSettingResponse.from_dict(res)
9738
9450
 
9739
9451
  def get(self, *, etag: Optional[str] = None) -> RestrictWorkspaceAdminsSetting:
9740
- """Get the restrict workspace admins setting.
9741
-
9742
- Gets the restrict workspace admins setting.
9452
+ """Gets the restrict workspace admins setting.
9743
9453
 
9744
9454
  :param etag: str (optional)
9745
9455
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -9766,9 +9476,7 @@ class RestrictWorkspaceAdminsAPI:
9766
9476
  def update(
9767
9477
  self, allow_missing: bool, setting: RestrictWorkspaceAdminsSetting, field_mask: str
9768
9478
  ) -> 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
9479
+ """Updates the restrict workspace admins setting for the workspace. A fresh etag needs to be provided in
9772
9480
  `PATCH` requests (as part of the setting field). The etag can be retrieved by making a GET request
9773
9481
  before the `PATCH` request. If the setting is updated concurrently, `PATCH` fails with 409 and the
9774
9482
  request must be retried by using the fresh etag in the 409 response.
@@ -9913,9 +9621,7 @@ class SqlResultsDownloadAPI:
9913
9621
  self._api = api_client
9914
9622
 
9915
9623
  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.
9624
+ """Reverts the SQL Results Download setting to its default value.
9919
9625
 
9920
9626
  :param etag: str (optional)
9921
9627
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -9940,9 +9646,7 @@ class SqlResultsDownloadAPI:
9940
9646
  return DeleteSqlResultsDownloadResponse.from_dict(res)
9941
9647
 
9942
9648
  def get(self, *, etag: Optional[str] = None) -> SqlResultsDownload:
9943
- """Get the SQL Results Download setting.
9944
-
9945
- Gets the SQL Results Download setting.
9649
+ """Gets the SQL Results Download setting.
9946
9650
 
9947
9651
  :param etag: str (optional)
9948
9652
  etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
@@ -9967,9 +9671,7 @@ class SqlResultsDownloadAPI:
9967
9671
  return SqlResultsDownload.from_dict(res)
9968
9672
 
9969
9673
  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.
9674
+ """Updates the SQL Results Download setting.
9973
9675
 
9974
9676
  :param allow_missing: bool
9975
9677
  This should always be set to true for Settings API. Added for AIP compliance.
@@ -10015,9 +9717,7 @@ class TokenManagementAPI:
10015
9717
  def create_obo_token(
10016
9718
  self, application_id: str, *, comment: Optional[str] = None, lifetime_seconds: Optional[int] = None
10017
9719
  ) -> CreateOboTokenResponse:
10018
- """Create on-behalf token.
10019
-
10020
- Creates a token on behalf of a service principal.
9720
+ """Creates a token on behalf of a service principal.
10021
9721
 
10022
9722
  :param application_id: str
10023
9723
  Application ID of the service principal.
@@ -10044,9 +9744,7 @@ class TokenManagementAPI:
10044
9744
  return CreateOboTokenResponse.from_dict(res)
10045
9745
 
10046
9746
  def delete(self, token_id: str):
10047
- """Delete a token.
10048
-
10049
- Deletes a token, specified by its ID.
9747
+ """Deletes a token, specified by its ID.
10050
9748
 
10051
9749
  :param token_id: str
10052
9750
  The ID of the token to revoke.
@@ -10059,9 +9757,7 @@ class TokenManagementAPI:
10059
9757
  self._api.do("DELETE", f"/api/2.0/token-management/tokens/{token_id}", headers=headers)
10060
9758
 
10061
9759
  def get(self, token_id: str) -> GetTokenResponse:
10062
- """Get token info.
10063
-
10064
- Gets information about a token, specified by its ID.
9760
+ """Gets information about a token, specified by its ID.
10065
9761
 
10066
9762
  :param token_id: str
10067
9763
  The ID of the token to get.
@@ -10077,9 +9773,8 @@ class TokenManagementAPI:
10077
9773
  return GetTokenResponse.from_dict(res)
10078
9774
 
10079
9775
  def get_permission_levels(self) -> GetTokenPermissionLevelsResponse:
10080
- """Get token permission levels.
9776
+ """Gets the permission levels that a user can have on an object.
10081
9777
 
10082
- Gets the permission levels that a user can have on an object.
10083
9778
 
10084
9779
  :returns: :class:`GetTokenPermissionLevelsResponse`
10085
9780
  """
@@ -10092,9 +9787,8 @@ class TokenManagementAPI:
10092
9787
  return GetTokenPermissionLevelsResponse.from_dict(res)
10093
9788
 
10094
9789
  def get_permissions(self) -> TokenPermissions:
10095
- """Get token permissions.
9790
+ """Gets the permissions of all tokens. Tokens can inherit permissions from their root object.
10096
9791
 
10097
- Gets the permissions of all tokens. Tokens can inherit permissions from their root object.
10098
9792
 
10099
9793
  :returns: :class:`TokenPermissions`
10100
9794
  """
@@ -10109,9 +9803,7 @@ class TokenManagementAPI:
10109
9803
  def list(
10110
9804
  self, *, created_by_id: Optional[int] = None, created_by_username: Optional[str] = None
10111
9805
  ) -> Iterator[TokenInfo]:
10112
- """List all tokens.
10113
-
10114
- Lists all tokens associated with the specified workspace or user.
9806
+ """Lists all tokens associated with the specified workspace or user.
10115
9807
 
10116
9808
  :param created_by_id: int (optional)
10117
9809
  User ID of the user that created the token.
@@ -10137,9 +9829,7 @@ class TokenManagementAPI:
10137
9829
  def set_permissions(
10138
9830
  self, *, access_control_list: Optional[List[TokenAccessControlRequest]] = None
10139
9831
  ) -> TokenPermissions:
10140
- """Set token permissions.
10141
-
10142
- Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
9832
+ """Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
10143
9833
  permissions if none are specified. Objects can inherit permissions from their root object.
10144
9834
 
10145
9835
  :param access_control_list: List[:class:`TokenAccessControlRequest`] (optional)
@@ -10160,9 +9850,7 @@ class TokenManagementAPI:
10160
9850
  def update_permissions(
10161
9851
  self, *, access_control_list: Optional[List[TokenAccessControlRequest]] = None
10162
9852
  ) -> TokenPermissions:
10163
- """Update token permissions.
10164
-
10165
- Updates the permissions on all tokens. Tokens can inherit permissions from their root object.
9853
+ """Updates the permissions on all tokens. Tokens can inherit permissions from their root object.
10166
9854
 
10167
9855
  :param access_control_list: List[:class:`TokenAccessControlRequest`] (optional)
10168
9856
 
@@ -10188,9 +9876,7 @@ class TokensAPI:
10188
9876
  self._api = api_client
10189
9877
 
10190
9878
  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
9879
+ """Creates and returns a token for a user. If this call is made through token authentication, it creates
10194
9880
  a token with the same client ID as the authenticated token. If the user's token quota is exceeded,
10195
9881
  this call returns an error **QUOTA_EXCEEDED**.
10196
9882
 
@@ -10217,9 +9903,7 @@ class TokensAPI:
10217
9903
  return CreateTokenResponse.from_dict(res)
10218
9904
 
10219
9905
  def delete(self, token_id: str):
10220
- """Revoke token.
10221
-
10222
- Revokes an access token.
9906
+ """Revokes an access token.
10223
9907
 
10224
9908
  If a token with the specified ID is not valid, this call returns an error **RESOURCE_DOES_NOT_EXIST**.
10225
9909
 
@@ -10239,9 +9923,8 @@ class TokensAPI:
10239
9923
  self._api.do("POST", "/api/2.0/token/delete", body=body, headers=headers)
10240
9924
 
10241
9925
  def list(self) -> Iterator[PublicTokenInfo]:
10242
- """List tokens.
9926
+ """Lists all the valid tokens for a user-workspace pair.
10243
9927
 
10244
- Lists all the valid tokens for a user-workspace pair.
10245
9928
 
10246
9929
  :returns: Iterator over :class:`PublicTokenInfo`
10247
9930
  """
@@ -10262,9 +9945,7 @@ class WorkspaceConfAPI:
10262
9945
  self._api = api_client
10263
9946
 
10264
9947
  def get_status(self, keys: str) -> WorkspaceConf:
10265
- """Check configuration status.
10266
-
10267
- Gets the configuration status for a workspace.
9948
+ """Gets the configuration status for a workspace.
10268
9949
 
10269
9950
  :param keys: str
10270
9951
 
@@ -10282,13 +9963,7 @@ class WorkspaceConfAPI:
10282
9963
  return res
10283
9964
 
10284
9965
  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
- """
9966
+ """Sets the configuration status for a workspace, including enabling or disabling it."""
10292
9967
 
10293
9968
  headers = {
10294
9969
  "Content-Type": "application/json",
@@ -10308,9 +9983,7 @@ class WorkspaceNetworkConfigurationAPI:
10308
9983
  self._api = api_client
10309
9984
 
10310
9985
  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
9986
+ """Gets the network option for a workspace. Every workspace has exactly one network policy binding, with
10314
9987
  'default-policy' used if no explicit assignment exists.
10315
9988
 
10316
9989
  :param workspace_id: int
@@ -10331,14 +10004,13 @@ class WorkspaceNetworkConfigurationAPI:
10331
10004
  def update_workspace_network_option_rpc(
10332
10005
  self, workspace_id: int, workspace_network_option: WorkspaceNetworkOption
10333
10006
  ) -> WorkspaceNetworkOption:
10334
- """Update workspace network option.
10335
-
10336
- Updates the network option for a workspace. This operation associates the workspace with the specified
10007
+ """Updates the network option for a workspace. This operation associates the workspace with the specified
10337
10008
  network policy. To revert to the default policy, specify 'default-policy' as the network_policy_id.
10338
10009
 
10339
10010
  :param workspace_id: int
10340
10011
  The workspace ID.
10341
10012
  :param workspace_network_option: :class:`WorkspaceNetworkOption`
10013
+ The network option details for the workspace.
10342
10014
 
10343
10015
  :returns: :class:`WorkspaceNetworkOption`
10344
10016
  """