databricks-sdk 0.70.0__py3-none-any.whl → 0.72.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 (36) hide show
  1. databricks/sdk/__init__.py +25 -25
  2. databricks/sdk/mixins/files.py +51 -15
  3. databricks/sdk/service/agentbricks.py +2 -0
  4. databricks/sdk/service/apps.py +10 -0
  5. databricks/sdk/service/billing.py +13 -3
  6. databricks/sdk/service/catalog.py +149 -46
  7. databricks/sdk/service/cleanrooms.py +11 -3
  8. databricks/sdk/service/compute.py +55 -0
  9. databricks/sdk/service/dashboards.py +11 -0
  10. databricks/sdk/service/database.py +12 -0
  11. databricks/sdk/service/dataquality.py +4 -0
  12. databricks/sdk/service/files.py +7 -72
  13. databricks/sdk/service/iam.py +26 -36
  14. databricks/sdk/service/iamv2.py +6 -0
  15. databricks/sdk/service/jobs.py +22 -122
  16. databricks/sdk/service/marketplace.py +18 -0
  17. databricks/sdk/service/ml.py +321 -17
  18. databricks/sdk/service/oauth2.py +10 -18
  19. databricks/sdk/service/pipelines.py +44 -13
  20. databricks/sdk/service/provisioning.py +9 -0
  21. databricks/sdk/service/qualitymonitorv2.py +2 -0
  22. databricks/sdk/service/serving.py +16 -21
  23. databricks/sdk/service/settings.py +43 -72
  24. databricks/sdk/service/settingsv2.py +2 -0
  25. databricks/sdk/service/sharing.py +23 -31
  26. databricks/sdk/service/sql.py +48 -24
  27. databricks/sdk/service/tags.py +2 -0
  28. databricks/sdk/service/vectorsearch.py +11 -1
  29. databricks/sdk/service/workspace.py +18 -91
  30. databricks/sdk/version.py +1 -1
  31. {databricks_sdk-0.70.0.dist-info → databricks_sdk-0.72.0.dist-info}/METADATA +1 -1
  32. {databricks_sdk-0.70.0.dist-info → databricks_sdk-0.72.0.dist-info}/RECORD +36 -36
  33. {databricks_sdk-0.70.0.dist-info → databricks_sdk-0.72.0.dist-info}/WHEEL +0 -0
  34. {databricks_sdk-0.70.0.dist-info → databricks_sdk-0.72.0.dist-info}/licenses/LICENSE +0 -0
  35. {databricks_sdk-0.70.0.dist-info → databricks_sdk-0.72.0.dist-info}/licenses/NOTICE +0 -0
  36. {databricks_sdk-0.70.0.dist-info → databricks_sdk-0.72.0.dist-info}/top_level.txt +0 -0
@@ -1260,7 +1260,7 @@ class CloudflareApiToken:
1260
1260
  secret_access_key: str
1261
1261
  """The secret access token generated for the above access key ID."""
1262
1262
 
1263
- account_id: str
1263
+ account_id: Optional[str] = None
1264
1264
  """The ID of the account associated with the API token."""
1265
1265
 
1266
1266
  def as_dict(self) -> dict:
@@ -1740,7 +1740,7 @@ class ConnectionInfo:
1740
1740
 
1741
1741
 
1742
1742
  class ConnectionType(Enum):
1743
- """Next Id: 46"""
1743
+ """Next Id: 47"""
1744
1744
 
1745
1745
  BIGQUERY = "BIGQUERY"
1746
1746
  DATABRICKS = "DATABRICKS"
@@ -2241,6 +2241,9 @@ class CreateFunctionSqlDataAccess(Enum):
2241
2241
 
2242
2242
  @dataclass
2243
2243
  class CreateMetastoreAssignment:
2244
+ workspace_id: int
2245
+ """A workspace ID."""
2246
+
2244
2247
  metastore_id: str
2245
2248
  """The unique ID of the metastore."""
2246
2249
 
@@ -2248,9 +2251,6 @@ class CreateMetastoreAssignment:
2248
2251
  """The name of the default catalog in the metastore. This field is deprecated. Please use "Default
2249
2252
  Namespace API" to configure the default catalog for a Databricks workspace."""
2250
2253
 
2251
- workspace_id: Optional[int] = None
2252
- """A workspace ID."""
2253
-
2254
2254
  def as_dict(self) -> dict:
2255
2255
  """Serializes the CreateMetastoreAssignment into a dictionary suitable for use as a JSON request body."""
2256
2256
  body = {}
@@ -2726,24 +2726,6 @@ class DatabricksGcpServiceAccountResponse:
2726
2726
  return cls(credential_id=d.get("credential_id", None), email=d.get("email", None))
2727
2727
 
2728
2728
 
2729
- @dataclass
2730
- class DeleteAliasResponse:
2731
- def as_dict(self) -> dict:
2732
- """Serializes the DeleteAliasResponse into a dictionary suitable for use as a JSON request body."""
2733
- body = {}
2734
- return body
2735
-
2736
- def as_shallow_dict(self) -> dict:
2737
- """Serializes the DeleteAliasResponse into a shallow dictionary of its immediate attributes."""
2738
- body = {}
2739
- return body
2740
-
2741
- @classmethod
2742
- def from_dict(cls, d: Dict[str, Any]) -> DeleteAliasResponse:
2743
- """Deserializes the DeleteAliasResponse from a dictionary."""
2744
- return cls()
2745
-
2746
-
2747
2729
  @dataclass
2748
2730
  class DeleteCredentialResponse:
2749
2731
  def as_dict(self) -> dict:
@@ -8550,7 +8532,7 @@ class RowFilterOptions:
8550
8532
 
8551
8533
  @dataclass
8552
8534
  class SchemaInfo:
8553
- """Next ID: 42"""
8535
+ """Next ID: 43"""
8554
8536
 
8555
8537
  browse_only: Optional[bool] = None
8556
8538
  """Indicates whether the principal is limited to retrieving metadata for the associated object
@@ -8763,7 +8745,7 @@ class Securable:
8763
8745
 
8764
8746
 
8765
8747
  class SecurableKind(Enum):
8766
- """Latest kind: CONNECTION_SALESFORCE_OAUTH_MTLS = 268; Next id:269"""
8748
+ """Latest kind: CONNECTION_AWS_SECRETS_MANAGER = 270; Next id:271"""
8767
8749
 
8768
8750
  TABLE_DB_STORAGE = "TABLE_DB_STORAGE"
8769
8751
  TABLE_DELTA = "TABLE_DELTA"
@@ -10071,6 +10053,9 @@ class UpdateCatalogWorkspaceBindingsResponse:
10071
10053
 
10072
10054
  @dataclass
10073
10055
  class UpdateMetastoreAssignment:
10056
+ workspace_id: int
10057
+ """A workspace ID."""
10058
+
10074
10059
  default_catalog_name: Optional[str] = None
10075
10060
  """The name of the default catalog in the metastore. This field is deprecated. Please use "Default
10076
10061
  Namespace API" to configure the default catalog for a Databricks workspace."""
@@ -10078,9 +10063,6 @@ class UpdateMetastoreAssignment:
10078
10063
  metastore_id: Optional[str] = None
10079
10064
  """The unique ID of the metastore."""
10080
10065
 
10081
- workspace_id: Optional[int] = None
10082
- """A workspace ID."""
10083
-
10084
10066
  def as_dict(self) -> dict:
10085
10067
  """Serializes the UpdateMetastoreAssignment into a dictionary suitable for use as a JSON request body."""
10086
10068
  body = {}
@@ -10601,6 +10583,7 @@ class AccountMetastoreAssignmentsAPI:
10601
10583
 
10602
10584
  :returns: :class:`AccountsCreateMetastoreAssignmentResponse`
10603
10585
  """
10586
+
10604
10587
  body = {}
10605
10588
  if metastore_assignment is not None:
10606
10589
  body["metastore_assignment"] = metastore_assignment.as_dict()
@@ -10692,6 +10675,7 @@ class AccountMetastoreAssignmentsAPI:
10692
10675
 
10693
10676
  :returns: :class:`AccountsUpdateMetastoreAssignmentResponse`
10694
10677
  """
10678
+
10695
10679
  body = {}
10696
10680
  if metastore_assignment is not None:
10697
10681
  body["metastore_assignment"] = metastore_assignment.as_dict()
@@ -10723,6 +10707,7 @@ class AccountMetastoresAPI:
10723
10707
 
10724
10708
  :returns: :class:`AccountsCreateMetastoreResponse`
10725
10709
  """
10710
+
10726
10711
  body = {}
10727
10712
  if metastore_info is not None:
10728
10713
  body["metastore_info"] = metastore_info.as_dict()
@@ -10805,6 +10790,7 @@ class AccountMetastoresAPI:
10805
10790
 
10806
10791
  :returns: :class:`AccountsUpdateMetastoreResponse`
10807
10792
  """
10793
+
10808
10794
  body = {}
10809
10795
  if metastore_info is not None:
10810
10796
  body["metastore_info"] = metastore_info.as_dict()
@@ -10848,6 +10834,7 @@ class AccountStorageCredentialsAPI:
10848
10834
 
10849
10835
  :returns: :class:`AccountsCreateStorageCredentialInfo`
10850
10836
  """
10837
+
10851
10838
  body = {}
10852
10839
  if credential_info is not None:
10853
10840
  body["credential_info"] = credential_info.as_dict()
@@ -10962,6 +10949,7 @@ class AccountStorageCredentialsAPI:
10962
10949
 
10963
10950
  :returns: :class:`AccountsUpdateStorageCredentialResponse`
10964
10951
  """
10952
+
10965
10953
  body = {}
10966
10954
  if credential_info is not None:
10967
10955
  body["credential_info"] = credential_info.as_dict()
@@ -11031,6 +11019,7 @@ class ArtifactAllowlistsAPI:
11031
11019
 
11032
11020
  :returns: :class:`ArtifactAllowlistInfo`
11033
11021
  """
11022
+
11034
11023
  body = {}
11035
11024
  if artifact_matchers is not None:
11036
11025
  body["artifact_matchers"] = [v.as_dict() for v in artifact_matchers]
@@ -11098,6 +11087,7 @@ class CatalogsAPI:
11098
11087
 
11099
11088
  :returns: :class:`CatalogInfo`
11100
11089
  """
11090
+
11101
11091
  body = {}
11102
11092
  if comment is not None:
11103
11093
  body["comment"] = comment
@@ -11185,8 +11175,7 @@ class CatalogsAPI:
11185
11175
 
11186
11176
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
11187
11177
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
11188
- absent, which is the only indication that the end of results has been reached. This behavior follows
11189
- Google AIP-158 guidelines.
11178
+ absent, which is the only indication that the end of results has been reached.
11190
11179
 
11191
11180
  :param include_browse: bool (optional)
11192
11181
  Whether to include catalogs in the response for which the principal can only access selective
@@ -11221,6 +11210,8 @@ class CatalogsAPI:
11221
11210
  "Accept": "application/json",
11222
11211
  }
11223
11212
 
11213
+ if "max_results" not in query:
11214
+ query["max_results"] = 0
11224
11215
  while True:
11225
11216
  json = self._api.do("GET", "/api/2.1/unity-catalog/catalogs", query=query, headers=headers)
11226
11217
  if "catalogs" in json:
@@ -11264,6 +11255,7 @@ class CatalogsAPI:
11264
11255
 
11265
11256
  :returns: :class:`CatalogInfo`
11266
11257
  """
11258
+
11267
11259
  body = {}
11268
11260
  if comment is not None:
11269
11261
  body["comment"] = comment
@@ -11331,6 +11323,7 @@ class ConnectionsAPI:
11331
11323
 
11332
11324
  :returns: :class:`ConnectionInfo`
11333
11325
  """
11326
+
11334
11327
  body = {}
11335
11328
  if comment is not None:
11336
11329
  body["comment"] = comment
@@ -11391,8 +11384,7 @@ class ConnectionsAPI:
11391
11384
 
11392
11385
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
11393
11386
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
11394
- absent, which is the only indication that the end of results has been reached. This behavior follows
11395
- Google AIP-158 guidelines.
11387
+ absent, which is the only indication that the end of results has been reached.
11396
11388
 
11397
11389
  :param max_results: int (optional)
11398
11390
  Maximum number of connections to return. - If not set, all connections are returned (not
@@ -11414,6 +11406,8 @@ class ConnectionsAPI:
11414
11406
  "Accept": "application/json",
11415
11407
  }
11416
11408
 
11409
+ if "max_results" not in query:
11410
+ query["max_results"] = 0
11417
11411
  while True:
11418
11412
  json = self._api.do("GET", "/api/2.1/unity-catalog/connections", query=query, headers=headers)
11419
11413
  if "connections" in json:
@@ -11439,6 +11433,7 @@ class ConnectionsAPI:
11439
11433
 
11440
11434
  :returns: :class:`ConnectionInfo`
11441
11435
  """
11436
+
11442
11437
  body = {}
11443
11438
  if new_name is not None:
11444
11439
  body["new_name"] = new_name
@@ -11509,6 +11504,7 @@ class CredentialsAPI:
11509
11504
 
11510
11505
  :returns: :class:`CredentialInfo`
11511
11506
  """
11507
+
11512
11508
  body = {}
11513
11509
  if aws_iam_role is not None:
11514
11510
  body["aws_iam_role"] = aws_iam_role.as_dict()
@@ -11575,6 +11571,7 @@ class CredentialsAPI:
11575
11571
 
11576
11572
  :returns: :class:`TemporaryCredentials`
11577
11573
  """
11574
+
11578
11575
  body = {}
11579
11576
  if azure_options is not None:
11580
11577
  body["azure_options"] = azure_options.as_dict()
@@ -11621,6 +11618,10 @@ class CredentialsAPI:
11621
11618
  is a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a specific
11622
11619
  ordering of the elements in the array.
11623
11620
 
11621
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
11622
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
11623
+ which is the only indication that the end of results has been reached.
11624
+
11624
11625
  :param include_unbound: bool (optional)
11625
11626
  Whether to include credentials not bound to the workspace. Effective only if the user has permission
11626
11627
  to update the credential–workspace binding.
@@ -11709,6 +11710,7 @@ class CredentialsAPI:
11709
11710
 
11710
11711
  :returns: :class:`CredentialInfo`
11711
11712
  """
11713
+
11712
11714
  body = {}
11713
11715
  if aws_iam_role is not None:
11714
11716
  body["aws_iam_role"] = aws_iam_role.as_dict()
@@ -11784,6 +11786,7 @@ class CredentialsAPI:
11784
11786
 
11785
11787
  :returns: :class:`ValidateCredentialResponse`
11786
11788
  """
11789
+
11787
11790
  body = {}
11788
11791
  if aws_iam_role is not None:
11789
11792
  body["aws_iam_role"] = aws_iam_role.as_dict()
@@ -11835,6 +11838,7 @@ class EntityTagAssignmentsAPI:
11835
11838
 
11836
11839
  :returns: :class:`EntityTagAssignment`
11837
11840
  """
11841
+
11838
11842
  body = tag_assignment.as_dict()
11839
11843
  headers = {
11840
11844
  "Accept": "application/json",
@@ -11907,6 +11911,10 @@ class EntityTagAssignmentsAPI:
11907
11911
  ) -> Iterator[EntityTagAssignment]:
11908
11912
  """List tag assignments for an Unity Catalog entity
11909
11913
 
11914
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
11915
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
11916
+ which is the only indication that the end of results has been reached.
11917
+
11910
11918
  :param entity_type: str
11911
11919
  The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables,
11912
11920
  columns, volumes.
@@ -11978,6 +11986,7 @@ class EntityTagAssignmentsAPI:
11978
11986
 
11979
11987
  :returns: :class:`EntityTagAssignment`
11980
11988
  """
11989
+
11981
11990
  body = tag_assignment.as_dict()
11982
11991
  query = {}
11983
11992
  if update_mask is not None:
@@ -12018,6 +12027,7 @@ class ExternalLineageAPI:
12018
12027
 
12019
12028
  :returns: :class:`ExternalLineageRelationship`
12020
12029
  """
12030
+
12021
12031
  body = external_lineage_relationship.as_dict()
12022
12032
  headers = {
12023
12033
  "Accept": "application/json",
@@ -12113,6 +12123,7 @@ class ExternalLineageAPI:
12113
12123
 
12114
12124
  :returns: :class:`ExternalLineageRelationship`
12115
12125
  """
12126
+
12116
12127
  body = external_lineage_relationship.as_dict()
12117
12128
  query = {}
12118
12129
  if update_mask is not None:
@@ -12186,6 +12197,7 @@ class ExternalLocationsAPI:
12186
12197
 
12187
12198
  :returns: :class:`ExternalLocationInfo`
12188
12199
  """
12200
+
12189
12201
  body = {}
12190
12202
  if comment is not None:
12191
12203
  body["comment"] = comment
@@ -12276,8 +12288,7 @@ class ExternalLocationsAPI:
12276
12288
 
12277
12289
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
12278
12290
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
12279
- absent, which is the only indication that the end of results has been reached. This behavior follows
12280
- Google AIP-158 guidelines.
12291
+ absent, which is the only indication that the end of results has been reached.
12281
12292
 
12282
12293
  :param include_browse: bool (optional)
12283
12294
  Whether to include external locations in the response for which the principal can only access
@@ -12309,6 +12320,8 @@ class ExternalLocationsAPI:
12309
12320
  "Accept": "application/json",
12310
12321
  }
12311
12322
 
12323
+ if "max_results" not in query:
12324
+ query["max_results"] = 0
12312
12325
  while True:
12313
12326
  json = self._api.do("GET", "/api/2.1/unity-catalog/external-locations", query=query, headers=headers)
12314
12327
  if "external_locations" in json:
@@ -12372,6 +12385,7 @@ class ExternalLocationsAPI:
12372
12385
 
12373
12386
  :returns: :class:`ExternalLocationInfo`
12374
12387
  """
12388
+
12375
12389
  body = {}
12376
12390
  if comment is not None:
12377
12391
  body["comment"] = comment
@@ -12428,6 +12442,7 @@ class ExternalMetadataAPI:
12428
12442
 
12429
12443
  :returns: :class:`ExternalMetadata`
12430
12444
  """
12445
+
12431
12446
  body = external_metadata.as_dict()
12432
12447
  headers = {
12433
12448
  "Accept": "application/json",
@@ -12527,6 +12542,7 @@ class ExternalMetadataAPI:
12527
12542
 
12528
12543
  :returns: :class:`ExternalMetadata`
12529
12544
  """
12545
+
12530
12546
  body = external_metadata.as_dict()
12531
12547
  query = {}
12532
12548
  if update_mask is not None:
@@ -12566,6 +12582,7 @@ class FunctionsAPI:
12566
12582
 
12567
12583
  :returns: :class:`FunctionInfo`
12568
12584
  """
12585
+
12569
12586
  body = {}
12570
12587
  if function_info is not None:
12571
12588
  body["function_info"] = function_info.as_dict()
@@ -12648,8 +12665,7 @@ class FunctionsAPI:
12648
12665
 
12649
12666
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
12650
12667
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
12651
- absent, which is the only indication that the end of results has been reached. This behavior follows
12652
- Google AIP-158 guidelines.
12668
+ absent, which is the only indication that the end of results has been reached.
12653
12669
 
12654
12670
  :param catalog_name: str
12655
12671
  Name of parent catalog for functions of interest.
@@ -12684,6 +12700,8 @@ class FunctionsAPI:
12684
12700
  "Accept": "application/json",
12685
12701
  }
12686
12702
 
12703
+ if "max_results" not in query:
12704
+ query["max_results"] = 0
12687
12705
  while True:
12688
12706
  json = self._api.do("GET", "/api/2.1/unity-catalog/functions", query=query, headers=headers)
12689
12707
  if "functions" in json:
@@ -12709,6 +12727,7 @@ class FunctionsAPI:
12709
12727
 
12710
12728
  :returns: :class:`FunctionInfo`
12711
12729
  """
12730
+
12712
12731
  body = {}
12713
12732
  if owner is not None:
12714
12733
  body["owner"] = owner
@@ -12746,6 +12765,13 @@ class GrantsAPI:
12746
12765
  ) -> GetPermissionsResponse:
12747
12766
  """Gets the permissions for a securable. Does not include inherited permissions.
12748
12767
 
12768
+ NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
12769
+ will be deprecated soon.
12770
+
12771
+ PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
12772
+ still providing a next_page_token. Clients must continue reading pages until next_page_token is
12773
+ absent, which is the only indication that the end of results has been reached.
12774
+
12749
12775
  :param securable_type: str
12750
12776
  Type of securable.
12751
12777
  :param full_name: str
@@ -12796,6 +12822,13 @@ class GrantsAPI:
12796
12822
  """Gets the effective permissions for a securable. Includes inherited permissions from any parent
12797
12823
  securables.
12798
12824
 
12825
+ NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
12826
+ will be deprecated soon.
12827
+
12828
+ PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
12829
+ still providing a next_page_token. Clients must continue reading pages until next_page_token is
12830
+ absent, which is the only indication that the end of results has been reached.
12831
+
12799
12832
  :param securable_type: str
12800
12833
  Type of securable.
12801
12834
  :param full_name: str
@@ -12853,6 +12886,7 @@ class GrantsAPI:
12853
12886
 
12854
12887
  :returns: :class:`UpdatePermissionsResponse`
12855
12888
  """
12889
+
12856
12890
  body = {}
12857
12891
  if changes is not None:
12858
12892
  body["changes"] = [v.as_dict() for v in changes]
@@ -12898,6 +12932,7 @@ class MetastoresAPI:
12898
12932
 
12899
12933
 
12900
12934
  """
12935
+
12901
12936
  body = {}
12902
12937
  if default_catalog_name is not None:
12903
12938
  body["default_catalog_name"] = default_catalog_name
@@ -12925,6 +12960,7 @@ class MetastoresAPI:
12925
12960
 
12926
12961
  :returns: :class:`MetastoreInfo`
12927
12962
  """
12963
+
12928
12964
  body = {}
12929
12965
  if name is not None:
12930
12966
  body["name"] = name
@@ -13000,8 +13036,7 @@ class MetastoresAPI:
13000
13036
 
13001
13037
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
13002
13038
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
13003
- absent, which is the only indication that the end of results has been reached. This behavior follows
13004
- Google AIP-158 guidelines.
13039
+ absent, which is the only indication that the end of results has been reached.
13005
13040
 
13006
13041
  :param max_results: int (optional)
13007
13042
  Maximum number of metastores to return. - when set to a value greater than 0, the page length is the
@@ -13026,6 +13061,8 @@ class MetastoresAPI:
13026
13061
  "Accept": "application/json",
13027
13062
  }
13028
13063
 
13064
+ if "max_results" not in query:
13065
+ query["max_results"] = 0
13029
13066
  while True:
13030
13067
  json = self._api.do("GET", "/api/2.1/unity-catalog/metastores", query=query, headers=headers)
13031
13068
  if "metastores" in json:
@@ -13107,6 +13144,7 @@ class MetastoresAPI:
13107
13144
 
13108
13145
  :returns: :class:`MetastoreInfo`
13109
13146
  """
13147
+
13110
13148
  body = {}
13111
13149
  if delta_sharing_organization_name is not None:
13112
13150
  body["delta_sharing_organization_name"] = delta_sharing_organization_name
@@ -13150,6 +13188,7 @@ class MetastoresAPI:
13150
13188
 
13151
13189
 
13152
13190
  """
13191
+
13153
13192
  body = {}
13154
13193
  if default_catalog_name is not None:
13155
13194
  body["default_catalog_name"] = default_catalog_name
@@ -13284,6 +13323,10 @@ class ModelVersionsAPI:
13284
13323
  There is no guarantee of a specific ordering of the elements in the response. The elements in the
13285
13324
  response will not contain any aliases or tags.
13286
13325
 
13326
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
13327
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
13328
+ which is the only indication that the end of results has been reached.
13329
+
13287
13330
  :param full_name: str
13288
13331
  The full three-level name of the registered model under which to list model versions
13289
13332
  :param include_browse: bool (optional)
@@ -13397,6 +13440,7 @@ class ModelVersionsAPI:
13397
13440
 
13398
13441
  :returns: :class:`ModelVersionInfo`
13399
13442
  """
13443
+
13400
13444
  body = {}
13401
13445
  if aliases is not None:
13402
13446
  body["aliases"] = [v.as_dict() for v in aliases]
@@ -13488,6 +13532,7 @@ class OnlineTablesAPI:
13488
13532
  Long-running operation waiter for :class:`OnlineTable`.
13489
13533
  See :method:wait_get_online_table_active for more details.
13490
13534
  """
13535
+
13491
13536
  body = table.as_dict()
13492
13537
  headers = {
13493
13538
  "Accept": "application/json",
@@ -13555,6 +13600,7 @@ class PoliciesAPI:
13555
13600
 
13556
13601
  :returns: :class:`PolicyInfo`
13557
13602
  """
13603
+
13558
13604
  body = policy_info.as_dict()
13559
13605
  headers = {
13560
13606
  "Accept": "application/json",
@@ -13624,6 +13670,10 @@ class PoliciesAPI:
13624
13670
  """List all policies defined on a securable. Optionally, the list can include inherited policies defined
13625
13671
  on the securable's parent schema or catalog.
13626
13672
 
13673
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
13674
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
13675
+ which is the only indication that the end of results has been reached.
13676
+
13627
13677
  :param on_securable_type: str
13628
13678
  Required. The type of the securable to list policies for.
13629
13679
  :param on_securable_fullname: str
@@ -13696,6 +13746,7 @@ class PoliciesAPI:
13696
13746
 
13697
13747
  :returns: :class:`PolicyInfo`
13698
13748
  """
13749
+
13699
13750
  body = policy_info.as_dict()
13700
13751
  query = {}
13701
13752
  if update_mask is not None:
@@ -13815,6 +13866,7 @@ class QualityMonitorsAPI:
13815
13866
 
13816
13867
  :returns: :class:`MonitorInfo`
13817
13868
  """
13869
+
13818
13870
  body = {}
13819
13871
  if assets_dir is not None:
13820
13872
  body["assets_dir"] = assets_dir
@@ -13978,6 +14030,7 @@ class QualityMonitorsAPI:
13978
14030
 
13979
14031
  :returns: :class:`RegenerateDashboardResponse`
13980
14032
  """
14033
+
13981
14034
  body = {}
13982
14035
  if warehouse_id is not None:
13983
14036
  body["warehouse_id"] = warehouse_id
@@ -14082,6 +14135,7 @@ class QualityMonitorsAPI:
14082
14135
 
14083
14136
  :returns: :class:`MonitorInfo`
14084
14137
  """
14138
+
14085
14139
  body = {}
14086
14140
  if baseline_table_name is not None:
14087
14141
  body["baseline_table_name"] = baseline_table_name
@@ -14205,6 +14259,7 @@ class RegisteredModelsAPI:
14205
14259
 
14206
14260
  :returns: :class:`RegisteredModelInfo`
14207
14261
  """
14262
+
14208
14263
  body = {}
14209
14264
  if aliases is not None:
14210
14265
  body["aliases"] = [v.as_dict() for v in aliases]
@@ -14330,6 +14385,10 @@ class RegisteredModelsAPI:
14330
14385
 
14331
14386
  There is no guarantee of a specific ordering of the elements in the response.
14332
14387
 
14388
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
14389
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
14390
+ which is the only indication that the end of results has been reached.
14391
+
14333
14392
  :param catalog_name: str (optional)
14334
14393
  The identifier of the catalog under which to list registered models. If specified, schema_name must
14335
14394
  be specified.
@@ -14399,6 +14458,7 @@ class RegisteredModelsAPI:
14399
14458
 
14400
14459
  :returns: :class:`RegisteredModelAlias`
14401
14460
  """
14461
+
14402
14462
  body = {}
14403
14463
  if version_num is not None:
14404
14464
  body["version_num"] = version_num
@@ -14473,6 +14533,7 @@ class RegisteredModelsAPI:
14473
14533
 
14474
14534
  :returns: :class:`RegisteredModelInfo`
14475
14535
  """
14536
+
14476
14537
  body = {}
14477
14538
  if aliases is not None:
14478
14539
  body["aliases"] = [v.as_dict() for v in aliases]
@@ -14555,6 +14616,10 @@ class ResourceQuotasAPI:
14555
14616
  """ListQuotas returns all quota values under the metastore. There are no SLAs on the freshness of the
14556
14617
  counts returned. This API does not trigger a refresh of quota counts.
14557
14618
 
14619
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
14620
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
14621
+ which is the only indication that the end of results has been reached.
14622
+
14558
14623
  :param max_results: int (optional)
14559
14624
  The number of quotas to return.
14560
14625
  :param page_token: str (optional)
@@ -14613,6 +14678,7 @@ class RfaAPI:
14613
14678
 
14614
14679
  :returns: :class:`BatchCreateAccessRequestsResponse`
14615
14680
  """
14681
+
14616
14682
  body = {}
14617
14683
  if requests is not None:
14618
14684
  body["requests"] = [v.as_dict() for v in requests]
@@ -14677,6 +14743,7 @@ class RfaAPI:
14677
14743
 
14678
14744
  :returns: :class:`AccessRequestDestinations`
14679
14745
  """
14746
+
14680
14747
  body = access_request_destinations.as_dict()
14681
14748
  query = {}
14682
14749
  if update_mask is not None:
@@ -14724,6 +14791,7 @@ class SchemasAPI:
14724
14791
 
14725
14792
  :returns: :class:`SchemaInfo`
14726
14793
  """
14794
+
14727
14795
  body = {}
14728
14796
  if catalog_name is not None:
14729
14797
  body["catalog_name"] = catalog_name
@@ -14805,8 +14873,7 @@ class SchemasAPI:
14805
14873
 
14806
14874
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
14807
14875
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
14808
- absent, which is the only indication that the end of results has been reached. This behavior follows
14809
- Google AIP-158 guidelines.
14876
+ absent, which is the only indication that the end of results has been reached.
14810
14877
 
14811
14878
  :param catalog_name: str
14812
14879
  Parent catalog for schemas of interest.
@@ -14837,6 +14904,8 @@ class SchemasAPI:
14837
14904
  "Accept": "application/json",
14838
14905
  }
14839
14906
 
14907
+ if "max_results" not in query:
14908
+ query["max_results"] = 0
14840
14909
  while True:
14841
14910
  json = self._api.do("GET", "/api/2.1/unity-catalog/schemas", query=query, headers=headers)
14842
14911
  if "schemas" in json:
@@ -14876,6 +14945,7 @@ class SchemasAPI:
14876
14945
 
14877
14946
  :returns: :class:`SchemaInfo`
14878
14947
  """
14948
+
14879
14949
  body = {}
14880
14950
  if comment is not None:
14881
14951
  body["comment"] = comment
@@ -14952,6 +15022,7 @@ class StorageCredentialsAPI:
14952
15022
 
14953
15023
  :returns: :class:`StorageCredentialInfo`
14954
15024
  """
15025
+
14955
15026
  body = {}
14956
15027
  if aws_iam_role is not None:
14957
15028
  body["aws_iam_role"] = aws_iam_role.as_dict()
@@ -15035,8 +15106,7 @@ class StorageCredentialsAPI:
15035
15106
 
15036
15107
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
15037
15108
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
15038
- absent, which is the only indication that the end of results has been reached. This behavior follows
15039
- Google AIP-158 guidelines.
15109
+ absent, which is the only indication that the end of results has been reached.
15040
15110
 
15041
15111
  :param include_unbound: bool (optional)
15042
15112
  Whether to include credentials not bound to the workspace. Effective only if the user has permission
@@ -15064,6 +15134,8 @@ class StorageCredentialsAPI:
15064
15134
  "Accept": "application/json",
15065
15135
  }
15066
15136
 
15137
+ if "max_results" not in query:
15138
+ query["max_results"] = 0
15067
15139
  while True:
15068
15140
  json = self._api.do("GET", "/api/2.1/unity-catalog/storage-credentials", query=query, headers=headers)
15069
15141
  if "storage_credentials" in json:
@@ -15125,6 +15197,7 @@ class StorageCredentialsAPI:
15125
15197
 
15126
15198
  :returns: :class:`StorageCredentialInfo`
15127
15199
  """
15200
+
15128
15201
  body = {}
15129
15202
  if aws_iam_role is not None:
15130
15203
  body["aws_iam_role"] = aws_iam_role.as_dict()
@@ -15202,6 +15275,7 @@ class StorageCredentialsAPI:
15202
15275
 
15203
15276
  :returns: :class:`ValidateStorageCredentialResponse`
15204
15277
  """
15278
+
15205
15279
  body = {}
15206
15280
  if aws_iam_role is not None:
15207
15281
  body["aws_iam_role"] = aws_iam_role.as_dict()
@@ -15270,6 +15344,7 @@ class SystemSchemasAPI:
15270
15344
 
15271
15345
 
15272
15346
  """
15347
+
15273
15348
  body = {}
15274
15349
  if catalog_name is not None:
15275
15350
  body["catalog_name"] = catalog_name
@@ -15296,8 +15371,7 @@ class SystemSchemasAPI:
15296
15371
 
15297
15372
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
15298
15373
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
15299
- absent, which is the only indication that the end of results has been reached. This behavior follows
15300
- Google AIP-158 guidelines.
15374
+ absent, which is the only indication that the end of results has been reached.
15301
15375
 
15302
15376
  :param metastore_id: str
15303
15377
  The ID for the metastore in which the system schema resides.
@@ -15321,6 +15395,8 @@ class SystemSchemasAPI:
15321
15395
  "Accept": "application/json",
15322
15396
  }
15323
15397
 
15398
+ if "max_results" not in query:
15399
+ query["max_results"] = 0
15324
15400
  while True:
15325
15401
  json = self._api.do(
15326
15402
  "GET", f"/api/2.1/unity-catalog/metastores/{metastore_id}/systemschemas", query=query, headers=headers
@@ -15364,6 +15440,7 @@ class TableConstraintsAPI:
15364
15440
 
15365
15441
  :returns: :class:`TableConstraint`
15366
15442
  """
15443
+
15367
15444
  body = {}
15368
15445
  if constraint is not None:
15369
15446
  body["constraint"] = constraint.as_dict()
@@ -15471,6 +15548,7 @@ class TablesAPI:
15471
15548
 
15472
15549
  :returns: :class:`TableInfo`
15473
15550
  """
15551
+
15474
15552
  body = {}
15475
15553
  if catalog_name is not None:
15476
15554
  body["catalog_name"] = catalog_name
@@ -15600,8 +15678,7 @@ class TablesAPI:
15600
15678
 
15601
15679
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
15602
15680
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
15603
- absent, which is the only indication that the end of results has been reached. This behavior follows
15604
- Google AIP-158 guidelines.
15681
+ absent, which is the only indication that the end of results has been reached.
15605
15682
 
15606
15683
  :param catalog_name: str
15607
15684
  Name of parent catalog for tables of interest.
@@ -15653,6 +15730,8 @@ class TablesAPI:
15653
15730
  "Accept": "application/json",
15654
15731
  }
15655
15732
 
15733
+ if "max_results" not in query:
15734
+ query["max_results"] = 0
15656
15735
  while True:
15657
15736
  json = self._api.do("GET", "/api/2.1/unity-catalog/tables", query=query, headers=headers)
15658
15737
  if "tables" in json:
@@ -15683,6 +15762,10 @@ class TablesAPI:
15683
15762
 
15684
15763
  There is no guarantee of a specific ordering of the elements in the array.
15685
15764
 
15765
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
15766
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
15767
+ which is the only indication that the end of results has been reached.
15768
+
15686
15769
  :param catalog_name: str
15687
15770
  Name of parent catalog for tables of interest.
15688
15771
  :param include_manifest_capabilities: bool (optional)
@@ -15742,6 +15825,7 @@ class TablesAPI:
15742
15825
 
15743
15826
 
15744
15827
  """
15828
+
15745
15829
  body = {}
15746
15830
  if owner is not None:
15747
15831
  body["owner"] = owner
@@ -15803,6 +15887,7 @@ class TemporaryPathCredentialsAPI:
15803
15887
 
15804
15888
  :returns: :class:`GenerateTemporaryPathCredentialResponse`
15805
15889
  """
15890
+
15806
15891
  body = {}
15807
15892
  if dry_run is not None:
15808
15893
  body["dry_run"] = dry_run
@@ -15853,6 +15938,7 @@ class TemporaryTableCredentialsAPI:
15853
15938
 
15854
15939
  :returns: :class:`GenerateTemporaryTableCredentialResponse`
15855
15940
  """
15941
+
15856
15942
  body = {}
15857
15943
  if operation is not None:
15858
15944
  body["operation"] = operation.value
@@ -15923,6 +16009,7 @@ class VolumesAPI:
15923
16009
 
15924
16010
  :returns: :class:`VolumeInfo`
15925
16011
  """
16012
+
15926
16013
  body = {}
15927
16014
  if catalog_name is not None:
15928
16015
  body["catalog_name"] = catalog_name
@@ -15980,6 +16067,10 @@ class VolumesAPI:
15980
16067
 
15981
16068
  There is no guarantee of a specific ordering of the elements in the array.
15982
16069
 
16070
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
16071
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
16072
+ which is the only indication that the end of results has been reached.
16073
+
15983
16074
  :param catalog_name: str
15984
16075
  The identifier of the catalog
15985
16076
  :param schema_name: str
@@ -16078,6 +16169,7 @@ class VolumesAPI:
16078
16169
 
16079
16170
  :returns: :class:`VolumeInfo`
16080
16171
  """
16172
+
16081
16173
  body = {}
16082
16174
  if comment is not None:
16083
16175
  body["comment"] = comment
@@ -16141,6 +16233,13 @@ class WorkspaceBindingsAPI:
16141
16233
  """Gets workspace bindings of the securable. The caller must be a metastore admin or an owner of the
16142
16234
  securable.
16143
16235
 
16236
+ NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
16237
+ will be deprecated soon.
16238
+
16239
+ PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
16240
+ still providing a next_page_token. Clients must continue reading pages until next_page_token is
16241
+ absent, which is the only indication that the end of results has been reached.
16242
+
16144
16243
  :param securable_type: str
16145
16244
  The type of the securable to bind to a workspace (catalog, storage_credential, credential, or
16146
16245
  external_location).
@@ -16166,6 +16265,8 @@ class WorkspaceBindingsAPI:
16166
16265
  "Accept": "application/json",
16167
16266
  }
16168
16267
 
16268
+ if "max_results" not in query:
16269
+ query["max_results"] = 0
16169
16270
  while True:
16170
16271
  json = self._api.do(
16171
16272
  "GET",
@@ -16199,6 +16300,7 @@ class WorkspaceBindingsAPI:
16199
16300
 
16200
16301
  :returns: :class:`UpdateCatalogWorkspaceBindingsResponse`
16201
16302
  """
16303
+
16202
16304
  body = {}
16203
16305
  if assign_workspaces is not None:
16204
16306
  body["assign_workspaces"] = [v for v in assign_workspaces]
@@ -16239,6 +16341,7 @@ class WorkspaceBindingsAPI:
16239
16341
 
16240
16342
  :returns: :class:`UpdateWorkspaceBindingsResponse`
16241
16343
  """
16344
+
16242
16345
  body = {}
16243
16346
  if add is not None:
16244
16347
  body["add"] = [v.as_dict() for v in add]