databricks-sdk 0.56.0__py3-none-any.whl → 0.58.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of databricks-sdk might be problematic. Click here for more details.
- databricks/sdk/__init__.py +38 -11
- databricks/sdk/service/aibuilder.py +122 -17
- databricks/sdk/service/apps.py +15 -45
- databricks/sdk/service/billing.py +70 -74
- databricks/sdk/service/catalog.py +1898 -557
- databricks/sdk/service/cleanrooms.py +14 -55
- databricks/sdk/service/compute.py +305 -508
- databricks/sdk/service/dashboards.py +148 -223
- databricks/sdk/service/database.py +657 -127
- databricks/sdk/service/files.py +18 -54
- databricks/sdk/service/iam.py +55 -165
- databricks/sdk/service/jobs.py +238 -214
- databricks/sdk/service/marketplace.py +47 -146
- databricks/sdk/service/ml.py +1137 -447
- databricks/sdk/service/oauth2.py +17 -46
- databricks/sdk/service/pipelines.py +93 -69
- databricks/sdk/service/provisioning.py +34 -212
- databricks/sdk/service/qualitymonitorv2.py +5 -33
- databricks/sdk/service/serving.py +69 -55
- databricks/sdk/service/settings.py +106 -434
- databricks/sdk/service/sharing.py +33 -95
- databricks/sdk/service/sql.py +164 -254
- databricks/sdk/service/vectorsearch.py +13 -62
- databricks/sdk/service/workspace.py +36 -110
- databricks/sdk/version.py +1 -1
- {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.58.0.dist-info}/METADATA +1 -1
- {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.58.0.dist-info}/RECORD +31 -31
- {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.58.0.dist-info}/WHEEL +0 -0
- {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.58.0.dist-info}/licenses/LICENSE +0 -0
- {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.58.0.dist-info}/licenses/NOTICE +0 -0
- {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.58.0.dist-info}/top_level.txt +0 -0
|
@@ -99,11 +99,6 @@ class CreateVectorIndexRequest:
|
|
|
99
99
|
"""Primary key of the index"""
|
|
100
100
|
|
|
101
101
|
index_type: VectorIndexType
|
|
102
|
-
"""There are 2 types of Vector Search indexes: - `DELTA_SYNC`: An index that automatically syncs
|
|
103
|
-
with a source Delta Table, automatically and incrementally updating the index as the underlying
|
|
104
|
-
data in the Delta Table changes. - `DIRECT_ACCESS`: An index that supports direct read and write
|
|
105
|
-
of vectors and metadata through our REST and SDK APIs. With this model, the user manages index
|
|
106
|
-
updates."""
|
|
107
102
|
|
|
108
103
|
delta_sync_index_spec: Optional[DeltaSyncVectorIndexSpecRequest] = None
|
|
109
104
|
"""Specification for Delta Sync Index. Required if `index_type` is `DELTA_SYNC`."""
|
|
@@ -845,11 +840,6 @@ class MiniVectorIndex:
|
|
|
845
840
|
"""Name of the endpoint associated with the index"""
|
|
846
841
|
|
|
847
842
|
index_type: Optional[VectorIndexType] = None
|
|
848
|
-
"""There are 2 types of Vector Search indexes: - `DELTA_SYNC`: An index that automatically syncs
|
|
849
|
-
with a source Delta Table, automatically and incrementally updating the index as the underlying
|
|
850
|
-
data in the Delta Table changes. - `DIRECT_ACCESS`: An index that supports direct read and write
|
|
851
|
-
of vectors and metadata through our REST and SDK APIs. With this model, the user manages index
|
|
852
|
-
updates."""
|
|
853
843
|
|
|
854
844
|
name: Optional[str] = None
|
|
855
845
|
"""Name of the index"""
|
|
@@ -1579,11 +1569,6 @@ class VectorIndex:
|
|
|
1579
1569
|
"""Name of the endpoint associated with the index"""
|
|
1580
1570
|
|
|
1581
1571
|
index_type: Optional[VectorIndexType] = None
|
|
1582
|
-
"""There are 2 types of Vector Search indexes: - `DELTA_SYNC`: An index that automatically syncs
|
|
1583
|
-
with a source Delta Table, automatically and incrementally updating the index as the underlying
|
|
1584
|
-
data in the Delta Table changes. - `DIRECT_ACCESS`: An index that supports direct read and write
|
|
1585
|
-
of vectors and metadata through our REST and SDK APIs. With this model, the user manages index
|
|
1586
|
-
updates."""
|
|
1587
1572
|
|
|
1588
1573
|
name: Optional[str] = None
|
|
1589
1574
|
"""Name of the index"""
|
|
@@ -1755,9 +1740,7 @@ class VectorSearchEndpointsAPI:
|
|
|
1755
1740
|
def create_endpoint(
|
|
1756
1741
|
self, name: str, endpoint_type: EndpointType, *, budget_policy_id: Optional[str] = None
|
|
1757
1742
|
) -> Wait[EndpointInfo]:
|
|
1758
|
-
"""Create
|
|
1759
|
-
|
|
1760
|
-
Create a new endpoint.
|
|
1743
|
+
"""Create a new endpoint.
|
|
1761
1744
|
|
|
1762
1745
|
:param name: str
|
|
1763
1746
|
Name of the vector search endpoint
|
|
@@ -1802,9 +1785,7 @@ class VectorSearchEndpointsAPI:
|
|
|
1802
1785
|
)
|
|
1803
1786
|
|
|
1804
1787
|
def delete_endpoint(self, endpoint_name: str):
|
|
1805
|
-
"""Delete
|
|
1806
|
-
|
|
1807
|
-
Delete a vector search endpoint.
|
|
1788
|
+
"""Delete a vector search endpoint.
|
|
1808
1789
|
|
|
1809
1790
|
:param endpoint_name: str
|
|
1810
1791
|
Name of the vector search endpoint
|
|
@@ -1819,9 +1800,7 @@ class VectorSearchEndpointsAPI:
|
|
|
1819
1800
|
self._api.do("DELETE", f"/api/2.0/vector-search/endpoints/{endpoint_name}", headers=headers)
|
|
1820
1801
|
|
|
1821
1802
|
def get_endpoint(self, endpoint_name: str) -> EndpointInfo:
|
|
1822
|
-
"""Get
|
|
1823
|
-
|
|
1824
|
-
Get details for a single vector search endpoint.
|
|
1803
|
+
"""Get details for a single vector search endpoint.
|
|
1825
1804
|
|
|
1826
1805
|
:param endpoint_name: str
|
|
1827
1806
|
Name of the endpoint
|
|
@@ -1837,9 +1816,7 @@ class VectorSearchEndpointsAPI:
|
|
|
1837
1816
|
return EndpointInfo.from_dict(res)
|
|
1838
1817
|
|
|
1839
1818
|
def list_endpoints(self, *, page_token: Optional[str] = None) -> Iterator[EndpointInfo]:
|
|
1840
|
-
"""List all endpoints.
|
|
1841
|
-
|
|
1842
|
-
List all vector search endpoints in the workspace.
|
|
1819
|
+
"""List all vector search endpoints in the workspace.
|
|
1843
1820
|
|
|
1844
1821
|
:param page_token: str (optional)
|
|
1845
1822
|
Token for pagination
|
|
@@ -1866,9 +1843,7 @@ class VectorSearchEndpointsAPI:
|
|
|
1866
1843
|
def update_endpoint_budget_policy(
|
|
1867
1844
|
self, endpoint_name: str, budget_policy_id: str
|
|
1868
1845
|
) -> PatchEndpointBudgetPolicyResponse:
|
|
1869
|
-
"""Update the budget policy of an endpoint
|
|
1870
|
-
|
|
1871
|
-
Update the budget policy of an endpoint
|
|
1846
|
+
"""Update the budget policy of an endpoint
|
|
1872
1847
|
|
|
1873
1848
|
:param endpoint_name: str
|
|
1874
1849
|
Name of the vector search endpoint
|
|
@@ -1938,9 +1913,7 @@ class VectorSearchIndexesAPI:
|
|
|
1938
1913
|
delta_sync_index_spec: Optional[DeltaSyncVectorIndexSpecRequest] = None,
|
|
1939
1914
|
direct_access_index_spec: Optional[DirectAccessVectorIndexSpec] = None,
|
|
1940
1915
|
) -> VectorIndex:
|
|
1941
|
-
"""Create
|
|
1942
|
-
|
|
1943
|
-
Create a new index.
|
|
1916
|
+
"""Create a new index.
|
|
1944
1917
|
|
|
1945
1918
|
:param name: str
|
|
1946
1919
|
Name of the index
|
|
@@ -1949,10 +1922,6 @@ class VectorSearchIndexesAPI:
|
|
|
1949
1922
|
:param primary_key: str
|
|
1950
1923
|
Primary key of the index
|
|
1951
1924
|
:param index_type: :class:`VectorIndexType`
|
|
1952
|
-
There are 2 types of Vector Search indexes: - `DELTA_SYNC`: An index that automatically syncs with a
|
|
1953
|
-
source Delta Table, automatically and incrementally updating the index as the underlying data in the
|
|
1954
|
-
Delta Table changes. - `DIRECT_ACCESS`: An index that supports direct read and write of vectors and
|
|
1955
|
-
metadata through our REST and SDK APIs. With this model, the user manages index updates.
|
|
1956
1925
|
:param delta_sync_index_spec: :class:`DeltaSyncVectorIndexSpecRequest` (optional)
|
|
1957
1926
|
Specification for Delta Sync Index. Required if `index_type` is `DELTA_SYNC`.
|
|
1958
1927
|
:param direct_access_index_spec: :class:`DirectAccessVectorIndexSpec` (optional)
|
|
@@ -1982,9 +1951,7 @@ class VectorSearchIndexesAPI:
|
|
|
1982
1951
|
return VectorIndex.from_dict(res)
|
|
1983
1952
|
|
|
1984
1953
|
def delete_data_vector_index(self, index_name: str, primary_keys: List[str]) -> DeleteDataVectorIndexResponse:
|
|
1985
|
-
"""
|
|
1986
|
-
|
|
1987
|
-
Handles the deletion of data from a specified vector index.
|
|
1954
|
+
"""Handles the deletion of data from a specified vector index.
|
|
1988
1955
|
|
|
1989
1956
|
:param index_name: str
|
|
1990
1957
|
Name of the vector index where data is to be deleted. Must be a Direct Vector Access Index.
|
|
@@ -2009,8 +1976,6 @@ class VectorSearchIndexesAPI:
|
|
|
2009
1976
|
def delete_index(self, index_name: str):
|
|
2010
1977
|
"""Delete an index.
|
|
2011
1978
|
|
|
2012
|
-
Delete an index.
|
|
2013
|
-
|
|
2014
1979
|
:param index_name: str
|
|
2015
1980
|
Name of the index
|
|
2016
1981
|
|
|
@@ -2026,8 +1991,6 @@ class VectorSearchIndexesAPI:
|
|
|
2026
1991
|
def get_index(self, index_name: str) -> VectorIndex:
|
|
2027
1992
|
"""Get an index.
|
|
2028
1993
|
|
|
2029
|
-
Get an index.
|
|
2030
|
-
|
|
2031
1994
|
:param index_name: str
|
|
2032
1995
|
Name of the index
|
|
2033
1996
|
|
|
@@ -2042,9 +2005,7 @@ class VectorSearchIndexesAPI:
|
|
|
2042
2005
|
return VectorIndex.from_dict(res)
|
|
2043
2006
|
|
|
2044
2007
|
def list_indexes(self, endpoint_name: str, *, page_token: Optional[str] = None) -> Iterator[MiniVectorIndex]:
|
|
2045
|
-
"""List indexes.
|
|
2046
|
-
|
|
2047
|
-
List all indexes in the given endpoint.
|
|
2008
|
+
"""List all indexes in the given endpoint.
|
|
2048
2009
|
|
|
2049
2010
|
:param endpoint_name: str
|
|
2050
2011
|
Name of the endpoint
|
|
@@ -2085,9 +2046,7 @@ class VectorSearchIndexesAPI:
|
|
|
2085
2046
|
query_vector: Optional[List[float]] = None,
|
|
2086
2047
|
score_threshold: Optional[float] = None,
|
|
2087
2048
|
) -> QueryVectorIndexResponse:
|
|
2088
|
-
"""Query
|
|
2089
|
-
|
|
2090
|
-
Query the specified vector index.
|
|
2049
|
+
"""Query the specified vector index.
|
|
2091
2050
|
|
|
2092
2051
|
:param index_name: str
|
|
2093
2052
|
Name of the vector index to query.
|
|
@@ -2145,9 +2104,7 @@ class VectorSearchIndexesAPI:
|
|
|
2145
2104
|
def query_next_page(
|
|
2146
2105
|
self, index_name: str, *, endpoint_name: Optional[str] = None, page_token: Optional[str] = None
|
|
2147
2106
|
) -> QueryVectorIndexResponse:
|
|
2148
|
-
"""
|
|
2149
|
-
|
|
2150
|
-
Use `next_page_token` returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` request
|
|
2107
|
+
"""Use `next_page_token` returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` request
|
|
2151
2108
|
to fetch next page of results.
|
|
2152
2109
|
|
|
2153
2110
|
:param index_name: str
|
|
@@ -2177,9 +2134,7 @@ class VectorSearchIndexesAPI:
|
|
|
2177
2134
|
def scan_index(
|
|
2178
2135
|
self, index_name: str, *, last_primary_key: Optional[str] = None, num_results: Optional[int] = None
|
|
2179
2136
|
) -> ScanVectorIndexResponse:
|
|
2180
|
-
"""Scan
|
|
2181
|
-
|
|
2182
|
-
Scan the specified vector index and return the first `num_results` entries after the exclusive
|
|
2137
|
+
"""Scan the specified vector index and return the first `num_results` entries after the exclusive
|
|
2183
2138
|
`primary_key`.
|
|
2184
2139
|
|
|
2185
2140
|
:param index_name: str
|
|
@@ -2205,9 +2160,7 @@ class VectorSearchIndexesAPI:
|
|
|
2205
2160
|
return ScanVectorIndexResponse.from_dict(res)
|
|
2206
2161
|
|
|
2207
2162
|
def sync_index(self, index_name: str):
|
|
2208
|
-
"""
|
|
2209
|
-
|
|
2210
|
-
Triggers a synchronization process for a specified vector index.
|
|
2163
|
+
"""Triggers a synchronization process for a specified vector index.
|
|
2211
2164
|
|
|
2212
2165
|
:param index_name: str
|
|
2213
2166
|
Name of the vector index to synchronize. Must be a Delta Sync Index.
|
|
@@ -2222,9 +2175,7 @@ class VectorSearchIndexesAPI:
|
|
|
2222
2175
|
self._api.do("POST", f"/api/2.0/vector-search/indexes/{index_name}/sync", headers=headers)
|
|
2223
2176
|
|
|
2224
2177
|
def upsert_data_vector_index(self, index_name: str, inputs_json: str) -> UpsertDataVectorIndexResponse:
|
|
2225
|
-
"""
|
|
2226
|
-
|
|
2227
|
-
Handles the upserting of data into a specified vector index.
|
|
2178
|
+
"""Handles the upserting of data into a specified vector index.
|
|
2228
2179
|
|
|
2229
2180
|
:param index_name: str
|
|
2230
2181
|
Name of the vector index where data is to be upserted. Must be a Direct Vector Access Index.
|
|
@@ -1456,7 +1456,6 @@ class RepoAccessControlRequest:
|
|
|
1456
1456
|
"""name of the group"""
|
|
1457
1457
|
|
|
1458
1458
|
permission_level: Optional[RepoPermissionLevel] = None
|
|
1459
|
-
"""Permission level"""
|
|
1460
1459
|
|
|
1461
1460
|
service_principal_name: Optional[str] = None
|
|
1462
1461
|
"""application ID of a service principal"""
|
|
@@ -1644,7 +1643,6 @@ class RepoPermission:
|
|
|
1644
1643
|
inherited_from_object: Optional[List[str]] = None
|
|
1645
1644
|
|
|
1646
1645
|
permission_level: Optional[RepoPermissionLevel] = None
|
|
1647
|
-
"""Permission level"""
|
|
1648
1646
|
|
|
1649
1647
|
def as_dict(self) -> dict:
|
|
1650
1648
|
"""Serializes the RepoPermission into a dictionary suitable for use as a JSON request body."""
|
|
@@ -1732,7 +1730,6 @@ class RepoPermissionsDescription:
|
|
|
1732
1730
|
description: Optional[str] = None
|
|
1733
1731
|
|
|
1734
1732
|
permission_level: Optional[RepoPermissionLevel] = None
|
|
1735
|
-
"""Permission level"""
|
|
1736
1733
|
|
|
1737
1734
|
def as_dict(self) -> dict:
|
|
1738
1735
|
"""Serializes the RepoPermissionsDescription into a dictionary suitable for use as a JSON request body."""
|
|
@@ -2089,7 +2086,6 @@ class WorkspaceObjectAccessControlRequest:
|
|
|
2089
2086
|
"""name of the group"""
|
|
2090
2087
|
|
|
2091
2088
|
permission_level: Optional[WorkspaceObjectPermissionLevel] = None
|
|
2092
|
-
"""Permission level"""
|
|
2093
2089
|
|
|
2094
2090
|
service_principal_name: Optional[str] = None
|
|
2095
2091
|
"""application ID of a service principal"""
|
|
@@ -2200,7 +2196,6 @@ class WorkspaceObjectPermission:
|
|
|
2200
2196
|
inherited_from_object: Optional[List[str]] = None
|
|
2201
2197
|
|
|
2202
2198
|
permission_level: Optional[WorkspaceObjectPermissionLevel] = None
|
|
2203
|
-
"""Permission level"""
|
|
2204
2199
|
|
|
2205
2200
|
def as_dict(self) -> dict:
|
|
2206
2201
|
"""Serializes the WorkspaceObjectPermission into a dictionary suitable for use as a JSON request body."""
|
|
@@ -2288,7 +2283,6 @@ class WorkspaceObjectPermissionsDescription:
|
|
|
2288
2283
|
description: Optional[str] = None
|
|
2289
2284
|
|
|
2290
2285
|
permission_level: Optional[WorkspaceObjectPermissionLevel] = None
|
|
2291
|
-
"""Permission level"""
|
|
2292
2286
|
|
|
2293
2287
|
def as_dict(self) -> dict:
|
|
2294
2288
|
"""Serializes the WorkspaceObjectPermissionsDescription into a dictionary suitable for use as a JSON request body."""
|
|
@@ -2372,9 +2366,7 @@ class GitCredentialsAPI:
|
|
|
2372
2366
|
def create(
|
|
2373
2367
|
self, git_provider: str, *, git_username: Optional[str] = None, personal_access_token: Optional[str] = None
|
|
2374
2368
|
) -> CreateCredentialsResponse:
|
|
2375
|
-
"""
|
|
2376
|
-
|
|
2377
|
-
Creates a Git credential entry for the user. Only one Git credential per user is supported, so any
|
|
2369
|
+
"""Creates a Git credential entry for the user. Only one Git credential per user is supported, so any
|
|
2378
2370
|
attempts to create credentials if an entry already exists will fail. Use the PATCH endpoint to update
|
|
2379
2371
|
existing credentials, or the DELETE endpoint to delete existing credentials.
|
|
2380
2372
|
|
|
@@ -2412,9 +2404,7 @@ class GitCredentialsAPI:
|
|
|
2412
2404
|
return CreateCredentialsResponse.from_dict(res)
|
|
2413
2405
|
|
|
2414
2406
|
def delete(self, credential_id: int):
|
|
2415
|
-
"""
|
|
2416
|
-
|
|
2417
|
-
Deletes the specified Git credential.
|
|
2407
|
+
"""Deletes the specified Git credential.
|
|
2418
2408
|
|
|
2419
2409
|
:param credential_id: int
|
|
2420
2410
|
The ID for the corresponding credential to access.
|
|
@@ -2429,9 +2419,7 @@ class GitCredentialsAPI:
|
|
|
2429
2419
|
self._api.do("DELETE", f"/api/2.0/git-credentials/{credential_id}", headers=headers)
|
|
2430
2420
|
|
|
2431
2421
|
def get(self, credential_id: int) -> GetCredentialsResponse:
|
|
2432
|
-
"""
|
|
2433
|
-
|
|
2434
|
-
Gets the Git credential with the specified credential ID.
|
|
2422
|
+
"""Gets the Git credential with the specified credential ID.
|
|
2435
2423
|
|
|
2436
2424
|
:param credential_id: int
|
|
2437
2425
|
The ID for the corresponding credential to access.
|
|
@@ -2447,9 +2435,8 @@ class GitCredentialsAPI:
|
|
|
2447
2435
|
return GetCredentialsResponse.from_dict(res)
|
|
2448
2436
|
|
|
2449
2437
|
def list(self) -> Iterator[CredentialInfo]:
|
|
2450
|
-
"""
|
|
2438
|
+
"""Lists the calling user's Git credentials. One credential per user is supported.
|
|
2451
2439
|
|
|
2452
|
-
Lists the calling user's Git credentials. One credential per user is supported.
|
|
2453
2440
|
|
|
2454
2441
|
:returns: Iterator over :class:`CredentialInfo`
|
|
2455
2442
|
"""
|
|
@@ -2470,9 +2457,7 @@ class GitCredentialsAPI:
|
|
|
2470
2457
|
git_username: Optional[str] = None,
|
|
2471
2458
|
personal_access_token: Optional[str] = None,
|
|
2472
2459
|
):
|
|
2473
|
-
"""
|
|
2474
|
-
|
|
2475
|
-
Updates the specified Git credential.
|
|
2460
|
+
"""Updates the specified Git credential.
|
|
2476
2461
|
|
|
2477
2462
|
:param credential_id: int
|
|
2478
2463
|
The ID for the corresponding credential to access.
|
|
@@ -2526,9 +2511,7 @@ class ReposAPI:
|
|
|
2526
2511
|
def create(
|
|
2527
2512
|
self, url: str, provider: str, *, path: Optional[str] = None, sparse_checkout: Optional[SparseCheckout] = None
|
|
2528
2513
|
) -> CreateRepoResponse:
|
|
2529
|
-
"""
|
|
2530
|
-
|
|
2531
|
-
Creates a repo in the workspace and links it to the remote Git repo specified. Note that repos created
|
|
2514
|
+
"""Creates a repo in the workspace and links it to the remote Git repo specified. Note that repos created
|
|
2532
2515
|
programmatically must be linked to a remote Git repo, unlike repos created in the browser.
|
|
2533
2516
|
|
|
2534
2517
|
:param url: str
|
|
@@ -2564,9 +2547,7 @@ class ReposAPI:
|
|
|
2564
2547
|
return CreateRepoResponse.from_dict(res)
|
|
2565
2548
|
|
|
2566
2549
|
def delete(self, repo_id: int):
|
|
2567
|
-
"""
|
|
2568
|
-
|
|
2569
|
-
Deletes the specified repo.
|
|
2550
|
+
"""Deletes the specified repo.
|
|
2570
2551
|
|
|
2571
2552
|
:param repo_id: int
|
|
2572
2553
|
The ID for the corresponding repo to delete.
|
|
@@ -2581,9 +2562,7 @@ class ReposAPI:
|
|
|
2581
2562
|
self._api.do("DELETE", f"/api/2.0/repos/{repo_id}", headers=headers)
|
|
2582
2563
|
|
|
2583
2564
|
def get(self, repo_id: int) -> GetRepoResponse:
|
|
2584
|
-
"""
|
|
2585
|
-
|
|
2586
|
-
Returns the repo with the given repo ID.
|
|
2565
|
+
"""Returns the repo with the given repo ID.
|
|
2587
2566
|
|
|
2588
2567
|
:param repo_id: int
|
|
2589
2568
|
ID of the Git folder (repo) object in the workspace.
|
|
@@ -2599,9 +2578,7 @@ class ReposAPI:
|
|
|
2599
2578
|
return GetRepoResponse.from_dict(res)
|
|
2600
2579
|
|
|
2601
2580
|
def get_permission_levels(self, repo_id: str) -> GetRepoPermissionLevelsResponse:
|
|
2602
|
-
"""
|
|
2603
|
-
|
|
2604
|
-
Gets the permission levels that a user can have on an object.
|
|
2581
|
+
"""Gets the permission levels that a user can have on an object.
|
|
2605
2582
|
|
|
2606
2583
|
:param repo_id: str
|
|
2607
2584
|
The repo for which to get or manage permissions.
|
|
@@ -2617,9 +2594,7 @@ class ReposAPI:
|
|
|
2617
2594
|
return GetRepoPermissionLevelsResponse.from_dict(res)
|
|
2618
2595
|
|
|
2619
2596
|
def get_permissions(self, repo_id: str) -> RepoPermissions:
|
|
2620
|
-
"""
|
|
2621
|
-
|
|
2622
|
-
Gets the permissions of a repo. Repos can inherit permissions from their root object.
|
|
2597
|
+
"""Gets the permissions of a repo. Repos can inherit permissions from their root object.
|
|
2623
2598
|
|
|
2624
2599
|
:param repo_id: str
|
|
2625
2600
|
The repo for which to get or manage permissions.
|
|
@@ -2635,9 +2610,7 @@ class ReposAPI:
|
|
|
2635
2610
|
return RepoPermissions.from_dict(res)
|
|
2636
2611
|
|
|
2637
2612
|
def list(self, *, next_page_token: Optional[str] = None, path_prefix: Optional[str] = None) -> Iterator[RepoInfo]:
|
|
2638
|
-
"""
|
|
2639
|
-
|
|
2640
|
-
Returns repos that the calling user has Manage permissions on. Use `next_page_token` to iterate
|
|
2613
|
+
"""Returns repos that the calling user has Manage permissions on. Use `next_page_token` to iterate
|
|
2641
2614
|
through additional pages.
|
|
2642
2615
|
|
|
2643
2616
|
:param next_page_token: str (optional)
|
|
@@ -2672,9 +2645,7 @@ class ReposAPI:
|
|
|
2672
2645
|
def set_permissions(
|
|
2673
2646
|
self, repo_id: str, *, access_control_list: Optional[List[RepoAccessControlRequest]] = None
|
|
2674
2647
|
) -> RepoPermissions:
|
|
2675
|
-
"""
|
|
2676
|
-
|
|
2677
|
-
Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
|
|
2648
|
+
"""Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
|
|
2678
2649
|
permissions if none are specified. Objects can inherit permissions from their root object.
|
|
2679
2650
|
|
|
2680
2651
|
:param repo_id: str
|
|
@@ -2702,9 +2673,7 @@ class ReposAPI:
|
|
|
2702
2673
|
sparse_checkout: Optional[SparseCheckoutUpdate] = None,
|
|
2703
2674
|
tag: Optional[str] = None,
|
|
2704
2675
|
):
|
|
2705
|
-
"""
|
|
2706
|
-
|
|
2707
|
-
Updates the repo to a different branch or tag, or updates the repo to the latest commit on the same
|
|
2676
|
+
"""Updates the repo to a different branch or tag, or updates the repo to the latest commit on the same
|
|
2708
2677
|
branch.
|
|
2709
2678
|
|
|
2710
2679
|
:param repo_id: int
|
|
@@ -2738,9 +2707,7 @@ class ReposAPI:
|
|
|
2738
2707
|
def update_permissions(
|
|
2739
2708
|
self, repo_id: str, *, access_control_list: Optional[List[RepoAccessControlRequest]] = None
|
|
2740
2709
|
) -> RepoPermissions:
|
|
2741
|
-
"""
|
|
2742
|
-
|
|
2743
|
-
Updates the permissions on a repo. Repos can inherit permissions from their root object.
|
|
2710
|
+
"""Updates the permissions on a repo. Repos can inherit permissions from their root object.
|
|
2744
2711
|
|
|
2745
2712
|
:param repo_id: str
|
|
2746
2713
|
The repo for which to get or manage permissions.
|
|
@@ -2782,9 +2749,7 @@ class SecretsAPI:
|
|
|
2782
2749
|
initial_manage_principal: Optional[str] = None,
|
|
2783
2750
|
scope_backend_type: Optional[ScopeBackendType] = None,
|
|
2784
2751
|
):
|
|
2785
|
-
"""
|
|
2786
|
-
|
|
2787
|
-
The scope name must consist of alphanumeric characters, dashes, underscores, and periods, and may not
|
|
2752
|
+
"""The scope name must consist of alphanumeric characters, dashes, underscores, and periods, and may not
|
|
2788
2753
|
exceed 128 characters.
|
|
2789
2754
|
|
|
2790
2755
|
:param scope: str
|
|
@@ -2815,9 +2780,7 @@ class SecretsAPI:
|
|
|
2815
2780
|
self._api.do("POST", "/api/2.0/secrets/scopes/create", body=body, headers=headers)
|
|
2816
2781
|
|
|
2817
2782
|
def delete_acl(self, scope: str, principal: str):
|
|
2818
|
-
"""
|
|
2819
|
-
|
|
2820
|
-
Deletes the given ACL on the given scope.
|
|
2783
|
+
"""Deletes the given ACL on the given scope.
|
|
2821
2784
|
|
|
2822
2785
|
Users must have the `MANAGE` permission to invoke this API. Throws `RESOURCE_DOES_NOT_EXIST` if no
|
|
2823
2786
|
such secret scope, principal, or ACL exists. Throws `PERMISSION_DENIED` if the user does not have
|
|
@@ -2843,9 +2806,7 @@ class SecretsAPI:
|
|
|
2843
2806
|
self._api.do("POST", "/api/2.0/secrets/acls/delete", body=body, headers=headers)
|
|
2844
2807
|
|
|
2845
2808
|
def delete_scope(self, scope: str):
|
|
2846
|
-
"""
|
|
2847
|
-
|
|
2848
|
-
Deletes a secret scope.
|
|
2809
|
+
"""Deletes a secret scope.
|
|
2849
2810
|
|
|
2850
2811
|
Throws `RESOURCE_DOES_NOT_EXIST` if the scope does not exist. Throws `PERMISSION_DENIED` if the user
|
|
2851
2812
|
does not have permission to make this API call.
|
|
@@ -2866,9 +2827,7 @@ class SecretsAPI:
|
|
|
2866
2827
|
self._api.do("POST", "/api/2.0/secrets/scopes/delete", body=body, headers=headers)
|
|
2867
2828
|
|
|
2868
2829
|
def delete_secret(self, scope: str, key: str):
|
|
2869
|
-
"""
|
|
2870
|
-
|
|
2871
|
-
Deletes the secret stored in this secret scope. You must have `WRITE` or `MANAGE` permission on the
|
|
2830
|
+
"""Deletes the secret stored in this secret scope. You must have `WRITE` or `MANAGE` permission on the
|
|
2872
2831
|
secret scope.
|
|
2873
2832
|
|
|
2874
2833
|
Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope or secret exists. Throws `PERMISSION_DENIED`
|
|
@@ -2894,9 +2853,7 @@ class SecretsAPI:
|
|
|
2894
2853
|
self._api.do("POST", "/api/2.0/secrets/delete", body=body, headers=headers)
|
|
2895
2854
|
|
|
2896
2855
|
def get_acl(self, scope: str, principal: str) -> AclItem:
|
|
2897
|
-
"""
|
|
2898
|
-
|
|
2899
|
-
Gets the details about the given ACL, such as the group and permission. Users must have the `MANAGE`
|
|
2856
|
+
"""Gets the details about the given ACL, such as the group and permission. Users must have the `MANAGE`
|
|
2900
2857
|
permission to invoke this API.
|
|
2901
2858
|
|
|
2902
2859
|
Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope exists. Throws `PERMISSION_DENIED` if the
|
|
@@ -2923,9 +2880,7 @@ class SecretsAPI:
|
|
|
2923
2880
|
return AclItem.from_dict(res)
|
|
2924
2881
|
|
|
2925
2882
|
def get_secret(self, scope: str, key: str) -> GetSecretResponse:
|
|
2926
|
-
"""
|
|
2927
|
-
|
|
2928
|
-
Gets the bytes representation of a secret value for the specified scope and key.
|
|
2883
|
+
"""Gets the bytes representation of a secret value for the specified scope and key.
|
|
2929
2884
|
|
|
2930
2885
|
Users need the READ permission to make this call.
|
|
2931
2886
|
|
|
@@ -2956,9 +2911,7 @@ class SecretsAPI:
|
|
|
2956
2911
|
return GetSecretResponse.from_dict(res)
|
|
2957
2912
|
|
|
2958
2913
|
def list_acls(self, scope: str) -> Iterator[AclItem]:
|
|
2959
|
-
"""
|
|
2960
|
-
|
|
2961
|
-
List the ACLs for a given secret scope. Users must have the `MANAGE` permission to invoke this API.
|
|
2914
|
+
"""List the ACLs for a given secret scope. Users must have the `MANAGE` permission to invoke this API.
|
|
2962
2915
|
|
|
2963
2916
|
Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope exists. Throws `PERMISSION_DENIED` if the
|
|
2964
2917
|
user does not have permission to make this API call.
|
|
@@ -2981,12 +2934,11 @@ class SecretsAPI:
|
|
|
2981
2934
|
return parsed if parsed is not None else []
|
|
2982
2935
|
|
|
2983
2936
|
def list_scopes(self) -> Iterator[SecretScope]:
|
|
2984
|
-
"""
|
|
2985
|
-
|
|
2986
|
-
Lists all secret scopes available in the workspace.
|
|
2937
|
+
"""Lists all secret scopes available in the workspace.
|
|
2987
2938
|
|
|
2988
2939
|
Throws `PERMISSION_DENIED` if the user does not have permission to make this API call.
|
|
2989
2940
|
|
|
2941
|
+
|
|
2990
2942
|
:returns: Iterator over :class:`SecretScope`
|
|
2991
2943
|
"""
|
|
2992
2944
|
|
|
@@ -2999,9 +2951,7 @@ class SecretsAPI:
|
|
|
2999
2951
|
return parsed if parsed is not None else []
|
|
3000
2952
|
|
|
3001
2953
|
def list_secrets(self, scope: str) -> Iterator[SecretMetadata]:
|
|
3002
|
-
"""
|
|
3003
|
-
|
|
3004
|
-
Lists the secret keys that are stored at this scope. This is a metadata-only operation; secret data
|
|
2954
|
+
"""Lists the secret keys that are stored at this scope. This is a metadata-only operation; secret data
|
|
3005
2955
|
cannot be retrieved using this API. Users need the READ permission to make this call.
|
|
3006
2956
|
|
|
3007
2957
|
The lastUpdatedTimestamp returned is in milliseconds since epoch. Throws `RESOURCE_DOES_NOT_EXIST` if
|
|
@@ -3026,9 +2976,7 @@ class SecretsAPI:
|
|
|
3026
2976
|
return parsed if parsed is not None else []
|
|
3027
2977
|
|
|
3028
2978
|
def put_acl(self, scope: str, principal: str, permission: AclPermission):
|
|
3029
|
-
"""
|
|
3030
|
-
|
|
3031
|
-
Creates or overwrites the Access Control List (ACL) associated with the given principal (user or
|
|
2979
|
+
"""Creates or overwrites the Access Control List (ACL) associated with the given principal (user or
|
|
3032
2980
|
group) on the specified scope point.
|
|
3033
2981
|
|
|
3034
2982
|
In general, a user or group will use the most powerful permission available to them, and permissions
|
|
@@ -3079,9 +3027,7 @@ class SecretsAPI:
|
|
|
3079
3027
|
def put_secret(
|
|
3080
3028
|
self, scope: str, key: str, *, bytes_value: Optional[str] = None, string_value: Optional[str] = None
|
|
3081
3029
|
):
|
|
3082
|
-
"""
|
|
3083
|
-
|
|
3084
|
-
Inserts a secret under the provided scope with the given name. If a secret already exists with the
|
|
3030
|
+
"""Inserts a secret under the provided scope with the given name. If a secret already exists with the
|
|
3085
3031
|
same name, this command overwrites the existing secret's value. The server encrypts the secret using
|
|
3086
3032
|
the secret scope's encryption settings before storing it.
|
|
3087
3033
|
|
|
@@ -3135,9 +3081,7 @@ class WorkspaceAPI:
|
|
|
3135
3081
|
self._api = api_client
|
|
3136
3082
|
|
|
3137
3083
|
def delete(self, path: str, *, recursive: Optional[bool] = None):
|
|
3138
|
-
"""
|
|
3139
|
-
|
|
3140
|
-
Deletes an object or a directory (and optionally recursively deletes all objects in the directory). *
|
|
3084
|
+
"""Deletes an object or a directory (and optionally recursively deletes all objects in the directory). *
|
|
3141
3085
|
If `path` does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`. * If `path` is a
|
|
3142
3086
|
non-empty directory and `recursive` is set to `false`, this call returns an error
|
|
3143
3087
|
`DIRECTORY_NOT_EMPTY`.
|
|
@@ -3166,9 +3110,7 @@ class WorkspaceAPI:
|
|
|
3166
3110
|
self._api.do("POST", "/api/2.0/workspace/delete", body=body, headers=headers)
|
|
3167
3111
|
|
|
3168
3112
|
def export(self, path: str, *, format: Optional[ExportFormat] = None) -> ExportResponse:
|
|
3169
|
-
"""
|
|
3170
|
-
|
|
3171
|
-
Exports an object or the contents of an entire directory.
|
|
3113
|
+
"""Exports an object or the contents of an entire directory.
|
|
3172
3114
|
|
|
3173
3115
|
If `path` does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`.
|
|
3174
3116
|
|
|
@@ -3208,9 +3150,7 @@ class WorkspaceAPI:
|
|
|
3208
3150
|
def get_permission_levels(
|
|
3209
3151
|
self, workspace_object_type: str, workspace_object_id: str
|
|
3210
3152
|
) -> GetWorkspaceObjectPermissionLevelsResponse:
|
|
3211
|
-
"""
|
|
3212
|
-
|
|
3213
|
-
Gets the permission levels that a user can have on an object.
|
|
3153
|
+
"""Gets the permission levels that a user can have on an object.
|
|
3214
3154
|
|
|
3215
3155
|
:param workspace_object_type: str
|
|
3216
3156
|
The workspace object type for which to get or manage permissions.
|
|
@@ -3232,9 +3172,7 @@ class WorkspaceAPI:
|
|
|
3232
3172
|
return GetWorkspaceObjectPermissionLevelsResponse.from_dict(res)
|
|
3233
3173
|
|
|
3234
3174
|
def get_permissions(self, workspace_object_type: str, workspace_object_id: str) -> WorkspaceObjectPermissions:
|
|
3235
|
-
"""
|
|
3236
|
-
|
|
3237
|
-
Gets the permissions of a workspace object. Workspace objects can inherit permissions from their
|
|
3175
|
+
"""Gets the permissions of a workspace object. Workspace objects can inherit permissions from their
|
|
3238
3176
|
parent objects or root object.
|
|
3239
3177
|
|
|
3240
3178
|
:param workspace_object_type: str
|
|
@@ -3255,9 +3193,7 @@ class WorkspaceAPI:
|
|
|
3255
3193
|
return WorkspaceObjectPermissions.from_dict(res)
|
|
3256
3194
|
|
|
3257
3195
|
def get_status(self, path: str) -> ObjectInfo:
|
|
3258
|
-
"""
|
|
3259
|
-
|
|
3260
|
-
Gets the status of an object or a directory. If `path` does not exist, this call returns an error
|
|
3196
|
+
"""Gets the status of an object or a directory. If `path` does not exist, this call returns an error
|
|
3261
3197
|
`RESOURCE_DOES_NOT_EXIST`.
|
|
3262
3198
|
|
|
3263
3199
|
:param path: str
|
|
@@ -3285,9 +3221,7 @@ class WorkspaceAPI:
|
|
|
3285
3221
|
language: Optional[Language] = None,
|
|
3286
3222
|
overwrite: Optional[bool] = None,
|
|
3287
3223
|
):
|
|
3288
|
-
"""
|
|
3289
|
-
|
|
3290
|
-
Imports a workspace object (for example, a notebook or file) or the contents of an entire directory.
|
|
3224
|
+
"""Imports a workspace object (for example, a notebook or file) or the contents of an entire directory.
|
|
3291
3225
|
If `path` already exists and `overwrite` is set to `false`, this call returns an error
|
|
3292
3226
|
`RESOURCE_ALREADY_EXISTS`. To import a directory, you can use either the `DBC` format or the `SOURCE`
|
|
3293
3227
|
format with the `language` field unset. To import a single file as `SOURCE`, you must set the
|
|
@@ -3339,9 +3273,7 @@ class WorkspaceAPI:
|
|
|
3339
3273
|
self._api.do("POST", "/api/2.0/workspace/import", body=body, headers=headers)
|
|
3340
3274
|
|
|
3341
3275
|
def list(self, path: str, *, notebooks_modified_after: Optional[int] = None) -> Iterator[ObjectInfo]:
|
|
3342
|
-
"""
|
|
3343
|
-
|
|
3344
|
-
Lists the contents of a directory, or the object if it is not a directory. If the input path does not
|
|
3276
|
+
"""Lists the contents of a directory, or the object if it is not a directory. If the input path does not
|
|
3345
3277
|
exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`.
|
|
3346
3278
|
|
|
3347
3279
|
:param path: str
|
|
@@ -3366,9 +3298,7 @@ class WorkspaceAPI:
|
|
|
3366
3298
|
return parsed if parsed is not None else []
|
|
3367
3299
|
|
|
3368
3300
|
def mkdirs(self, path: str):
|
|
3369
|
-
"""
|
|
3370
|
-
|
|
3371
|
-
Creates the specified directory (and necessary parent directories if they do not exist). If there is
|
|
3301
|
+
"""Creates the specified directory (and necessary parent directories if they do not exist). If there is
|
|
3372
3302
|
an object (not a directory) at any prefix of the input path, this call returns an error
|
|
3373
3303
|
`RESOURCE_ALREADY_EXISTS`.
|
|
3374
3304
|
|
|
@@ -3398,9 +3328,7 @@ class WorkspaceAPI:
|
|
|
3398
3328
|
*,
|
|
3399
3329
|
access_control_list: Optional[List[WorkspaceObjectAccessControlRequest]] = None,
|
|
3400
3330
|
) -> WorkspaceObjectPermissions:
|
|
3401
|
-
"""
|
|
3402
|
-
|
|
3403
|
-
Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
|
|
3331
|
+
"""Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
|
|
3404
3332
|
permissions if none are specified. Objects can inherit permissions from their parent objects or root
|
|
3405
3333
|
object.
|
|
3406
3334
|
|
|
@@ -3432,9 +3360,7 @@ class WorkspaceAPI:
|
|
|
3432
3360
|
*,
|
|
3433
3361
|
access_control_list: Optional[List[WorkspaceObjectAccessControlRequest]] = None,
|
|
3434
3362
|
) -> WorkspaceObjectPermissions:
|
|
3435
|
-
"""
|
|
3436
|
-
|
|
3437
|
-
Updates the permissions on a workspace object. Workspace objects can inherit permissions from their
|
|
3363
|
+
"""Updates the permissions on a workspace object. Workspace objects can inherit permissions from their
|
|
3438
3364
|
parent objects or root object.
|
|
3439
3365
|
|
|
3440
3366
|
:param workspace_object_type: str
|
databricks/sdk/version.py
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
__version__ = "0.
|
|
1
|
+
__version__ = "0.58.0"
|