databricks-sdk 0.56.0__py3-none-any.whl → 0.57.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of databricks-sdk might be problematic. Click here for more details.

Files changed (31) hide show
  1. databricks/sdk/__init__.py +15 -9
  2. databricks/sdk/service/aibuilder.py +157 -16
  3. databricks/sdk/service/apps.py +14 -42
  4. databricks/sdk/service/billing.py +17 -51
  5. databricks/sdk/service/catalog.py +198 -399
  6. databricks/sdk/service/cleanrooms.py +11 -33
  7. databricks/sdk/service/compute.py +63 -189
  8. databricks/sdk/service/dashboards.py +21 -63
  9. databricks/sdk/service/database.py +45 -30
  10. databricks/sdk/service/files.py +18 -54
  11. databricks/sdk/service/iam.py +55 -165
  12. databricks/sdk/service/jobs.py +232 -85
  13. databricks/sdk/service/marketplace.py +46 -146
  14. databricks/sdk/service/ml.py +455 -216
  15. databricks/sdk/service/oauth2.py +17 -45
  16. databricks/sdk/service/pipelines.py +81 -40
  17. databricks/sdk/service/provisioning.py +30 -90
  18. databricks/sdk/service/qualitymonitorv2.py +5 -15
  19. databricks/sdk/service/serving.py +30 -42
  20. databricks/sdk/service/settings.py +103 -314
  21. databricks/sdk/service/sharing.py +30 -86
  22. databricks/sdk/service/sql.py +74 -184
  23. databricks/sdk/service/vectorsearch.py +13 -43
  24. databricks/sdk/service/workspace.py +35 -105
  25. databricks/sdk/version.py +1 -1
  26. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/METADATA +1 -1
  27. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/RECORD +31 -31
  28. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/WHEEL +0 -0
  29. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/licenses/LICENSE +0 -0
  30. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/licenses/NOTICE +0 -0
  31. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/top_level.txt +0 -0
@@ -1755,9 +1755,7 @@ class VectorSearchEndpointsAPI:
1755
1755
  def create_endpoint(
1756
1756
  self, name: str, endpoint_type: EndpointType, *, budget_policy_id: Optional[str] = None
1757
1757
  ) -> Wait[EndpointInfo]:
1758
- """Create an endpoint.
1759
-
1760
- Create a new endpoint.
1758
+ """Create a new endpoint.
1761
1759
 
1762
1760
  :param name: str
1763
1761
  Name of the vector search endpoint
@@ -1802,9 +1800,7 @@ class VectorSearchEndpointsAPI:
1802
1800
  )
1803
1801
 
1804
1802
  def delete_endpoint(self, endpoint_name: str):
1805
- """Delete an endpoint.
1806
-
1807
- Delete a vector search endpoint.
1803
+ """Delete a vector search endpoint.
1808
1804
 
1809
1805
  :param endpoint_name: str
1810
1806
  Name of the vector search endpoint
@@ -1819,9 +1815,7 @@ class VectorSearchEndpointsAPI:
1819
1815
  self._api.do("DELETE", f"/api/2.0/vector-search/endpoints/{endpoint_name}", headers=headers)
1820
1816
 
1821
1817
  def get_endpoint(self, endpoint_name: str) -> EndpointInfo:
1822
- """Get an endpoint.
1823
-
1824
- Get details for a single vector search endpoint.
1818
+ """Get details for a single vector search endpoint.
1825
1819
 
1826
1820
  :param endpoint_name: str
1827
1821
  Name of the endpoint
@@ -1837,9 +1831,7 @@ class VectorSearchEndpointsAPI:
1837
1831
  return EndpointInfo.from_dict(res)
1838
1832
 
1839
1833
  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.
1834
+ """List all vector search endpoints in the workspace.
1843
1835
 
1844
1836
  :param page_token: str (optional)
1845
1837
  Token for pagination
@@ -1866,9 +1858,7 @@ class VectorSearchEndpointsAPI:
1866
1858
  def update_endpoint_budget_policy(
1867
1859
  self, endpoint_name: str, budget_policy_id: str
1868
1860
  ) -> PatchEndpointBudgetPolicyResponse:
1869
- """Update the budget policy of an endpoint.
1870
-
1871
- Update the budget policy of an endpoint
1861
+ """Update the budget policy of an endpoint
1872
1862
 
1873
1863
  :param endpoint_name: str
1874
1864
  Name of the vector search endpoint
@@ -1938,9 +1928,7 @@ class VectorSearchIndexesAPI:
1938
1928
  delta_sync_index_spec: Optional[DeltaSyncVectorIndexSpecRequest] = None,
1939
1929
  direct_access_index_spec: Optional[DirectAccessVectorIndexSpec] = None,
1940
1930
  ) -> VectorIndex:
1941
- """Create an index.
1942
-
1943
- Create a new index.
1931
+ """Create a new index.
1944
1932
 
1945
1933
  :param name: str
1946
1934
  Name of the index
@@ -1982,9 +1970,7 @@ class VectorSearchIndexesAPI:
1982
1970
  return VectorIndex.from_dict(res)
1983
1971
 
1984
1972
  def delete_data_vector_index(self, index_name: str, primary_keys: List[str]) -> DeleteDataVectorIndexResponse:
1985
- """Delete data from index.
1986
-
1987
- Handles the deletion of data from a specified vector index.
1973
+ """Handles the deletion of data from a specified vector index.
1988
1974
 
1989
1975
  :param index_name: str
1990
1976
  Name of the vector index where data is to be deleted. Must be a Direct Vector Access Index.
@@ -2009,8 +1995,6 @@ class VectorSearchIndexesAPI:
2009
1995
  def delete_index(self, index_name: str):
2010
1996
  """Delete an index.
2011
1997
 
2012
- Delete an index.
2013
-
2014
1998
  :param index_name: str
2015
1999
  Name of the index
2016
2000
 
@@ -2026,8 +2010,6 @@ class VectorSearchIndexesAPI:
2026
2010
  def get_index(self, index_name: str) -> VectorIndex:
2027
2011
  """Get an index.
2028
2012
 
2029
- Get an index.
2030
-
2031
2013
  :param index_name: str
2032
2014
  Name of the index
2033
2015
 
@@ -2042,9 +2024,7 @@ class VectorSearchIndexesAPI:
2042
2024
  return VectorIndex.from_dict(res)
2043
2025
 
2044
2026
  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.
2027
+ """List all indexes in the given endpoint.
2048
2028
 
2049
2029
  :param endpoint_name: str
2050
2030
  Name of the endpoint
@@ -2085,9 +2065,7 @@ class VectorSearchIndexesAPI:
2085
2065
  query_vector: Optional[List[float]] = None,
2086
2066
  score_threshold: Optional[float] = None,
2087
2067
  ) -> QueryVectorIndexResponse:
2088
- """Query an index.
2089
-
2090
- Query the specified vector index.
2068
+ """Query the specified vector index.
2091
2069
 
2092
2070
  :param index_name: str
2093
2071
  Name of the vector index to query.
@@ -2145,9 +2123,7 @@ class VectorSearchIndexesAPI:
2145
2123
  def query_next_page(
2146
2124
  self, index_name: str, *, endpoint_name: Optional[str] = None, page_token: Optional[str] = None
2147
2125
  ) -> QueryVectorIndexResponse:
2148
- """Query next page.
2149
-
2150
- Use `next_page_token` returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` request
2126
+ """Use `next_page_token` returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` request
2151
2127
  to fetch next page of results.
2152
2128
 
2153
2129
  :param index_name: str
@@ -2177,9 +2153,7 @@ class VectorSearchIndexesAPI:
2177
2153
  def scan_index(
2178
2154
  self, index_name: str, *, last_primary_key: Optional[str] = None, num_results: Optional[int] = None
2179
2155
  ) -> ScanVectorIndexResponse:
2180
- """Scan an index.
2181
-
2182
- Scan the specified vector index and return the first `num_results` entries after the exclusive
2156
+ """Scan the specified vector index and return the first `num_results` entries after the exclusive
2183
2157
  `primary_key`.
2184
2158
 
2185
2159
  :param index_name: str
@@ -2205,9 +2179,7 @@ class VectorSearchIndexesAPI:
2205
2179
  return ScanVectorIndexResponse.from_dict(res)
2206
2180
 
2207
2181
  def sync_index(self, index_name: str):
2208
- """Synchronize an index.
2209
-
2210
- Triggers a synchronization process for a specified vector index.
2182
+ """Triggers a synchronization process for a specified vector index.
2211
2183
 
2212
2184
  :param index_name: str
2213
2185
  Name of the vector index to synchronize. Must be a Delta Sync Index.
@@ -2222,9 +2194,7 @@ class VectorSearchIndexesAPI:
2222
2194
  self._api.do("POST", f"/api/2.0/vector-search/indexes/{index_name}/sync", headers=headers)
2223
2195
 
2224
2196
  def upsert_data_vector_index(self, index_name: str, inputs_json: str) -> UpsertDataVectorIndexResponse:
2225
- """Upsert data into an index.
2226
-
2227
- Handles the upserting of data into a specified vector index.
2197
+ """Handles the upserting of data into a specified vector index.
2228
2198
 
2229
2199
  :param index_name: str
2230
2200
  Name of the vector index where data is to be upserted. Must be a Direct Vector Access Index.
@@ -2372,9 +2372,7 @@ class GitCredentialsAPI:
2372
2372
  def create(
2373
2373
  self, git_provider: str, *, git_username: Optional[str] = None, personal_access_token: Optional[str] = None
2374
2374
  ) -> CreateCredentialsResponse:
2375
- """Create a credential entry.
2376
-
2377
- Creates a Git credential entry for the user. Only one Git credential per user is supported, so any
2375
+ """Creates a Git credential entry for the user. Only one Git credential per user is supported, so any
2378
2376
  attempts to create credentials if an entry already exists will fail. Use the PATCH endpoint to update
2379
2377
  existing credentials, or the DELETE endpoint to delete existing credentials.
2380
2378
 
@@ -2412,9 +2410,7 @@ class GitCredentialsAPI:
2412
2410
  return CreateCredentialsResponse.from_dict(res)
2413
2411
 
2414
2412
  def delete(self, credential_id: int):
2415
- """Delete a credential.
2416
-
2417
- Deletes the specified Git credential.
2413
+ """Deletes the specified Git credential.
2418
2414
 
2419
2415
  :param credential_id: int
2420
2416
  The ID for the corresponding credential to access.
@@ -2429,9 +2425,7 @@ class GitCredentialsAPI:
2429
2425
  self._api.do("DELETE", f"/api/2.0/git-credentials/{credential_id}", headers=headers)
2430
2426
 
2431
2427
  def get(self, credential_id: int) -> GetCredentialsResponse:
2432
- """Get a credential entry.
2433
-
2434
- Gets the Git credential with the specified credential ID.
2428
+ """Gets the Git credential with the specified credential ID.
2435
2429
 
2436
2430
  :param credential_id: int
2437
2431
  The ID for the corresponding credential to access.
@@ -2447,9 +2441,7 @@ class GitCredentialsAPI:
2447
2441
  return GetCredentialsResponse.from_dict(res)
2448
2442
 
2449
2443
  def list(self) -> Iterator[CredentialInfo]:
2450
- """Get Git credentials.
2451
-
2452
- Lists the calling user's Git credentials. One credential per user is supported.
2444
+ """Lists the calling user's Git credentials. One credential per user is supported.
2453
2445
 
2454
2446
  :returns: Iterator over :class:`CredentialInfo`
2455
2447
  """
@@ -2470,9 +2462,7 @@ class GitCredentialsAPI:
2470
2462
  git_username: Optional[str] = None,
2471
2463
  personal_access_token: Optional[str] = None,
2472
2464
  ):
2473
- """Update a credential.
2474
-
2475
- Updates the specified Git credential.
2465
+ """Updates the specified Git credential.
2476
2466
 
2477
2467
  :param credential_id: int
2478
2468
  The ID for the corresponding credential to access.
@@ -2526,9 +2516,7 @@ class ReposAPI:
2526
2516
  def create(
2527
2517
  self, url: str, provider: str, *, path: Optional[str] = None, sparse_checkout: Optional[SparseCheckout] = None
2528
2518
  ) -> CreateRepoResponse:
2529
- """Create a repo.
2530
-
2531
- Creates a repo in the workspace and links it to the remote Git repo specified. Note that repos created
2519
+ """Creates a repo in the workspace and links it to the remote Git repo specified. Note that repos created
2532
2520
  programmatically must be linked to a remote Git repo, unlike repos created in the browser.
2533
2521
 
2534
2522
  :param url: str
@@ -2564,9 +2552,7 @@ class ReposAPI:
2564
2552
  return CreateRepoResponse.from_dict(res)
2565
2553
 
2566
2554
  def delete(self, repo_id: int):
2567
- """Delete a repo.
2568
-
2569
- Deletes the specified repo.
2555
+ """Deletes the specified repo.
2570
2556
 
2571
2557
  :param repo_id: int
2572
2558
  The ID for the corresponding repo to delete.
@@ -2581,9 +2567,7 @@ class ReposAPI:
2581
2567
  self._api.do("DELETE", f"/api/2.0/repos/{repo_id}", headers=headers)
2582
2568
 
2583
2569
  def get(self, repo_id: int) -> GetRepoResponse:
2584
- """Get a repo.
2585
-
2586
- Returns the repo with the given repo ID.
2570
+ """Returns the repo with the given repo ID.
2587
2571
 
2588
2572
  :param repo_id: int
2589
2573
  ID of the Git folder (repo) object in the workspace.
@@ -2599,9 +2583,7 @@ class ReposAPI:
2599
2583
  return GetRepoResponse.from_dict(res)
2600
2584
 
2601
2585
  def get_permission_levels(self, repo_id: str) -> GetRepoPermissionLevelsResponse:
2602
- """Get repo permission levels.
2603
-
2604
- Gets the permission levels that a user can have on an object.
2586
+ """Gets the permission levels that a user can have on an object.
2605
2587
 
2606
2588
  :param repo_id: str
2607
2589
  The repo for which to get or manage permissions.
@@ -2617,9 +2599,7 @@ class ReposAPI:
2617
2599
  return GetRepoPermissionLevelsResponse.from_dict(res)
2618
2600
 
2619
2601
  def get_permissions(self, repo_id: str) -> RepoPermissions:
2620
- """Get repo permissions.
2621
-
2622
- Gets the permissions of a repo. Repos can inherit permissions from their root object.
2602
+ """Gets the permissions of a repo. Repos can inherit permissions from their root object.
2623
2603
 
2624
2604
  :param repo_id: str
2625
2605
  The repo for which to get or manage permissions.
@@ -2635,9 +2615,7 @@ class ReposAPI:
2635
2615
  return RepoPermissions.from_dict(res)
2636
2616
 
2637
2617
  def list(self, *, next_page_token: Optional[str] = None, path_prefix: Optional[str] = None) -> Iterator[RepoInfo]:
2638
- """Get repos.
2639
-
2640
- Returns repos that the calling user has Manage permissions on. Use `next_page_token` to iterate
2618
+ """Returns repos that the calling user has Manage permissions on. Use `next_page_token` to iterate
2641
2619
  through additional pages.
2642
2620
 
2643
2621
  :param next_page_token: str (optional)
@@ -2672,9 +2650,7 @@ class ReposAPI:
2672
2650
  def set_permissions(
2673
2651
  self, repo_id: str, *, access_control_list: Optional[List[RepoAccessControlRequest]] = None
2674
2652
  ) -> RepoPermissions:
2675
- """Set repo permissions.
2676
-
2677
- Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
2653
+ """Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
2678
2654
  permissions if none are specified. Objects can inherit permissions from their root object.
2679
2655
 
2680
2656
  :param repo_id: str
@@ -2702,9 +2678,7 @@ class ReposAPI:
2702
2678
  sparse_checkout: Optional[SparseCheckoutUpdate] = None,
2703
2679
  tag: Optional[str] = None,
2704
2680
  ):
2705
- """Update a repo.
2706
-
2707
- Updates the repo to a different branch or tag, or updates the repo to the latest commit on the same
2681
+ """Updates the repo to a different branch or tag, or updates the repo to the latest commit on the same
2708
2682
  branch.
2709
2683
 
2710
2684
  :param repo_id: int
@@ -2738,9 +2712,7 @@ class ReposAPI:
2738
2712
  def update_permissions(
2739
2713
  self, repo_id: str, *, access_control_list: Optional[List[RepoAccessControlRequest]] = None
2740
2714
  ) -> RepoPermissions:
2741
- """Update repo permissions.
2742
-
2743
- Updates the permissions on a repo. Repos can inherit permissions from their root object.
2715
+ """Updates the permissions on a repo. Repos can inherit permissions from their root object.
2744
2716
 
2745
2717
  :param repo_id: str
2746
2718
  The repo for which to get or manage permissions.
@@ -2782,9 +2754,7 @@ class SecretsAPI:
2782
2754
  initial_manage_principal: Optional[str] = None,
2783
2755
  scope_backend_type: Optional[ScopeBackendType] = None,
2784
2756
  ):
2785
- """Create a new secret scope.
2786
-
2787
- The scope name must consist of alphanumeric characters, dashes, underscores, and periods, and may not
2757
+ """The scope name must consist of alphanumeric characters, dashes, underscores, and periods, and may not
2788
2758
  exceed 128 characters.
2789
2759
 
2790
2760
  :param scope: str
@@ -2815,9 +2785,7 @@ class SecretsAPI:
2815
2785
  self._api.do("POST", "/api/2.0/secrets/scopes/create", body=body, headers=headers)
2816
2786
 
2817
2787
  def delete_acl(self, scope: str, principal: str):
2818
- """Delete an ACL.
2819
-
2820
- Deletes the given ACL on the given scope.
2788
+ """Deletes the given ACL on the given scope.
2821
2789
 
2822
2790
  Users must have the `MANAGE` permission to invoke this API. Throws `RESOURCE_DOES_NOT_EXIST` if no
2823
2791
  such secret scope, principal, or ACL exists. Throws `PERMISSION_DENIED` if the user does not have
@@ -2843,9 +2811,7 @@ class SecretsAPI:
2843
2811
  self._api.do("POST", "/api/2.0/secrets/acls/delete", body=body, headers=headers)
2844
2812
 
2845
2813
  def delete_scope(self, scope: str):
2846
- """Delete a secret scope.
2847
-
2848
- Deletes a secret scope.
2814
+ """Deletes a secret scope.
2849
2815
 
2850
2816
  Throws `RESOURCE_DOES_NOT_EXIST` if the scope does not exist. Throws `PERMISSION_DENIED` if the user
2851
2817
  does not have permission to make this API call.
@@ -2866,9 +2832,7 @@ class SecretsAPI:
2866
2832
  self._api.do("POST", "/api/2.0/secrets/scopes/delete", body=body, headers=headers)
2867
2833
 
2868
2834
  def delete_secret(self, scope: str, key: str):
2869
- """Delete a secret.
2870
-
2871
- Deletes the secret stored in this secret scope. You must have `WRITE` or `MANAGE` permission on the
2835
+ """Deletes the secret stored in this secret scope. You must have `WRITE` or `MANAGE` permission on the
2872
2836
  secret scope.
2873
2837
 
2874
2838
  Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope or secret exists. Throws `PERMISSION_DENIED`
@@ -2894,9 +2858,7 @@ class SecretsAPI:
2894
2858
  self._api.do("POST", "/api/2.0/secrets/delete", body=body, headers=headers)
2895
2859
 
2896
2860
  def get_acl(self, scope: str, principal: str) -> AclItem:
2897
- """Get secret ACL details.
2898
-
2899
- Gets the details about the given ACL, such as the group and permission. Users must have the `MANAGE`
2861
+ """Gets the details about the given ACL, such as the group and permission. Users must have the `MANAGE`
2900
2862
  permission to invoke this API.
2901
2863
 
2902
2864
  Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope exists. Throws `PERMISSION_DENIED` if the
@@ -2923,9 +2885,7 @@ class SecretsAPI:
2923
2885
  return AclItem.from_dict(res)
2924
2886
 
2925
2887
  def get_secret(self, scope: str, key: str) -> GetSecretResponse:
2926
- """Get a secret.
2927
-
2928
- Gets the bytes representation of a secret value for the specified scope and key.
2888
+ """Gets the bytes representation of a secret value for the specified scope and key.
2929
2889
 
2930
2890
  Users need the READ permission to make this call.
2931
2891
 
@@ -2956,9 +2916,7 @@ class SecretsAPI:
2956
2916
  return GetSecretResponse.from_dict(res)
2957
2917
 
2958
2918
  def list_acls(self, scope: str) -> Iterator[AclItem]:
2959
- """Lists ACLs.
2960
-
2961
- List the ACLs for a given secret scope. Users must have the `MANAGE` permission to invoke this API.
2919
+ """List the ACLs for a given secret scope. Users must have the `MANAGE` permission to invoke this API.
2962
2920
 
2963
2921
  Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope exists. Throws `PERMISSION_DENIED` if the
2964
2922
  user does not have permission to make this API call.
@@ -2981,9 +2939,7 @@ class SecretsAPI:
2981
2939
  return parsed if parsed is not None else []
2982
2940
 
2983
2941
  def list_scopes(self) -> Iterator[SecretScope]:
2984
- """List all scopes.
2985
-
2986
- Lists all secret scopes available in the workspace.
2942
+ """Lists all secret scopes available in the workspace.
2987
2943
 
2988
2944
  Throws `PERMISSION_DENIED` if the user does not have permission to make this API call.
2989
2945
 
@@ -2999,9 +2955,7 @@ class SecretsAPI:
2999
2955
  return parsed if parsed is not None else []
3000
2956
 
3001
2957
  def list_secrets(self, scope: str) -> Iterator[SecretMetadata]:
3002
- """List secret keys.
3003
-
3004
- Lists the secret keys that are stored at this scope. This is a metadata-only operation; secret data
2958
+ """Lists the secret keys that are stored at this scope. This is a metadata-only operation; secret data
3005
2959
  cannot be retrieved using this API. Users need the READ permission to make this call.
3006
2960
 
3007
2961
  The lastUpdatedTimestamp returned is in milliseconds since epoch. Throws `RESOURCE_DOES_NOT_EXIST` if
@@ -3026,9 +2980,7 @@ class SecretsAPI:
3026
2980
  return parsed if parsed is not None else []
3027
2981
 
3028
2982
  def put_acl(self, scope: str, principal: str, permission: AclPermission):
3029
- """Create/update an ACL.
3030
-
3031
- Creates or overwrites the Access Control List (ACL) associated with the given principal (user or
2983
+ """Creates or overwrites the Access Control List (ACL) associated with the given principal (user or
3032
2984
  group) on the specified scope point.
3033
2985
 
3034
2986
  In general, a user or group will use the most powerful permission available to them, and permissions
@@ -3079,9 +3031,7 @@ class SecretsAPI:
3079
3031
  def put_secret(
3080
3032
  self, scope: str, key: str, *, bytes_value: Optional[str] = None, string_value: Optional[str] = None
3081
3033
  ):
3082
- """Add a secret.
3083
-
3084
- Inserts a secret under the provided scope with the given name. If a secret already exists with the
3034
+ """Inserts a secret under the provided scope with the given name. If a secret already exists with the
3085
3035
  same name, this command overwrites the existing secret's value. The server encrypts the secret using
3086
3036
  the secret scope's encryption settings before storing it.
3087
3037
 
@@ -3135,9 +3085,7 @@ class WorkspaceAPI:
3135
3085
  self._api = api_client
3136
3086
 
3137
3087
  def delete(self, path: str, *, recursive: Optional[bool] = None):
3138
- """Delete a workspace object.
3139
-
3140
- Deletes an object or a directory (and optionally recursively deletes all objects in the directory). *
3088
+ """Deletes an object or a directory (and optionally recursively deletes all objects in the directory). *
3141
3089
  If `path` does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`. * If `path` is a
3142
3090
  non-empty directory and `recursive` is set to `false`, this call returns an error
3143
3091
  `DIRECTORY_NOT_EMPTY`.
@@ -3166,9 +3114,7 @@ class WorkspaceAPI:
3166
3114
  self._api.do("POST", "/api/2.0/workspace/delete", body=body, headers=headers)
3167
3115
 
3168
3116
  def export(self, path: str, *, format: Optional[ExportFormat] = None) -> ExportResponse:
3169
- """Export a workspace object.
3170
-
3171
- Exports an object or the contents of an entire directory.
3117
+ """Exports an object or the contents of an entire directory.
3172
3118
 
3173
3119
  If `path` does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`.
3174
3120
 
@@ -3208,9 +3154,7 @@ class WorkspaceAPI:
3208
3154
  def get_permission_levels(
3209
3155
  self, workspace_object_type: str, workspace_object_id: str
3210
3156
  ) -> GetWorkspaceObjectPermissionLevelsResponse:
3211
- """Get workspace object permission levels.
3212
-
3213
- Gets the permission levels that a user can have on an object.
3157
+ """Gets the permission levels that a user can have on an object.
3214
3158
 
3215
3159
  :param workspace_object_type: str
3216
3160
  The workspace object type for which to get or manage permissions.
@@ -3232,9 +3176,7 @@ class WorkspaceAPI:
3232
3176
  return GetWorkspaceObjectPermissionLevelsResponse.from_dict(res)
3233
3177
 
3234
3178
  def get_permissions(self, workspace_object_type: str, workspace_object_id: str) -> WorkspaceObjectPermissions:
3235
- """Get workspace object permissions.
3236
-
3237
- Gets the permissions of a workspace object. Workspace objects can inherit permissions from their
3179
+ """Gets the permissions of a workspace object. Workspace objects can inherit permissions from their
3238
3180
  parent objects or root object.
3239
3181
 
3240
3182
  :param workspace_object_type: str
@@ -3255,9 +3197,7 @@ class WorkspaceAPI:
3255
3197
  return WorkspaceObjectPermissions.from_dict(res)
3256
3198
 
3257
3199
  def get_status(self, path: str) -> ObjectInfo:
3258
- """Get status.
3259
-
3260
- Gets the status of an object or a directory. If `path` does not exist, this call returns an error
3200
+ """Gets the status of an object or a directory. If `path` does not exist, this call returns an error
3261
3201
  `RESOURCE_DOES_NOT_EXIST`.
3262
3202
 
3263
3203
  :param path: str
@@ -3285,9 +3225,7 @@ class WorkspaceAPI:
3285
3225
  language: Optional[Language] = None,
3286
3226
  overwrite: Optional[bool] = None,
3287
3227
  ):
3288
- """Import a workspace object.
3289
-
3290
- Imports a workspace object (for example, a notebook or file) or the contents of an entire directory.
3228
+ """Imports a workspace object (for example, a notebook or file) or the contents of an entire directory.
3291
3229
  If `path` already exists and `overwrite` is set to `false`, this call returns an error
3292
3230
  `RESOURCE_ALREADY_EXISTS`. To import a directory, you can use either the `DBC` format or the `SOURCE`
3293
3231
  format with the `language` field unset. To import a single file as `SOURCE`, you must set the
@@ -3339,9 +3277,7 @@ class WorkspaceAPI:
3339
3277
  self._api.do("POST", "/api/2.0/workspace/import", body=body, headers=headers)
3340
3278
 
3341
3279
  def list(self, path: str, *, notebooks_modified_after: Optional[int] = None) -> Iterator[ObjectInfo]:
3342
- """List contents.
3343
-
3344
- Lists the contents of a directory, or the object if it is not a directory. If the input path does not
3280
+ """Lists the contents of a directory, or the object if it is not a directory. If the input path does not
3345
3281
  exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`.
3346
3282
 
3347
3283
  :param path: str
@@ -3366,9 +3302,7 @@ class WorkspaceAPI:
3366
3302
  return parsed if parsed is not None else []
3367
3303
 
3368
3304
  def mkdirs(self, path: str):
3369
- """Create a directory.
3370
-
3371
- Creates the specified directory (and necessary parent directories if they do not exist). If there is
3305
+ """Creates the specified directory (and necessary parent directories if they do not exist). If there is
3372
3306
  an object (not a directory) at any prefix of the input path, this call returns an error
3373
3307
  `RESOURCE_ALREADY_EXISTS`.
3374
3308
 
@@ -3398,9 +3332,7 @@ class WorkspaceAPI:
3398
3332
  *,
3399
3333
  access_control_list: Optional[List[WorkspaceObjectAccessControlRequest]] = None,
3400
3334
  ) -> WorkspaceObjectPermissions:
3401
- """Set workspace object permissions.
3402
-
3403
- Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
3335
+ """Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
3404
3336
  permissions if none are specified. Objects can inherit permissions from their parent objects or root
3405
3337
  object.
3406
3338
 
@@ -3432,9 +3364,7 @@ class WorkspaceAPI:
3432
3364
  *,
3433
3365
  access_control_list: Optional[List[WorkspaceObjectAccessControlRequest]] = None,
3434
3366
  ) -> WorkspaceObjectPermissions:
3435
- """Update workspace object permissions.
3436
-
3437
- Updates the permissions on a workspace object. Workspace objects can inherit permissions from their
3367
+ """Updates the permissions on a workspace object. Workspace objects can inherit permissions from their
3438
3368
  parent objects or root object.
3439
3369
 
3440
3370
  :param workspace_object_type: str
databricks/sdk/version.py CHANGED
@@ -1 +1 @@
1
- __version__ = "0.56.0"
1
+ __version__ = "0.57.0"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: databricks-sdk
3
- Version: 0.56.0
3
+ Version: 0.57.0
4
4
  Summary: Databricks SDK for Python (Beta)
5
5
  Project-URL: Documentation, https://databricks-sdk-py.readthedocs.io
6
6
  Keywords: databricks,sdk
@@ -1,5 +1,5 @@
1
1
  databricks/__init__.py,sha256=CF2MJcZFwbpn9TwQER8qnCDhkPooBGQNVkX4v7g6p3g,537
2
- databricks/sdk/__init__.py,sha256=PNn6lVdcn-IpZyM2Ll_VCmL1GapmIcpLWd3uZ7RXGSw,58527
2
+ databricks/sdk/__init__.py,sha256=j0ZKa_e4JAeGt8mhA4BFMm7P49C-C80v9CS2gvpb8RE,58829
3
3
  databricks/sdk/_base_client.py,sha256=IMHtzC5BhWt-lBVjifewR1Ah5fegGDMv0__-O1hCxWI,15850
4
4
  databricks/sdk/_property.py,sha256=ccbxhkXZmZOxbx2sqKMTzhVZDuvWXG0WPHFRgac6JAM,1701
5
5
  databricks/sdk/azure.py,sha256=sN_ARpmP9h1JovtiHIsDLtrVQP_K11eNDDtHS6PD19k,1015
@@ -17,7 +17,7 @@ databricks/sdk/oidc_token_supplier.py,sha256=QrO6J0QY4yFfcdQDL5h2OfxMxvBZJPtPmPe
17
17
  databricks/sdk/py.typed,sha256=pSvaHpbY1UPNEXyVFUjlgBhjPFZMmVC_UNrPC7eMOHI,74
18
18
  databricks/sdk/retries.py,sha256=7k2kEexGqGKXHNAWHbPFSZSugU8UIU0qtyly_hix22Q,2581
19
19
  databricks/sdk/useragent.py,sha256=boEgzTv-Zmo6boipZKjSopNy0CXg4GShC1_lTKpJgqs,7361
20
- databricks/sdk/version.py,sha256=pLF99dIRilisWyZd9CliPPWqIlV81Xy8XtGEMuThTaM,23
20
+ databricks/sdk/version.py,sha256=jmnoPljZ40w5Zc7DEZpxkJSfC9yHbRjV50qzvnfEbdI,23
21
21
  databricks/sdk/_widgets/__init__.py,sha256=VhI-VvLlr3rKUT1nbROslHJIbmZX_tPJ9rRhrdFsYUA,2811
22
22
  databricks/sdk/_widgets/default_widgets_utils.py,sha256=_hwCbptLbRzWEmknco0H1wQNAYcuy2pjFO9NiRbvFeo,1127
23
23
  databricks/sdk/_widgets/ipywidgets_utils.py,sha256=mg3rEPG9z76e0yVjGgcLybUvd_zSuN5ziGeKiZ-c8Ew,2927
@@ -44,32 +44,32 @@ databricks/sdk/runtime/__init__.py,sha256=6nthZxeYY1HjHieQcP7kXVLIId7w2yfHpZRXXt
44
44
  databricks/sdk/runtime/dbutils_stub.py,sha256=S_pgWyGmwp3Ay-pMDEXccYsPwNVqCtz7MpD3fZVlHUA,11408
45
45
  databricks/sdk/service/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
46
46
  databricks/sdk/service/_internal.py,sha256=PY83MPehEwGuMzCnyvolqglnfZeQ7-eS38kedTa7KDU,1985
47
- databricks/sdk/service/aibuilder.py,sha256=u3WTVBm0sw8aeC9p4kfZAlHtl_6GU2DiNK_vUAMNgfk,12436
48
- databricks/sdk/service/apps.py,sha256=az06ij0_I4G3UcdRs5Pob4uXn5EjJoysXl1F8rR_NQ4,58080
49
- databricks/sdk/service/billing.py,sha256=fAJQNJcFSMwIYlAiX-s9S4FvWZfXE5niwNw7HI9nMUo,96079
50
- databricks/sdk/service/catalog.py,sha256=ZcHscrNVi0T0gU0uLJXD0PpeEtz9_JXi0DuzoRuPwsk,625998
51
- databricks/sdk/service/cleanrooms.py,sha256=mFg0hp7GtO_ZZBZ6p38Gx-ggMNUCJpuvITuh6n-zTLs,63702
52
- databricks/sdk/service/compute.py,sha256=ZNERuPZGZJkNT54Ye9WJhh4ctEssIpcPIRo7eOO8RPg,570795
53
- databricks/sdk/service/dashboards.py,sha256=aDDf23c7O4hAMlMzpAz4m1eSLgI2OjEjhE04PxpSTGc,103473
54
- databricks/sdk/service/database.py,sha256=i-CPsMqX8RJnaa_Nr_J6CxDuoyhls-6rfsKxYToQ8D0,51164
55
- databricks/sdk/service/files.py,sha256=rMu5rmlnhGr1Sic1XWOZi_Pnv-pARQfbumO50JxS4DA,46401
56
- databricks/sdk/service/iam.py,sha256=ZURErK_Nd9aIuU1b2kGZZJg9tXBSfNBRC7QpozJBvwc,179241
57
- databricks/sdk/service/jobs.py,sha256=KfYPBWfgll_LKXg8KgB_bhGiMqoAx2h7WfJoKsA1Efw,475787
58
- databricks/sdk/service/marketplace.py,sha256=NLCJ7zb0Oj5nhLth9R1Szuz6fSSoxAnsKvFhKgx994s,175741
59
- databricks/sdk/service/ml.py,sha256=orS3-xEJWtPibxshGDvyso4MtLdrc9UKGcff6bKlB3E,363830
60
- databricks/sdk/service/oauth2.py,sha256=OMXkb5eo4D7WfCrxBlJeY_jVTHXdpZNJl-Sv8o25jxc,81101
61
- databricks/sdk/service/pipelines.py,sha256=OUdYMS9h1gxiwpK3OqaXNqJochCaByOuvQ_qBxxO4zA,176094
62
- databricks/sdk/service/provisioning.py,sha256=CEzgilTXUNbLjDsvVPxC3mYsAVKHO4v0TnwSIgI373Q,169281
63
- databricks/sdk/service/qualitymonitorv2.py,sha256=lhnw_7wyr3Uj0ywCNE15SUQXg-Qnhz_sJ_wFcXP5w9w,9991
64
- databricks/sdk/service/serving.py,sha256=hrGH4qCSJooHSdUhqyMUXJKfPg126q53cpHpXuWMBUI,231597
65
- databricks/sdk/service/settings.py,sha256=KmPLdnoJoOK7flmuMvrPQvgPCaPiEuQqTj9G4emIFSM,441251
66
- databricks/sdk/service/sharing.py,sha256=ugzmeXN-1PMZS58JHaQZzUSyxmSMebO3dHCsFGbrmkc,160229
67
- databricks/sdk/service/sql.py,sha256=xCj080qniFiVafkt-pne71vfd45sKgLARpObCIDyt90,451364
68
- databricks/sdk/service/vectorsearch.py,sha256=Y1yUJwoY7rg6HWKh7_90aJzIWNiWEG2WUw0i1n3KH7I,86701
69
- databricks/sdk/service/workspace.py,sha256=T0ZbnG1qcPjKysGO_tBzl5x1PyalydeYJRBZbooYNm0,130893
70
- databricks_sdk-0.56.0.dist-info/licenses/LICENSE,sha256=afBgTZo-JsYqj4VOjnejBetMuHKcFR30YobDdpVFkqY,11411
71
- databricks_sdk-0.56.0.dist-info/licenses/NOTICE,sha256=tkRcQYA1k68wDLcnOWbg2xJDsUOJw8G8DGBhb8dnI3w,1588
72
- databricks_sdk-0.56.0.dist-info/METADATA,sha256=XmtTcmgu2d7o6z-RTevL5mQ5D_FsyTVa-oCXcat2ChQ,39397
73
- databricks_sdk-0.56.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
74
- databricks_sdk-0.56.0.dist-info/top_level.txt,sha256=7kRdatoSgU0EUurRQJ_3F1Nv4EOSHWAr6ng25tJOJKU,11
75
- databricks_sdk-0.56.0.dist-info/RECORD,,
47
+ databricks/sdk/service/aibuilder.py,sha256=IabmLtQ2sZDQD2G6cwkIlHKY4bkh-er2IigPriUx9R4,17734
48
+ databricks/sdk/service/apps.py,sha256=6Ieeq0b6KnizYoijhP-p0lk61Pg5T0Z2cHc7LPVbXzE,57695
49
+ databricks/sdk/service/billing.py,sha256=l2TQ22vzQ4OJpjptKPxnbFr3P_6ojdGLhjLZDHY4Z8c,95507
50
+ databricks/sdk/service/catalog.py,sha256=t-LYtZlQLFzt1VzMV60oXNJ432vWIVUFpJS_NiV2c_E,623091
51
+ databricks/sdk/service/cleanrooms.py,sha256=vHiBEb8XqF0x2ikfsVAGamK5EGKOvzP2LP4KTh0LHjk,63388
52
+ databricks/sdk/service/compute.py,sha256=zzJcGWoWSd-dztYCw8ga3VjbqCKcQIbB0Km_r9wYCB0,568655
53
+ databricks/sdk/service/dashboards.py,sha256=jsxmqQc7XtqM-aN5RaCBL5gnCFSozNg_I2cr_BYEuG0,102634
54
+ databricks/sdk/service/database.py,sha256=u5X6JcgfxYRZPmShgkuXD9J18R7ExzxdUE5IglwmShw,52470
55
+ databricks/sdk/service/files.py,sha256=q31vBXCbJIJj6POkCMiPAvbG5gz-Ztw6sh88r9oq-_s,45846
56
+ databricks/sdk/service/iam.py,sha256=zgT7jseJge_F91UtperKsq3RQez1ayBFbATAJkGgGiU,177457
57
+ databricks/sdk/service/jobs.py,sha256=XAMcNULCT0Kz-ptyXB8ItyAyjSfzcoBJ34GcbQJ-WhI,483455
58
+ databricks/sdk/service/marketplace.py,sha256=q_BYJ7FuEC76tIlBO-3QPooNaV3rq_6_Q3gIYEgbgAY,173987
59
+ databricks/sdk/service/ml.py,sha256=LfGpogR1yvOBwKZa3wVphkejLkLyjQIMGI6bIEOoawM,375387
60
+ databricks/sdk/service/oauth2.py,sha256=gpsfMF05wJnEer78lqb_2sps3jiz8gPodyXibT0UEQc,80416
61
+ databricks/sdk/service/pipelines.py,sha256=b-d9Rn7zT2sWU6gYZ9jXF6lrujcHAUfJlzOdsFX2QhA,178921
62
+ databricks/sdk/service/provisioning.py,sha256=-aNadxZdwpZc52Bswrt4rWtx99TKti5DEG8_hREOmXU,168048
63
+ databricks/sdk/service/qualitymonitorv2.py,sha256=W7Mi772dkWTDr-FjRgyUyQ6N8nv3prc5UVSH2fQdwh0,9821
64
+ databricks/sdk/service/serving.py,sha256=fsB92REnXDZmOV7gjSJGyHlYuJlHjFfDRrUor0WhL7M,231582
65
+ databricks/sdk/service/settings.py,sha256=gDMBonDyN6tKpwaRxjr-imSa4T3b3NP6a6Ht3usiBFE,436309
66
+ databricks/sdk/service/sharing.py,sha256=rHyEMxr2AKV2B0Ts2Km5TA6dKVZvwvDOy0162MbKucY,159326
67
+ databricks/sdk/service/sql.py,sha256=3beJc4nKLJuXmTY9BAm9vckjaRZYwc_TC6tWzbHdUgg,450212
68
+ databricks/sdk/service/vectorsearch.py,sha256=JetC69M3SvRYUKLUfga89n6BxC94yvo0lwZCXZNbE7M,86265
69
+ databricks/sdk/service/workspace.py,sha256=grpHcXiw9RcuvbUUoL6NR6Bwz18M71HWqWZg20hr4KA,129823
70
+ databricks_sdk-0.57.0.dist-info/licenses/LICENSE,sha256=afBgTZo-JsYqj4VOjnejBetMuHKcFR30YobDdpVFkqY,11411
71
+ databricks_sdk-0.57.0.dist-info/licenses/NOTICE,sha256=tkRcQYA1k68wDLcnOWbg2xJDsUOJw8G8DGBhb8dnI3w,1588
72
+ databricks_sdk-0.57.0.dist-info/METADATA,sha256=W61TWkiqz6d3BkWzK-yZc7f2WRnUirTvzWpdHbDZxCw,39397
73
+ databricks_sdk-0.57.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
74
+ databricks_sdk-0.57.0.dist-info/top_level.txt,sha256=7kRdatoSgU0EUurRQJ_3F1Nv4EOSHWAr6ng25tJOJKU,11
75
+ databricks_sdk-0.57.0.dist-info/RECORD,,