databricks-sdk 0.70.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.
- databricks/sdk/__init__.py +24 -24
- databricks/sdk/mixins/files.py +10 -10
- databricks/sdk/service/agentbricks.py +2 -0
- databricks/sdk/service/apps.py +10 -0
- databricks/sdk/service/billing.py +13 -3
- databricks/sdk/service/catalog.py +129 -46
- databricks/sdk/service/cleanrooms.py +11 -3
- databricks/sdk/service/compute.py +54 -0
- databricks/sdk/service/dashboards.py +10 -0
- databricks/sdk/service/database.py +12 -0
- databricks/sdk/service/dataquality.py +4 -0
- databricks/sdk/service/files.py +7 -72
- databricks/sdk/service/iam.py +26 -36
- databricks/sdk/service/iamv2.py +6 -0
- databricks/sdk/service/jobs.py +13 -116
- databricks/sdk/service/marketplace.py +18 -0
- databricks/sdk/service/ml.py +171 -17
- databricks/sdk/service/oauth2.py +10 -18
- databricks/sdk/service/pipelines.py +23 -0
- databricks/sdk/service/provisioning.py +9 -0
- databricks/sdk/service/qualitymonitorv2.py +2 -0
- databricks/sdk/service/serving.py +16 -21
- databricks/sdk/service/settings.py +43 -72
- databricks/sdk/service/settingsv2.py +2 -0
- databricks/sdk/service/sharing.py +23 -31
- databricks/sdk/service/sql.py +48 -24
- databricks/sdk/service/tags.py +2 -0
- databricks/sdk/service/vectorsearch.py +8 -0
- databricks/sdk/service/workspace.py +18 -91
- databricks/sdk/version.py +1 -1
- {databricks_sdk-0.70.0.dist-info → databricks_sdk-0.71.0.dist-info}/METADATA +1 -1
- {databricks_sdk-0.70.0.dist-info → databricks_sdk-0.71.0.dist-info}/RECORD +36 -36
- {databricks_sdk-0.70.0.dist-info → databricks_sdk-0.71.0.dist-info}/WHEEL +0 -0
- {databricks_sdk-0.70.0.dist-info → databricks_sdk-0.71.0.dist-info}/licenses/LICENSE +0 -0
- {databricks_sdk-0.70.0.dist-info → databricks_sdk-0.71.0.dist-info}/licenses/NOTICE +0 -0
- {databricks_sdk-0.70.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:
|
|
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:
|
|
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:
|
|
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.
|
|
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
|
|
@@ -11264,6 +11253,7 @@ class CatalogsAPI:
|
|
|
11264
11253
|
|
|
11265
11254
|
:returns: :class:`CatalogInfo`
|
|
11266
11255
|
"""
|
|
11256
|
+
|
|
11267
11257
|
body = {}
|
|
11268
11258
|
if comment is not None:
|
|
11269
11259
|
body["comment"] = comment
|
|
@@ -11331,6 +11321,7 @@ class ConnectionsAPI:
|
|
|
11331
11321
|
|
|
11332
11322
|
:returns: :class:`ConnectionInfo`
|
|
11333
11323
|
"""
|
|
11324
|
+
|
|
11334
11325
|
body = {}
|
|
11335
11326
|
if comment is not None:
|
|
11336
11327
|
body["comment"] = comment
|
|
@@ -11391,8 +11382,7 @@ class ConnectionsAPI:
|
|
|
11391
11382
|
|
|
11392
11383
|
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
|
|
11393
11384
|
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.
|
|
11395
|
-
Google AIP-158 guidelines.
|
|
11385
|
+
absent, which is the only indication that the end of results has been reached.
|
|
11396
11386
|
|
|
11397
11387
|
:param max_results: int (optional)
|
|
11398
11388
|
Maximum number of connections to return. - If not set, all connections are returned (not
|
|
@@ -11439,6 +11429,7 @@ class ConnectionsAPI:
|
|
|
11439
11429
|
|
|
11440
11430
|
:returns: :class:`ConnectionInfo`
|
|
11441
11431
|
"""
|
|
11432
|
+
|
|
11442
11433
|
body = {}
|
|
11443
11434
|
if new_name is not None:
|
|
11444
11435
|
body["new_name"] = new_name
|
|
@@ -11509,6 +11500,7 @@ class CredentialsAPI:
|
|
|
11509
11500
|
|
|
11510
11501
|
:returns: :class:`CredentialInfo`
|
|
11511
11502
|
"""
|
|
11503
|
+
|
|
11512
11504
|
body = {}
|
|
11513
11505
|
if aws_iam_role is not None:
|
|
11514
11506
|
body["aws_iam_role"] = aws_iam_role.as_dict()
|
|
@@ -11575,6 +11567,7 @@ class CredentialsAPI:
|
|
|
11575
11567
|
|
|
11576
11568
|
:returns: :class:`TemporaryCredentials`
|
|
11577
11569
|
"""
|
|
11570
|
+
|
|
11578
11571
|
body = {}
|
|
11579
11572
|
if azure_options is not None:
|
|
11580
11573
|
body["azure_options"] = azure_options.as_dict()
|
|
@@ -11621,6 +11614,10 @@ class CredentialsAPI:
|
|
|
11621
11614
|
is a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a specific
|
|
11622
11615
|
ordering of the elements in the array.
|
|
11623
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
|
+
|
|
11624
11621
|
:param include_unbound: bool (optional)
|
|
11625
11622
|
Whether to include credentials not bound to the workspace. Effective only if the user has permission
|
|
11626
11623
|
to update the credential–workspace binding.
|
|
@@ -11709,6 +11706,7 @@ class CredentialsAPI:
|
|
|
11709
11706
|
|
|
11710
11707
|
:returns: :class:`CredentialInfo`
|
|
11711
11708
|
"""
|
|
11709
|
+
|
|
11712
11710
|
body = {}
|
|
11713
11711
|
if aws_iam_role is not None:
|
|
11714
11712
|
body["aws_iam_role"] = aws_iam_role.as_dict()
|
|
@@ -11784,6 +11782,7 @@ class CredentialsAPI:
|
|
|
11784
11782
|
|
|
11785
11783
|
:returns: :class:`ValidateCredentialResponse`
|
|
11786
11784
|
"""
|
|
11785
|
+
|
|
11787
11786
|
body = {}
|
|
11788
11787
|
if aws_iam_role is not None:
|
|
11789
11788
|
body["aws_iam_role"] = aws_iam_role.as_dict()
|
|
@@ -11835,6 +11834,7 @@ class EntityTagAssignmentsAPI:
|
|
|
11835
11834
|
|
|
11836
11835
|
:returns: :class:`EntityTagAssignment`
|
|
11837
11836
|
"""
|
|
11837
|
+
|
|
11838
11838
|
body = tag_assignment.as_dict()
|
|
11839
11839
|
headers = {
|
|
11840
11840
|
"Accept": "application/json",
|
|
@@ -11907,6 +11907,10 @@ class EntityTagAssignmentsAPI:
|
|
|
11907
11907
|
) -> Iterator[EntityTagAssignment]:
|
|
11908
11908
|
"""List tag assignments for an Unity Catalog entity
|
|
11909
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
|
+
|
|
11910
11914
|
:param entity_type: str
|
|
11911
11915
|
The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables,
|
|
11912
11916
|
columns, volumes.
|
|
@@ -11978,6 +11982,7 @@ class EntityTagAssignmentsAPI:
|
|
|
11978
11982
|
|
|
11979
11983
|
:returns: :class:`EntityTagAssignment`
|
|
11980
11984
|
"""
|
|
11985
|
+
|
|
11981
11986
|
body = tag_assignment.as_dict()
|
|
11982
11987
|
query = {}
|
|
11983
11988
|
if update_mask is not None:
|
|
@@ -12018,6 +12023,7 @@ class ExternalLineageAPI:
|
|
|
12018
12023
|
|
|
12019
12024
|
:returns: :class:`ExternalLineageRelationship`
|
|
12020
12025
|
"""
|
|
12026
|
+
|
|
12021
12027
|
body = external_lineage_relationship.as_dict()
|
|
12022
12028
|
headers = {
|
|
12023
12029
|
"Accept": "application/json",
|
|
@@ -12113,6 +12119,7 @@ class ExternalLineageAPI:
|
|
|
12113
12119
|
|
|
12114
12120
|
:returns: :class:`ExternalLineageRelationship`
|
|
12115
12121
|
"""
|
|
12122
|
+
|
|
12116
12123
|
body = external_lineage_relationship.as_dict()
|
|
12117
12124
|
query = {}
|
|
12118
12125
|
if update_mask is not None:
|
|
@@ -12186,6 +12193,7 @@ class ExternalLocationsAPI:
|
|
|
12186
12193
|
|
|
12187
12194
|
:returns: :class:`ExternalLocationInfo`
|
|
12188
12195
|
"""
|
|
12196
|
+
|
|
12189
12197
|
body = {}
|
|
12190
12198
|
if comment is not None:
|
|
12191
12199
|
body["comment"] = comment
|
|
@@ -12276,8 +12284,7 @@ class ExternalLocationsAPI:
|
|
|
12276
12284
|
|
|
12277
12285
|
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
|
|
12278
12286
|
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.
|
|
12280
|
-
Google AIP-158 guidelines.
|
|
12287
|
+
absent, which is the only indication that the end of results has been reached.
|
|
12281
12288
|
|
|
12282
12289
|
:param include_browse: bool (optional)
|
|
12283
12290
|
Whether to include external locations in the response for which the principal can only access
|
|
@@ -12372,6 +12379,7 @@ class ExternalLocationsAPI:
|
|
|
12372
12379
|
|
|
12373
12380
|
:returns: :class:`ExternalLocationInfo`
|
|
12374
12381
|
"""
|
|
12382
|
+
|
|
12375
12383
|
body = {}
|
|
12376
12384
|
if comment is not None:
|
|
12377
12385
|
body["comment"] = comment
|
|
@@ -12428,6 +12436,7 @@ class ExternalMetadataAPI:
|
|
|
12428
12436
|
|
|
12429
12437
|
:returns: :class:`ExternalMetadata`
|
|
12430
12438
|
"""
|
|
12439
|
+
|
|
12431
12440
|
body = external_metadata.as_dict()
|
|
12432
12441
|
headers = {
|
|
12433
12442
|
"Accept": "application/json",
|
|
@@ -12527,6 +12536,7 @@ class ExternalMetadataAPI:
|
|
|
12527
12536
|
|
|
12528
12537
|
:returns: :class:`ExternalMetadata`
|
|
12529
12538
|
"""
|
|
12539
|
+
|
|
12530
12540
|
body = external_metadata.as_dict()
|
|
12531
12541
|
query = {}
|
|
12532
12542
|
if update_mask is not None:
|
|
@@ -12566,6 +12576,7 @@ class FunctionsAPI:
|
|
|
12566
12576
|
|
|
12567
12577
|
:returns: :class:`FunctionInfo`
|
|
12568
12578
|
"""
|
|
12579
|
+
|
|
12569
12580
|
body = {}
|
|
12570
12581
|
if function_info is not None:
|
|
12571
12582
|
body["function_info"] = function_info.as_dict()
|
|
@@ -12648,8 +12659,7 @@ class FunctionsAPI:
|
|
|
12648
12659
|
|
|
12649
12660
|
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
|
|
12650
12661
|
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.
|
|
12652
|
-
Google AIP-158 guidelines.
|
|
12662
|
+
absent, which is the only indication that the end of results has been reached.
|
|
12653
12663
|
|
|
12654
12664
|
:param catalog_name: str
|
|
12655
12665
|
Name of parent catalog for functions of interest.
|
|
@@ -12709,6 +12719,7 @@ class FunctionsAPI:
|
|
|
12709
12719
|
|
|
12710
12720
|
:returns: :class:`FunctionInfo`
|
|
12711
12721
|
"""
|
|
12722
|
+
|
|
12712
12723
|
body = {}
|
|
12713
12724
|
if owner is not None:
|
|
12714
12725
|
body["owner"] = owner
|
|
@@ -12746,6 +12757,13 @@ class GrantsAPI:
|
|
|
12746
12757
|
) -> GetPermissionsResponse:
|
|
12747
12758
|
"""Gets the permissions for a securable. Does not include inherited permissions.
|
|
12748
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
|
+
|
|
12749
12767
|
:param securable_type: str
|
|
12750
12768
|
Type of securable.
|
|
12751
12769
|
:param full_name: str
|
|
@@ -12796,6 +12814,13 @@ class GrantsAPI:
|
|
|
12796
12814
|
"""Gets the effective permissions for a securable. Includes inherited permissions from any parent
|
|
12797
12815
|
securables.
|
|
12798
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
|
+
|
|
12799
12824
|
:param securable_type: str
|
|
12800
12825
|
Type of securable.
|
|
12801
12826
|
:param full_name: str
|
|
@@ -12853,6 +12878,7 @@ class GrantsAPI:
|
|
|
12853
12878
|
|
|
12854
12879
|
:returns: :class:`UpdatePermissionsResponse`
|
|
12855
12880
|
"""
|
|
12881
|
+
|
|
12856
12882
|
body = {}
|
|
12857
12883
|
if changes is not None:
|
|
12858
12884
|
body["changes"] = [v.as_dict() for v in changes]
|
|
@@ -12898,6 +12924,7 @@ class MetastoresAPI:
|
|
|
12898
12924
|
|
|
12899
12925
|
|
|
12900
12926
|
"""
|
|
12927
|
+
|
|
12901
12928
|
body = {}
|
|
12902
12929
|
if default_catalog_name is not None:
|
|
12903
12930
|
body["default_catalog_name"] = default_catalog_name
|
|
@@ -12925,6 +12952,7 @@ class MetastoresAPI:
|
|
|
12925
12952
|
|
|
12926
12953
|
:returns: :class:`MetastoreInfo`
|
|
12927
12954
|
"""
|
|
12955
|
+
|
|
12928
12956
|
body = {}
|
|
12929
12957
|
if name is not None:
|
|
12930
12958
|
body["name"] = name
|
|
@@ -13000,8 +13028,7 @@ class MetastoresAPI:
|
|
|
13000
13028
|
|
|
13001
13029
|
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
|
|
13002
13030
|
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.
|
|
13004
|
-
Google AIP-158 guidelines.
|
|
13031
|
+
absent, which is the only indication that the end of results has been reached.
|
|
13005
13032
|
|
|
13006
13033
|
:param max_results: int (optional)
|
|
13007
13034
|
Maximum number of metastores to return. - when set to a value greater than 0, the page length is the
|
|
@@ -13107,6 +13134,7 @@ class MetastoresAPI:
|
|
|
13107
13134
|
|
|
13108
13135
|
:returns: :class:`MetastoreInfo`
|
|
13109
13136
|
"""
|
|
13137
|
+
|
|
13110
13138
|
body = {}
|
|
13111
13139
|
if delta_sharing_organization_name is not None:
|
|
13112
13140
|
body["delta_sharing_organization_name"] = delta_sharing_organization_name
|
|
@@ -13150,6 +13178,7 @@ class MetastoresAPI:
|
|
|
13150
13178
|
|
|
13151
13179
|
|
|
13152
13180
|
"""
|
|
13181
|
+
|
|
13153
13182
|
body = {}
|
|
13154
13183
|
if default_catalog_name is not None:
|
|
13155
13184
|
body["default_catalog_name"] = default_catalog_name
|
|
@@ -13284,6 +13313,10 @@ class ModelVersionsAPI:
|
|
|
13284
13313
|
There is no guarantee of a specific ordering of the elements in the response. The elements in the
|
|
13285
13314
|
response will not contain any aliases or tags.
|
|
13286
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
|
+
|
|
13287
13320
|
:param full_name: str
|
|
13288
13321
|
The full three-level name of the registered model under which to list model versions
|
|
13289
13322
|
:param include_browse: bool (optional)
|
|
@@ -13397,6 +13430,7 @@ class ModelVersionsAPI:
|
|
|
13397
13430
|
|
|
13398
13431
|
:returns: :class:`ModelVersionInfo`
|
|
13399
13432
|
"""
|
|
13433
|
+
|
|
13400
13434
|
body = {}
|
|
13401
13435
|
if aliases is not None:
|
|
13402
13436
|
body["aliases"] = [v.as_dict() for v in aliases]
|
|
@@ -13488,6 +13522,7 @@ class OnlineTablesAPI:
|
|
|
13488
13522
|
Long-running operation waiter for :class:`OnlineTable`.
|
|
13489
13523
|
See :method:wait_get_online_table_active for more details.
|
|
13490
13524
|
"""
|
|
13525
|
+
|
|
13491
13526
|
body = table.as_dict()
|
|
13492
13527
|
headers = {
|
|
13493
13528
|
"Accept": "application/json",
|
|
@@ -13555,6 +13590,7 @@ class PoliciesAPI:
|
|
|
13555
13590
|
|
|
13556
13591
|
:returns: :class:`PolicyInfo`
|
|
13557
13592
|
"""
|
|
13593
|
+
|
|
13558
13594
|
body = policy_info.as_dict()
|
|
13559
13595
|
headers = {
|
|
13560
13596
|
"Accept": "application/json",
|
|
@@ -13624,6 +13660,10 @@ class PoliciesAPI:
|
|
|
13624
13660
|
"""List all policies defined on a securable. Optionally, the list can include inherited policies defined
|
|
13625
13661
|
on the securable's parent schema or catalog.
|
|
13626
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
|
+
|
|
13627
13667
|
:param on_securable_type: str
|
|
13628
13668
|
Required. The type of the securable to list policies for.
|
|
13629
13669
|
:param on_securable_fullname: str
|
|
@@ -13696,6 +13736,7 @@ class PoliciesAPI:
|
|
|
13696
13736
|
|
|
13697
13737
|
:returns: :class:`PolicyInfo`
|
|
13698
13738
|
"""
|
|
13739
|
+
|
|
13699
13740
|
body = policy_info.as_dict()
|
|
13700
13741
|
query = {}
|
|
13701
13742
|
if update_mask is not None:
|
|
@@ -13815,6 +13856,7 @@ class QualityMonitorsAPI:
|
|
|
13815
13856
|
|
|
13816
13857
|
:returns: :class:`MonitorInfo`
|
|
13817
13858
|
"""
|
|
13859
|
+
|
|
13818
13860
|
body = {}
|
|
13819
13861
|
if assets_dir is not None:
|
|
13820
13862
|
body["assets_dir"] = assets_dir
|
|
@@ -13978,6 +14020,7 @@ class QualityMonitorsAPI:
|
|
|
13978
14020
|
|
|
13979
14021
|
:returns: :class:`RegenerateDashboardResponse`
|
|
13980
14022
|
"""
|
|
14023
|
+
|
|
13981
14024
|
body = {}
|
|
13982
14025
|
if warehouse_id is not None:
|
|
13983
14026
|
body["warehouse_id"] = warehouse_id
|
|
@@ -14082,6 +14125,7 @@ class QualityMonitorsAPI:
|
|
|
14082
14125
|
|
|
14083
14126
|
:returns: :class:`MonitorInfo`
|
|
14084
14127
|
"""
|
|
14128
|
+
|
|
14085
14129
|
body = {}
|
|
14086
14130
|
if baseline_table_name is not None:
|
|
14087
14131
|
body["baseline_table_name"] = baseline_table_name
|
|
@@ -14205,6 +14249,7 @@ class RegisteredModelsAPI:
|
|
|
14205
14249
|
|
|
14206
14250
|
:returns: :class:`RegisteredModelInfo`
|
|
14207
14251
|
"""
|
|
14252
|
+
|
|
14208
14253
|
body = {}
|
|
14209
14254
|
if aliases is not None:
|
|
14210
14255
|
body["aliases"] = [v.as_dict() for v in aliases]
|
|
@@ -14330,6 +14375,10 @@ class RegisteredModelsAPI:
|
|
|
14330
14375
|
|
|
14331
14376
|
There is no guarantee of a specific ordering of the elements in the response.
|
|
14332
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
|
+
|
|
14333
14382
|
:param catalog_name: str (optional)
|
|
14334
14383
|
The identifier of the catalog under which to list registered models. If specified, schema_name must
|
|
14335
14384
|
be specified.
|
|
@@ -14399,6 +14448,7 @@ class RegisteredModelsAPI:
|
|
|
14399
14448
|
|
|
14400
14449
|
:returns: :class:`RegisteredModelAlias`
|
|
14401
14450
|
"""
|
|
14451
|
+
|
|
14402
14452
|
body = {}
|
|
14403
14453
|
if version_num is not None:
|
|
14404
14454
|
body["version_num"] = version_num
|
|
@@ -14473,6 +14523,7 @@ class RegisteredModelsAPI:
|
|
|
14473
14523
|
|
|
14474
14524
|
:returns: :class:`RegisteredModelInfo`
|
|
14475
14525
|
"""
|
|
14526
|
+
|
|
14476
14527
|
body = {}
|
|
14477
14528
|
if aliases is not None:
|
|
14478
14529
|
body["aliases"] = [v.as_dict() for v in aliases]
|
|
@@ -14555,6 +14606,10 @@ class ResourceQuotasAPI:
|
|
|
14555
14606
|
"""ListQuotas returns all quota values under the metastore. There are no SLAs on the freshness of the
|
|
14556
14607
|
counts returned. This API does not trigger a refresh of quota counts.
|
|
14557
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
|
+
|
|
14558
14613
|
:param max_results: int (optional)
|
|
14559
14614
|
The number of quotas to return.
|
|
14560
14615
|
:param page_token: str (optional)
|
|
@@ -14613,6 +14668,7 @@ class RfaAPI:
|
|
|
14613
14668
|
|
|
14614
14669
|
:returns: :class:`BatchCreateAccessRequestsResponse`
|
|
14615
14670
|
"""
|
|
14671
|
+
|
|
14616
14672
|
body = {}
|
|
14617
14673
|
if requests is not None:
|
|
14618
14674
|
body["requests"] = [v.as_dict() for v in requests]
|
|
@@ -14677,6 +14733,7 @@ class RfaAPI:
|
|
|
14677
14733
|
|
|
14678
14734
|
:returns: :class:`AccessRequestDestinations`
|
|
14679
14735
|
"""
|
|
14736
|
+
|
|
14680
14737
|
body = access_request_destinations.as_dict()
|
|
14681
14738
|
query = {}
|
|
14682
14739
|
if update_mask is not None:
|
|
@@ -14724,6 +14781,7 @@ class SchemasAPI:
|
|
|
14724
14781
|
|
|
14725
14782
|
:returns: :class:`SchemaInfo`
|
|
14726
14783
|
"""
|
|
14784
|
+
|
|
14727
14785
|
body = {}
|
|
14728
14786
|
if catalog_name is not None:
|
|
14729
14787
|
body["catalog_name"] = catalog_name
|
|
@@ -14805,8 +14863,7 @@ class SchemasAPI:
|
|
|
14805
14863
|
|
|
14806
14864
|
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
|
|
14807
14865
|
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.
|
|
14809
|
-
Google AIP-158 guidelines.
|
|
14866
|
+
absent, which is the only indication that the end of results has been reached.
|
|
14810
14867
|
|
|
14811
14868
|
:param catalog_name: str
|
|
14812
14869
|
Parent catalog for schemas of interest.
|
|
@@ -14876,6 +14933,7 @@ class SchemasAPI:
|
|
|
14876
14933
|
|
|
14877
14934
|
:returns: :class:`SchemaInfo`
|
|
14878
14935
|
"""
|
|
14936
|
+
|
|
14879
14937
|
body = {}
|
|
14880
14938
|
if comment is not None:
|
|
14881
14939
|
body["comment"] = comment
|
|
@@ -14952,6 +15010,7 @@ class StorageCredentialsAPI:
|
|
|
14952
15010
|
|
|
14953
15011
|
:returns: :class:`StorageCredentialInfo`
|
|
14954
15012
|
"""
|
|
15013
|
+
|
|
14955
15014
|
body = {}
|
|
14956
15015
|
if aws_iam_role is not None:
|
|
14957
15016
|
body["aws_iam_role"] = aws_iam_role.as_dict()
|
|
@@ -15035,8 +15094,7 @@ class StorageCredentialsAPI:
|
|
|
15035
15094
|
|
|
15036
15095
|
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
|
|
15037
15096
|
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.
|
|
15039
|
-
Google AIP-158 guidelines.
|
|
15097
|
+
absent, which is the only indication that the end of results has been reached.
|
|
15040
15098
|
|
|
15041
15099
|
:param include_unbound: bool (optional)
|
|
15042
15100
|
Whether to include credentials not bound to the workspace. Effective only if the user has permission
|
|
@@ -15125,6 +15183,7 @@ class StorageCredentialsAPI:
|
|
|
15125
15183
|
|
|
15126
15184
|
:returns: :class:`StorageCredentialInfo`
|
|
15127
15185
|
"""
|
|
15186
|
+
|
|
15128
15187
|
body = {}
|
|
15129
15188
|
if aws_iam_role is not None:
|
|
15130
15189
|
body["aws_iam_role"] = aws_iam_role.as_dict()
|
|
@@ -15202,6 +15261,7 @@ class StorageCredentialsAPI:
|
|
|
15202
15261
|
|
|
15203
15262
|
:returns: :class:`ValidateStorageCredentialResponse`
|
|
15204
15263
|
"""
|
|
15264
|
+
|
|
15205
15265
|
body = {}
|
|
15206
15266
|
if aws_iam_role is not None:
|
|
15207
15267
|
body["aws_iam_role"] = aws_iam_role.as_dict()
|
|
@@ -15270,6 +15330,7 @@ class SystemSchemasAPI:
|
|
|
15270
15330
|
|
|
15271
15331
|
|
|
15272
15332
|
"""
|
|
15333
|
+
|
|
15273
15334
|
body = {}
|
|
15274
15335
|
if catalog_name is not None:
|
|
15275
15336
|
body["catalog_name"] = catalog_name
|
|
@@ -15296,8 +15357,7 @@ class SystemSchemasAPI:
|
|
|
15296
15357
|
|
|
15297
15358
|
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
|
|
15298
15359
|
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.
|
|
15300
|
-
Google AIP-158 guidelines.
|
|
15360
|
+
absent, which is the only indication that the end of results has been reached.
|
|
15301
15361
|
|
|
15302
15362
|
:param metastore_id: str
|
|
15303
15363
|
The ID for the metastore in which the system schema resides.
|
|
@@ -15364,6 +15424,7 @@ class TableConstraintsAPI:
|
|
|
15364
15424
|
|
|
15365
15425
|
:returns: :class:`TableConstraint`
|
|
15366
15426
|
"""
|
|
15427
|
+
|
|
15367
15428
|
body = {}
|
|
15368
15429
|
if constraint is not None:
|
|
15369
15430
|
body["constraint"] = constraint.as_dict()
|
|
@@ -15471,6 +15532,7 @@ class TablesAPI:
|
|
|
15471
15532
|
|
|
15472
15533
|
:returns: :class:`TableInfo`
|
|
15473
15534
|
"""
|
|
15535
|
+
|
|
15474
15536
|
body = {}
|
|
15475
15537
|
if catalog_name is not None:
|
|
15476
15538
|
body["catalog_name"] = catalog_name
|
|
@@ -15600,8 +15662,7 @@ class TablesAPI:
|
|
|
15600
15662
|
|
|
15601
15663
|
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
|
|
15602
15664
|
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.
|
|
15604
|
-
Google AIP-158 guidelines.
|
|
15665
|
+
absent, which is the only indication that the end of results has been reached.
|
|
15605
15666
|
|
|
15606
15667
|
:param catalog_name: str
|
|
15607
15668
|
Name of parent catalog for tables of interest.
|
|
@@ -15683,6 +15744,10 @@ class TablesAPI:
|
|
|
15683
15744
|
|
|
15684
15745
|
There is no guarantee of a specific ordering of the elements in the array.
|
|
15685
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
|
+
|
|
15686
15751
|
:param catalog_name: str
|
|
15687
15752
|
Name of parent catalog for tables of interest.
|
|
15688
15753
|
:param include_manifest_capabilities: bool (optional)
|
|
@@ -15742,6 +15807,7 @@ class TablesAPI:
|
|
|
15742
15807
|
|
|
15743
15808
|
|
|
15744
15809
|
"""
|
|
15810
|
+
|
|
15745
15811
|
body = {}
|
|
15746
15812
|
if owner is not None:
|
|
15747
15813
|
body["owner"] = owner
|
|
@@ -15803,6 +15869,7 @@ class TemporaryPathCredentialsAPI:
|
|
|
15803
15869
|
|
|
15804
15870
|
:returns: :class:`GenerateTemporaryPathCredentialResponse`
|
|
15805
15871
|
"""
|
|
15872
|
+
|
|
15806
15873
|
body = {}
|
|
15807
15874
|
if dry_run is not None:
|
|
15808
15875
|
body["dry_run"] = dry_run
|
|
@@ -15853,6 +15920,7 @@ class TemporaryTableCredentialsAPI:
|
|
|
15853
15920
|
|
|
15854
15921
|
:returns: :class:`GenerateTemporaryTableCredentialResponse`
|
|
15855
15922
|
"""
|
|
15923
|
+
|
|
15856
15924
|
body = {}
|
|
15857
15925
|
if operation is not None:
|
|
15858
15926
|
body["operation"] = operation.value
|
|
@@ -15923,6 +15991,7 @@ class VolumesAPI:
|
|
|
15923
15991
|
|
|
15924
15992
|
:returns: :class:`VolumeInfo`
|
|
15925
15993
|
"""
|
|
15994
|
+
|
|
15926
15995
|
body = {}
|
|
15927
15996
|
if catalog_name is not None:
|
|
15928
15997
|
body["catalog_name"] = catalog_name
|
|
@@ -15980,6 +16049,10 @@ class VolumesAPI:
|
|
|
15980
16049
|
|
|
15981
16050
|
There is no guarantee of a specific ordering of the elements in the array.
|
|
15982
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
|
+
|
|
15983
16056
|
:param catalog_name: str
|
|
15984
16057
|
The identifier of the catalog
|
|
15985
16058
|
:param schema_name: str
|
|
@@ -16078,6 +16151,7 @@ class VolumesAPI:
|
|
|
16078
16151
|
|
|
16079
16152
|
:returns: :class:`VolumeInfo`
|
|
16080
16153
|
"""
|
|
16154
|
+
|
|
16081
16155
|
body = {}
|
|
16082
16156
|
if comment is not None:
|
|
16083
16157
|
body["comment"] = comment
|
|
@@ -16141,6 +16215,13 @@ class WorkspaceBindingsAPI:
|
|
|
16141
16215
|
"""Gets workspace bindings of the securable. The caller must be a metastore admin or an owner of the
|
|
16142
16216
|
securable.
|
|
16143
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
|
+
|
|
16144
16225
|
:param securable_type: str
|
|
16145
16226
|
The type of the securable to bind to a workspace (catalog, storage_credential, credential, or
|
|
16146
16227
|
external_location).
|
|
@@ -16199,6 +16280,7 @@ class WorkspaceBindingsAPI:
|
|
|
16199
16280
|
|
|
16200
16281
|
:returns: :class:`UpdateCatalogWorkspaceBindingsResponse`
|
|
16201
16282
|
"""
|
|
16283
|
+
|
|
16202
16284
|
body = {}
|
|
16203
16285
|
if assign_workspaces is not None:
|
|
16204
16286
|
body["assign_workspaces"] = [v for v in assign_workspaces]
|
|
@@ -16239,6 +16321,7 @@ class WorkspaceBindingsAPI:
|
|
|
16239
16321
|
|
|
16240
16322
|
:returns: :class:`UpdateWorkspaceBindingsResponse`
|
|
16241
16323
|
"""
|
|
16324
|
+
|
|
16242
16325
|
body = {}
|
|
16243
16326
|
if add is not None:
|
|
16244
16327
|
body["add"] = [v.as_dict() for v in add]
|