databricks-sdk 0.69.0__py3-none-any.whl → 0.71.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 (37) hide show
  1. databricks/sdk/__init__.py +24 -24
  2. databricks/sdk/dbutils.py +17 -0
  3. databricks/sdk/mixins/files.py +10 -10
  4. databricks/sdk/service/agentbricks.py +2 -0
  5. databricks/sdk/service/apps.py +10 -0
  6. databricks/sdk/service/billing.py +13 -3
  7. databricks/sdk/service/catalog.py +131 -47
  8. databricks/sdk/service/cleanrooms.py +11 -3
  9. databricks/sdk/service/compute.py +64 -0
  10. databricks/sdk/service/dashboards.py +10 -0
  11. databricks/sdk/service/database.py +12 -0
  12. databricks/sdk/service/dataquality.py +201 -52
  13. databricks/sdk/service/files.py +7 -72
  14. databricks/sdk/service/iam.py +26 -36
  15. databricks/sdk/service/iamv2.py +6 -0
  16. databricks/sdk/service/jobs.py +86 -154
  17. databricks/sdk/service/marketplace.py +18 -0
  18. databricks/sdk/service/ml.py +464 -13
  19. databricks/sdk/service/oauth2.py +37 -19
  20. databricks/sdk/service/pipelines.py +25 -2
  21. databricks/sdk/service/provisioning.py +19 -1
  22. databricks/sdk/service/qualitymonitorv2.py +2 -0
  23. databricks/sdk/service/serving.py +16 -21
  24. databricks/sdk/service/settings.py +45 -72
  25. databricks/sdk/service/settingsv2.py +2 -0
  26. databricks/sdk/service/sharing.py +23 -69
  27. databricks/sdk/service/sql.py +85 -62
  28. databricks/sdk/service/tags.py +2 -0
  29. databricks/sdk/service/vectorsearch.py +8 -0
  30. databricks/sdk/service/workspace.py +18 -91
  31. databricks/sdk/version.py +1 -1
  32. {databricks_sdk-0.69.0.dist-info → databricks_sdk-0.71.0.dist-info}/METADATA +1 -1
  33. {databricks_sdk-0.69.0.dist-info → databricks_sdk-0.71.0.dist-info}/RECORD +37 -37
  34. {databricks_sdk-0.69.0.dist-info → databricks_sdk-0.71.0.dist-info}/WHEEL +0 -0
  35. {databricks_sdk-0.69.0.dist-info → databricks_sdk-0.71.0.dist-info}/licenses/LICENSE +0 -0
  36. {databricks_sdk-0.69.0.dist-info → databricks_sdk-0.71.0.dist-info}/licenses/NOTICE +0 -0
  37. {databricks_sdk-0.69.0.dist-info → databricks_sdk-0.71.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: 38"""
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 = {}
@@ -2542,12 +2542,13 @@ class CredentialPurpose(Enum):
2542
2542
 
2543
2543
 
2544
2544
  class CredentialType(Enum):
2545
- """Next Id: 13"""
2545
+ """Next Id: 14"""
2546
2546
 
2547
2547
  ANY_STATIC_CREDENTIAL = "ANY_STATIC_CREDENTIAL"
2548
2548
  BEARER_TOKEN = "BEARER_TOKEN"
2549
2549
  OAUTH_ACCESS_TOKEN = "OAUTH_ACCESS_TOKEN"
2550
2550
  OAUTH_M2M = "OAUTH_M2M"
2551
+ OAUTH_MTLS = "OAUTH_MTLS"
2551
2552
  OAUTH_REFRESH_TOKEN = "OAUTH_REFRESH_TOKEN"
2552
2553
  OAUTH_RESOURCE_OWNER_PASSWORD = "OAUTH_RESOURCE_OWNER_PASSWORD"
2553
2554
  OAUTH_U2M = "OAUTH_U2M"
@@ -2725,24 +2726,6 @@ class DatabricksGcpServiceAccountResponse:
2725
2726
  return cls(credential_id=d.get("credential_id", None), email=d.get("email", None))
2726
2727
 
2727
2728
 
2728
- @dataclass
2729
- class DeleteAliasResponse:
2730
- def as_dict(self) -> dict:
2731
- """Serializes the DeleteAliasResponse into a dictionary suitable for use as a JSON request body."""
2732
- body = {}
2733
- return body
2734
-
2735
- def as_shallow_dict(self) -> dict:
2736
- """Serializes the DeleteAliasResponse into a shallow dictionary of its immediate attributes."""
2737
- body = {}
2738
- return body
2739
-
2740
- @classmethod
2741
- def from_dict(cls, d: Dict[str, Any]) -> DeleteAliasResponse:
2742
- """Deserializes the DeleteAliasResponse from a dictionary."""
2743
- return cls()
2744
-
2745
-
2746
2729
  @dataclass
2747
2730
  class DeleteCredentialResponse:
2748
2731
  def as_dict(self) -> dict:
@@ -8549,7 +8532,7 @@ class RowFilterOptions:
8549
8532
 
8550
8533
  @dataclass
8551
8534
  class SchemaInfo:
8552
- """Next ID: 40"""
8535
+ """Next ID: 43"""
8553
8536
 
8554
8537
  browse_only: Optional[bool] = None
8555
8538
  """Indicates whether the principal is limited to retrieving metadata for the associated object
@@ -8762,7 +8745,7 @@ class Securable:
8762
8745
 
8763
8746
 
8764
8747
  class SecurableKind(Enum):
8765
- """Latest kind: CONNECTION_REDSHIFT_IAM = 265; Next id:266"""
8748
+ """Latest kind: CONNECTION_AWS_SECRETS_MANAGER = 270; Next id:271"""
8766
8749
 
8767
8750
  TABLE_DB_STORAGE = "TABLE_DB_STORAGE"
8768
8751
  TABLE_DELTA = "TABLE_DELTA"
@@ -10070,6 +10053,9 @@ class UpdateCatalogWorkspaceBindingsResponse:
10070
10053
 
10071
10054
  @dataclass
10072
10055
  class UpdateMetastoreAssignment:
10056
+ workspace_id: int
10057
+ """A workspace ID."""
10058
+
10073
10059
  default_catalog_name: Optional[str] = None
10074
10060
  """The name of the default catalog in the metastore. This field is deprecated. Please use "Default
10075
10061
  Namespace API" to configure the default catalog for a Databricks workspace."""
@@ -10077,9 +10063,6 @@ class UpdateMetastoreAssignment:
10077
10063
  metastore_id: Optional[str] = None
10078
10064
  """The unique ID of the metastore."""
10079
10065
 
10080
- workspace_id: Optional[int] = None
10081
- """A workspace ID."""
10082
-
10083
10066
  def as_dict(self) -> dict:
10084
10067
  """Serializes the UpdateMetastoreAssignment into a dictionary suitable for use as a JSON request body."""
10085
10068
  body = {}
@@ -10600,6 +10583,7 @@ class AccountMetastoreAssignmentsAPI:
10600
10583
 
10601
10584
  :returns: :class:`AccountsCreateMetastoreAssignmentResponse`
10602
10585
  """
10586
+
10603
10587
  body = {}
10604
10588
  if metastore_assignment is not None:
10605
10589
  body["metastore_assignment"] = metastore_assignment.as_dict()
@@ -10691,6 +10675,7 @@ class AccountMetastoreAssignmentsAPI:
10691
10675
 
10692
10676
  :returns: :class:`AccountsUpdateMetastoreAssignmentResponse`
10693
10677
  """
10678
+
10694
10679
  body = {}
10695
10680
  if metastore_assignment is not None:
10696
10681
  body["metastore_assignment"] = metastore_assignment.as_dict()
@@ -10722,6 +10707,7 @@ class AccountMetastoresAPI:
10722
10707
 
10723
10708
  :returns: :class:`AccountsCreateMetastoreResponse`
10724
10709
  """
10710
+
10725
10711
  body = {}
10726
10712
  if metastore_info is not None:
10727
10713
  body["metastore_info"] = metastore_info.as_dict()
@@ -10804,6 +10790,7 @@ class AccountMetastoresAPI:
10804
10790
 
10805
10791
  :returns: :class:`AccountsUpdateMetastoreResponse`
10806
10792
  """
10793
+
10807
10794
  body = {}
10808
10795
  if metastore_info is not None:
10809
10796
  body["metastore_info"] = metastore_info.as_dict()
@@ -10847,6 +10834,7 @@ class AccountStorageCredentialsAPI:
10847
10834
 
10848
10835
  :returns: :class:`AccountsCreateStorageCredentialInfo`
10849
10836
  """
10837
+
10850
10838
  body = {}
10851
10839
  if credential_info is not None:
10852
10840
  body["credential_info"] = credential_info.as_dict()
@@ -10961,6 +10949,7 @@ class AccountStorageCredentialsAPI:
10961
10949
 
10962
10950
  :returns: :class:`AccountsUpdateStorageCredentialResponse`
10963
10951
  """
10952
+
10964
10953
  body = {}
10965
10954
  if credential_info is not None:
10966
10955
  body["credential_info"] = credential_info.as_dict()
@@ -11030,6 +11019,7 @@ class ArtifactAllowlistsAPI:
11030
11019
 
11031
11020
  :returns: :class:`ArtifactAllowlistInfo`
11032
11021
  """
11022
+
11033
11023
  body = {}
11034
11024
  if artifact_matchers is not None:
11035
11025
  body["artifact_matchers"] = [v.as_dict() for v in artifact_matchers]
@@ -11097,6 +11087,7 @@ class CatalogsAPI:
11097
11087
 
11098
11088
  :returns: :class:`CatalogInfo`
11099
11089
  """
11090
+
11100
11091
  body = {}
11101
11092
  if comment is not None:
11102
11093
  body["comment"] = comment
@@ -11184,8 +11175,7 @@ class CatalogsAPI:
11184
11175
 
11185
11176
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
11186
11177
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
11187
- absent, which is the only indication that the end of results has been reached. This behavior follows
11188
- Google AIP-158 guidelines.
11178
+ absent, which is the only indication that the end of results has been reached.
11189
11179
 
11190
11180
  :param include_browse: bool (optional)
11191
11181
  Whether to include catalogs in the response for which the principal can only access selective
@@ -11263,6 +11253,7 @@ class CatalogsAPI:
11263
11253
 
11264
11254
  :returns: :class:`CatalogInfo`
11265
11255
  """
11256
+
11266
11257
  body = {}
11267
11258
  if comment is not None:
11268
11259
  body["comment"] = comment
@@ -11330,6 +11321,7 @@ class ConnectionsAPI:
11330
11321
 
11331
11322
  :returns: :class:`ConnectionInfo`
11332
11323
  """
11324
+
11333
11325
  body = {}
11334
11326
  if comment is not None:
11335
11327
  body["comment"] = comment
@@ -11390,8 +11382,7 @@ class ConnectionsAPI:
11390
11382
 
11391
11383
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
11392
11384
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
11393
- absent, which is the only indication that the end of results has been reached. This behavior follows
11394
- Google AIP-158 guidelines.
11385
+ absent, which is the only indication that the end of results has been reached.
11395
11386
 
11396
11387
  :param max_results: int (optional)
11397
11388
  Maximum number of connections to return. - If not set, all connections are returned (not
@@ -11438,6 +11429,7 @@ class ConnectionsAPI:
11438
11429
 
11439
11430
  :returns: :class:`ConnectionInfo`
11440
11431
  """
11432
+
11441
11433
  body = {}
11442
11434
  if new_name is not None:
11443
11435
  body["new_name"] = new_name
@@ -11508,6 +11500,7 @@ class CredentialsAPI:
11508
11500
 
11509
11501
  :returns: :class:`CredentialInfo`
11510
11502
  """
11503
+
11511
11504
  body = {}
11512
11505
  if aws_iam_role is not None:
11513
11506
  body["aws_iam_role"] = aws_iam_role.as_dict()
@@ -11574,6 +11567,7 @@ class CredentialsAPI:
11574
11567
 
11575
11568
  :returns: :class:`TemporaryCredentials`
11576
11569
  """
11570
+
11577
11571
  body = {}
11578
11572
  if azure_options is not None:
11579
11573
  body["azure_options"] = azure_options.as_dict()
@@ -11620,6 +11614,10 @@ class CredentialsAPI:
11620
11614
  is a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a specific
11621
11615
  ordering of the elements in the array.
11622
11616
 
11617
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
11618
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
11619
+ which is the only indication that the end of results has been reached.
11620
+
11623
11621
  :param include_unbound: bool (optional)
11624
11622
  Whether to include credentials not bound to the workspace. Effective only if the user has permission
11625
11623
  to update the credential–workspace binding.
@@ -11708,6 +11706,7 @@ class CredentialsAPI:
11708
11706
 
11709
11707
  :returns: :class:`CredentialInfo`
11710
11708
  """
11709
+
11711
11710
  body = {}
11712
11711
  if aws_iam_role is not None:
11713
11712
  body["aws_iam_role"] = aws_iam_role.as_dict()
@@ -11783,6 +11782,7 @@ class CredentialsAPI:
11783
11782
 
11784
11783
  :returns: :class:`ValidateCredentialResponse`
11785
11784
  """
11785
+
11786
11786
  body = {}
11787
11787
  if aws_iam_role is not None:
11788
11788
  body["aws_iam_role"] = aws_iam_role.as_dict()
@@ -11834,6 +11834,7 @@ class EntityTagAssignmentsAPI:
11834
11834
 
11835
11835
  :returns: :class:`EntityTagAssignment`
11836
11836
  """
11837
+
11837
11838
  body = tag_assignment.as_dict()
11838
11839
  headers = {
11839
11840
  "Accept": "application/json",
@@ -11906,6 +11907,10 @@ class EntityTagAssignmentsAPI:
11906
11907
  ) -> Iterator[EntityTagAssignment]:
11907
11908
  """List tag assignments for an Unity Catalog entity
11908
11909
 
11910
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
11911
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
11912
+ which is the only indication that the end of results has been reached.
11913
+
11909
11914
  :param entity_type: str
11910
11915
  The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables,
11911
11916
  columns, volumes.
@@ -11977,6 +11982,7 @@ class EntityTagAssignmentsAPI:
11977
11982
 
11978
11983
  :returns: :class:`EntityTagAssignment`
11979
11984
  """
11985
+
11980
11986
  body = tag_assignment.as_dict()
11981
11987
  query = {}
11982
11988
  if update_mask is not None:
@@ -12017,6 +12023,7 @@ class ExternalLineageAPI:
12017
12023
 
12018
12024
  :returns: :class:`ExternalLineageRelationship`
12019
12025
  """
12026
+
12020
12027
  body = external_lineage_relationship.as_dict()
12021
12028
  headers = {
12022
12029
  "Accept": "application/json",
@@ -12112,6 +12119,7 @@ class ExternalLineageAPI:
12112
12119
 
12113
12120
  :returns: :class:`ExternalLineageRelationship`
12114
12121
  """
12122
+
12115
12123
  body = external_lineage_relationship.as_dict()
12116
12124
  query = {}
12117
12125
  if update_mask is not None:
@@ -12185,6 +12193,7 @@ class ExternalLocationsAPI:
12185
12193
 
12186
12194
  :returns: :class:`ExternalLocationInfo`
12187
12195
  """
12196
+
12188
12197
  body = {}
12189
12198
  if comment is not None:
12190
12199
  body["comment"] = comment
@@ -12275,8 +12284,7 @@ class ExternalLocationsAPI:
12275
12284
 
12276
12285
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
12277
12286
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
12278
- absent, which is the only indication that the end of results has been reached. This behavior follows
12279
- Google AIP-158 guidelines.
12287
+ absent, which is the only indication that the end of results has been reached.
12280
12288
 
12281
12289
  :param include_browse: bool (optional)
12282
12290
  Whether to include external locations in the response for which the principal can only access
@@ -12371,6 +12379,7 @@ class ExternalLocationsAPI:
12371
12379
 
12372
12380
  :returns: :class:`ExternalLocationInfo`
12373
12381
  """
12382
+
12374
12383
  body = {}
12375
12384
  if comment is not None:
12376
12385
  body["comment"] = comment
@@ -12427,6 +12436,7 @@ class ExternalMetadataAPI:
12427
12436
 
12428
12437
  :returns: :class:`ExternalMetadata`
12429
12438
  """
12439
+
12430
12440
  body = external_metadata.as_dict()
12431
12441
  headers = {
12432
12442
  "Accept": "application/json",
@@ -12526,6 +12536,7 @@ class ExternalMetadataAPI:
12526
12536
 
12527
12537
  :returns: :class:`ExternalMetadata`
12528
12538
  """
12539
+
12529
12540
  body = external_metadata.as_dict()
12530
12541
  query = {}
12531
12542
  if update_mask is not None:
@@ -12565,6 +12576,7 @@ class FunctionsAPI:
12565
12576
 
12566
12577
  :returns: :class:`FunctionInfo`
12567
12578
  """
12579
+
12568
12580
  body = {}
12569
12581
  if function_info is not None:
12570
12582
  body["function_info"] = function_info.as_dict()
@@ -12647,8 +12659,7 @@ class FunctionsAPI:
12647
12659
 
12648
12660
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
12649
12661
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
12650
- absent, which is the only indication that the end of results has been reached. This behavior follows
12651
- Google AIP-158 guidelines.
12662
+ absent, which is the only indication that the end of results has been reached.
12652
12663
 
12653
12664
  :param catalog_name: str
12654
12665
  Name of parent catalog for functions of interest.
@@ -12708,6 +12719,7 @@ class FunctionsAPI:
12708
12719
 
12709
12720
  :returns: :class:`FunctionInfo`
12710
12721
  """
12722
+
12711
12723
  body = {}
12712
12724
  if owner is not None:
12713
12725
  body["owner"] = owner
@@ -12745,6 +12757,13 @@ class GrantsAPI:
12745
12757
  ) -> GetPermissionsResponse:
12746
12758
  """Gets the permissions for a securable. Does not include inherited permissions.
12747
12759
 
12760
+ NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
12761
+ will be deprecated soon.
12762
+
12763
+ PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
12764
+ still providing a next_page_token. Clients must continue reading pages until next_page_token is
12765
+ absent, which is the only indication that the end of results has been reached.
12766
+
12748
12767
  :param securable_type: str
12749
12768
  Type of securable.
12750
12769
  :param full_name: str
@@ -12795,6 +12814,13 @@ class GrantsAPI:
12795
12814
  """Gets the effective permissions for a securable. Includes inherited permissions from any parent
12796
12815
  securables.
12797
12816
 
12817
+ NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
12818
+ will be deprecated soon.
12819
+
12820
+ PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
12821
+ still providing a next_page_token. Clients must continue reading pages until next_page_token is
12822
+ absent, which is the only indication that the end of results has been reached.
12823
+
12798
12824
  :param securable_type: str
12799
12825
  Type of securable.
12800
12826
  :param full_name: str
@@ -12852,6 +12878,7 @@ class GrantsAPI:
12852
12878
 
12853
12879
  :returns: :class:`UpdatePermissionsResponse`
12854
12880
  """
12881
+
12855
12882
  body = {}
12856
12883
  if changes is not None:
12857
12884
  body["changes"] = [v.as_dict() for v in changes]
@@ -12897,6 +12924,7 @@ class MetastoresAPI:
12897
12924
 
12898
12925
 
12899
12926
  """
12927
+
12900
12928
  body = {}
12901
12929
  if default_catalog_name is not None:
12902
12930
  body["default_catalog_name"] = default_catalog_name
@@ -12924,6 +12952,7 @@ class MetastoresAPI:
12924
12952
 
12925
12953
  :returns: :class:`MetastoreInfo`
12926
12954
  """
12955
+
12927
12956
  body = {}
12928
12957
  if name is not None:
12929
12958
  body["name"] = name
@@ -12999,8 +13028,7 @@ class MetastoresAPI:
12999
13028
 
13000
13029
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
13001
13030
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
13002
- absent, which is the only indication that the end of results has been reached. This behavior follows
13003
- Google AIP-158 guidelines.
13031
+ absent, which is the only indication that the end of results has been reached.
13004
13032
 
13005
13033
  :param max_results: int (optional)
13006
13034
  Maximum number of metastores to return. - when set to a value greater than 0, the page length is the
@@ -13106,6 +13134,7 @@ class MetastoresAPI:
13106
13134
 
13107
13135
  :returns: :class:`MetastoreInfo`
13108
13136
  """
13137
+
13109
13138
  body = {}
13110
13139
  if delta_sharing_organization_name is not None:
13111
13140
  body["delta_sharing_organization_name"] = delta_sharing_organization_name
@@ -13149,6 +13178,7 @@ class MetastoresAPI:
13149
13178
 
13150
13179
 
13151
13180
  """
13181
+
13152
13182
  body = {}
13153
13183
  if default_catalog_name is not None:
13154
13184
  body["default_catalog_name"] = default_catalog_name
@@ -13283,6 +13313,10 @@ class ModelVersionsAPI:
13283
13313
  There is no guarantee of a specific ordering of the elements in the response. The elements in the
13284
13314
  response will not contain any aliases or tags.
13285
13315
 
13316
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
13317
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
13318
+ which is the only indication that the end of results has been reached.
13319
+
13286
13320
  :param full_name: str
13287
13321
  The full three-level name of the registered model under which to list model versions
13288
13322
  :param include_browse: bool (optional)
@@ -13396,6 +13430,7 @@ class ModelVersionsAPI:
13396
13430
 
13397
13431
  :returns: :class:`ModelVersionInfo`
13398
13432
  """
13433
+
13399
13434
  body = {}
13400
13435
  if aliases is not None:
13401
13436
  body["aliases"] = [v.as_dict() for v in aliases]
@@ -13487,6 +13522,7 @@ class OnlineTablesAPI:
13487
13522
  Long-running operation waiter for :class:`OnlineTable`.
13488
13523
  See :method:wait_get_online_table_active for more details.
13489
13524
  """
13525
+
13490
13526
  body = table.as_dict()
13491
13527
  headers = {
13492
13528
  "Accept": "application/json",
@@ -13554,6 +13590,7 @@ class PoliciesAPI:
13554
13590
 
13555
13591
  :returns: :class:`PolicyInfo`
13556
13592
  """
13593
+
13557
13594
  body = policy_info.as_dict()
13558
13595
  headers = {
13559
13596
  "Accept": "application/json",
@@ -13623,6 +13660,10 @@ class PoliciesAPI:
13623
13660
  """List all policies defined on a securable. Optionally, the list can include inherited policies defined
13624
13661
  on the securable's parent schema or catalog.
13625
13662
 
13663
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
13664
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
13665
+ which is the only indication that the end of results has been reached.
13666
+
13626
13667
  :param on_securable_type: str
13627
13668
  Required. The type of the securable to list policies for.
13628
13669
  :param on_securable_fullname: str
@@ -13695,6 +13736,7 @@ class PoliciesAPI:
13695
13736
 
13696
13737
  :returns: :class:`PolicyInfo`
13697
13738
  """
13739
+
13698
13740
  body = policy_info.as_dict()
13699
13741
  query = {}
13700
13742
  if update_mask is not None:
@@ -13814,6 +13856,7 @@ class QualityMonitorsAPI:
13814
13856
 
13815
13857
  :returns: :class:`MonitorInfo`
13816
13858
  """
13859
+
13817
13860
  body = {}
13818
13861
  if assets_dir is not None:
13819
13862
  body["assets_dir"] = assets_dir
@@ -13977,6 +14020,7 @@ class QualityMonitorsAPI:
13977
14020
 
13978
14021
  :returns: :class:`RegenerateDashboardResponse`
13979
14022
  """
14023
+
13980
14024
  body = {}
13981
14025
  if warehouse_id is not None:
13982
14026
  body["warehouse_id"] = warehouse_id
@@ -14081,6 +14125,7 @@ class QualityMonitorsAPI:
14081
14125
 
14082
14126
  :returns: :class:`MonitorInfo`
14083
14127
  """
14128
+
14084
14129
  body = {}
14085
14130
  if baseline_table_name is not None:
14086
14131
  body["baseline_table_name"] = baseline_table_name
@@ -14204,6 +14249,7 @@ class RegisteredModelsAPI:
14204
14249
 
14205
14250
  :returns: :class:`RegisteredModelInfo`
14206
14251
  """
14252
+
14207
14253
  body = {}
14208
14254
  if aliases is not None:
14209
14255
  body["aliases"] = [v.as_dict() for v in aliases]
@@ -14329,6 +14375,10 @@ class RegisteredModelsAPI:
14329
14375
 
14330
14376
  There is no guarantee of a specific ordering of the elements in the response.
14331
14377
 
14378
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
14379
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
14380
+ which is the only indication that the end of results has been reached.
14381
+
14332
14382
  :param catalog_name: str (optional)
14333
14383
  The identifier of the catalog under which to list registered models. If specified, schema_name must
14334
14384
  be specified.
@@ -14398,6 +14448,7 @@ class RegisteredModelsAPI:
14398
14448
 
14399
14449
  :returns: :class:`RegisteredModelAlias`
14400
14450
  """
14451
+
14401
14452
  body = {}
14402
14453
  if version_num is not None:
14403
14454
  body["version_num"] = version_num
@@ -14472,6 +14523,7 @@ class RegisteredModelsAPI:
14472
14523
 
14473
14524
  :returns: :class:`RegisteredModelInfo`
14474
14525
  """
14526
+
14475
14527
  body = {}
14476
14528
  if aliases is not None:
14477
14529
  body["aliases"] = [v.as_dict() for v in aliases]
@@ -14554,6 +14606,10 @@ class ResourceQuotasAPI:
14554
14606
  """ListQuotas returns all quota values under the metastore. There are no SLAs on the freshness of the
14555
14607
  counts returned. This API does not trigger a refresh of quota counts.
14556
14608
 
14609
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
14610
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
14611
+ which is the only indication that the end of results has been reached.
14612
+
14557
14613
  :param max_results: int (optional)
14558
14614
  The number of quotas to return.
14559
14615
  :param page_token: str (optional)
@@ -14612,6 +14668,7 @@ class RfaAPI:
14612
14668
 
14613
14669
  :returns: :class:`BatchCreateAccessRequestsResponse`
14614
14670
  """
14671
+
14615
14672
  body = {}
14616
14673
  if requests is not None:
14617
14674
  body["requests"] = [v.as_dict() for v in requests]
@@ -14676,6 +14733,7 @@ class RfaAPI:
14676
14733
 
14677
14734
  :returns: :class:`AccessRequestDestinations`
14678
14735
  """
14736
+
14679
14737
  body = access_request_destinations.as_dict()
14680
14738
  query = {}
14681
14739
  if update_mask is not None:
@@ -14723,6 +14781,7 @@ class SchemasAPI:
14723
14781
 
14724
14782
  :returns: :class:`SchemaInfo`
14725
14783
  """
14784
+
14726
14785
  body = {}
14727
14786
  if catalog_name is not None:
14728
14787
  body["catalog_name"] = catalog_name
@@ -14804,8 +14863,7 @@ class SchemasAPI:
14804
14863
 
14805
14864
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
14806
14865
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
14807
- absent, which is the only indication that the end of results has been reached. This behavior follows
14808
- Google AIP-158 guidelines.
14866
+ absent, which is the only indication that the end of results has been reached.
14809
14867
 
14810
14868
  :param catalog_name: str
14811
14869
  Parent catalog for schemas of interest.
@@ -14875,6 +14933,7 @@ class SchemasAPI:
14875
14933
 
14876
14934
  :returns: :class:`SchemaInfo`
14877
14935
  """
14936
+
14878
14937
  body = {}
14879
14938
  if comment is not None:
14880
14939
  body["comment"] = comment
@@ -14951,6 +15010,7 @@ class StorageCredentialsAPI:
14951
15010
 
14952
15011
  :returns: :class:`StorageCredentialInfo`
14953
15012
  """
15013
+
14954
15014
  body = {}
14955
15015
  if aws_iam_role is not None:
14956
15016
  body["aws_iam_role"] = aws_iam_role.as_dict()
@@ -15034,8 +15094,7 @@ class StorageCredentialsAPI:
15034
15094
 
15035
15095
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
15036
15096
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
15037
- absent, which is the only indication that the end of results has been reached. This behavior follows
15038
- Google AIP-158 guidelines.
15097
+ absent, which is the only indication that the end of results has been reached.
15039
15098
 
15040
15099
  :param include_unbound: bool (optional)
15041
15100
  Whether to include credentials not bound to the workspace. Effective only if the user has permission
@@ -15124,6 +15183,7 @@ class StorageCredentialsAPI:
15124
15183
 
15125
15184
  :returns: :class:`StorageCredentialInfo`
15126
15185
  """
15186
+
15127
15187
  body = {}
15128
15188
  if aws_iam_role is not None:
15129
15189
  body["aws_iam_role"] = aws_iam_role.as_dict()
@@ -15201,6 +15261,7 @@ class StorageCredentialsAPI:
15201
15261
 
15202
15262
  :returns: :class:`ValidateStorageCredentialResponse`
15203
15263
  """
15264
+
15204
15265
  body = {}
15205
15266
  if aws_iam_role is not None:
15206
15267
  body["aws_iam_role"] = aws_iam_role.as_dict()
@@ -15269,6 +15330,7 @@ class SystemSchemasAPI:
15269
15330
 
15270
15331
 
15271
15332
  """
15333
+
15272
15334
  body = {}
15273
15335
  if catalog_name is not None:
15274
15336
  body["catalog_name"] = catalog_name
@@ -15295,8 +15357,7 @@ class SystemSchemasAPI:
15295
15357
 
15296
15358
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
15297
15359
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
15298
- absent, which is the only indication that the end of results has been reached. This behavior follows
15299
- Google AIP-158 guidelines.
15360
+ absent, which is the only indication that the end of results has been reached.
15300
15361
 
15301
15362
  :param metastore_id: str
15302
15363
  The ID for the metastore in which the system schema resides.
@@ -15363,6 +15424,7 @@ class TableConstraintsAPI:
15363
15424
 
15364
15425
  :returns: :class:`TableConstraint`
15365
15426
  """
15427
+
15366
15428
  body = {}
15367
15429
  if constraint is not None:
15368
15430
  body["constraint"] = constraint.as_dict()
@@ -15470,6 +15532,7 @@ class TablesAPI:
15470
15532
 
15471
15533
  :returns: :class:`TableInfo`
15472
15534
  """
15535
+
15473
15536
  body = {}
15474
15537
  if catalog_name is not None:
15475
15538
  body["catalog_name"] = catalog_name
@@ -15599,8 +15662,7 @@ class TablesAPI:
15599
15662
 
15600
15663
  PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
15601
15664
  still providing a next_page_token. Clients must continue reading pages until next_page_token is
15602
- absent, which is the only indication that the end of results has been reached. This behavior follows
15603
- Google AIP-158 guidelines.
15665
+ absent, which is the only indication that the end of results has been reached.
15604
15666
 
15605
15667
  :param catalog_name: str
15606
15668
  Name of parent catalog for tables of interest.
@@ -15682,6 +15744,10 @@ class TablesAPI:
15682
15744
 
15683
15745
  There is no guarantee of a specific ordering of the elements in the array.
15684
15746
 
15747
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
15748
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
15749
+ which is the only indication that the end of results has been reached.
15750
+
15685
15751
  :param catalog_name: str
15686
15752
  Name of parent catalog for tables of interest.
15687
15753
  :param include_manifest_capabilities: bool (optional)
@@ -15741,6 +15807,7 @@ class TablesAPI:
15741
15807
 
15742
15808
 
15743
15809
  """
15810
+
15744
15811
  body = {}
15745
15812
  if owner is not None:
15746
15813
  body["owner"] = owner
@@ -15802,6 +15869,7 @@ class TemporaryPathCredentialsAPI:
15802
15869
 
15803
15870
  :returns: :class:`GenerateTemporaryPathCredentialResponse`
15804
15871
  """
15872
+
15805
15873
  body = {}
15806
15874
  if dry_run is not None:
15807
15875
  body["dry_run"] = dry_run
@@ -15852,6 +15920,7 @@ class TemporaryTableCredentialsAPI:
15852
15920
 
15853
15921
  :returns: :class:`GenerateTemporaryTableCredentialResponse`
15854
15922
  """
15923
+
15855
15924
  body = {}
15856
15925
  if operation is not None:
15857
15926
  body["operation"] = operation.value
@@ -15922,6 +15991,7 @@ class VolumesAPI:
15922
15991
 
15923
15992
  :returns: :class:`VolumeInfo`
15924
15993
  """
15994
+
15925
15995
  body = {}
15926
15996
  if catalog_name is not None:
15927
15997
  body["catalog_name"] = catalog_name
@@ -15979,6 +16049,10 @@ class VolumesAPI:
15979
16049
 
15980
16050
  There is no guarantee of a specific ordering of the elements in the array.
15981
16051
 
16052
+ PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still
16053
+ providing a next_page_token. Clients must continue reading pages until next_page_token is absent,
16054
+ which is the only indication that the end of results has been reached.
16055
+
15982
16056
  :param catalog_name: str
15983
16057
  The identifier of the catalog
15984
16058
  :param schema_name: str
@@ -16077,6 +16151,7 @@ class VolumesAPI:
16077
16151
 
16078
16152
  :returns: :class:`VolumeInfo`
16079
16153
  """
16154
+
16080
16155
  body = {}
16081
16156
  if comment is not None:
16082
16157
  body["comment"] = comment
@@ -16140,6 +16215,13 @@ class WorkspaceBindingsAPI:
16140
16215
  """Gets workspace bindings of the securable. The caller must be a metastore admin or an owner of the
16141
16216
  securable.
16142
16217
 
16218
+ NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
16219
+ will be deprecated soon.
16220
+
16221
+ PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
16222
+ still providing a next_page_token. Clients must continue reading pages until next_page_token is
16223
+ absent, which is the only indication that the end of results has been reached.
16224
+
16143
16225
  :param securable_type: str
16144
16226
  The type of the securable to bind to a workspace (catalog, storage_credential, credential, or
16145
16227
  external_location).
@@ -16198,6 +16280,7 @@ class WorkspaceBindingsAPI:
16198
16280
 
16199
16281
  :returns: :class:`UpdateCatalogWorkspaceBindingsResponse`
16200
16282
  """
16283
+
16201
16284
  body = {}
16202
16285
  if assign_workspaces is not None:
16203
16286
  body["assign_workspaces"] = [v for v in assign_workspaces]
@@ -16238,6 +16321,7 @@ class WorkspaceBindingsAPI:
16238
16321
 
16239
16322
  :returns: :class:`UpdateWorkspaceBindingsResponse`
16240
16323
  """
16324
+
16241
16325
  body = {}
16242
16326
  if add is not None:
16243
16327
  body["add"] = [v.as_dict() for v in add]