databricks-sdk 0.154.0__tar.gz → 0.156.0__tar.gz
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.
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/CHANGELOG.md +28 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/PKG-INFO +1 -1
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/config.py +5 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/mixins/files.py +175 -14
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/aisearch.py +3 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/billing.py +60 -6
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/bundledeployments.py +8 -6
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/catalog.py +37 -21
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/iamv2.py +43 -5
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/ml.py +187 -6
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/pipelines.py +60 -2
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/postgres.py +1 -3
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/sandbox.py +3 -3
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/settings.py +2 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/sharing.py +1 -48
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/sql.py +126 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/vectorsearch.py +50 -0
- databricks_sdk-0.156.0/databricks/sdk/version.py +1 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks_sdk.egg-info/PKG-INFO +1 -1
- databricks_sdk-0.154.0/databricks/sdk/version.py +0 -1
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/CONTRIBUTING.md +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/DCO +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/LICENSE +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/MANIFEST.in +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/Makefile +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/NOTICE +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/README.md +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/SECURITY.md +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/__init__.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/__init__.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/_base_client.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/_property.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/_sandbox_grpc/__init__.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/_sandbox_grpc/sandbox_service_pb2.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/_sandbox_grpc/sandbox_service_pb2_grpc.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/_widgets/__init__.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/_widgets/default_widgets_utils.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/_widgets/ipywidgets_utils.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/azure.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/casing.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/client_types.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/clock.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/common/lro.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/common/types/__init__.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/common/types/fieldmask.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/core.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/credentials_provider.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/data_plane.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/dbutils.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/environments.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/errors/__init__.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/errors/base.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/errors/customizer.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/errors/deserializer.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/errors/details.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/errors/mapper.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/errors/overrides.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/errors/parser.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/errors/platform.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/errors/private_link.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/errors/sdk.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/logger/__init__.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/logger/round_trip_logger.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/mixins/__init__.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/mixins/_grpc_transport.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/mixins/compute.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/mixins/files_utils.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/mixins/jobs.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/mixins/open_ai_client.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/mixins/sandbox.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/mixins/sharing.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/mixins/workspace.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/oauth.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/oidc.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/oidc_token_supplier.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/py.typed +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/retries.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/runtime/__init__.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/runtime/dbutils_stub.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/__init__.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/_internal.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/agentbricks.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/agentkit.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/aifunctions.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/apps.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/bundle.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/cleanrooms.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/compute.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/dashboards.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/database.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/dataclassification.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/dataquality.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/disasterrecovery.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/domains.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/environments.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/files.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/iam.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/jobs.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/knowledgeassistants.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/marketplace.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/networking.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/oauth2.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/provisioning.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/qualitymonitorv2.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/serving.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/settingsv2.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/supervisoragents.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/tags.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/workspace.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/useragent.py +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks_sdk.egg-info/SOURCES.txt +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks_sdk.egg-info/dependency_links.txt +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks_sdk.egg-info/requires.txt +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks_sdk.egg-info/top_level.txt +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/pyproject.toml +0 -0
- {databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/setup.cfg +0 -0
|
@@ -1,5 +1,33 @@
|
|
|
1
1
|
# Version changelog
|
|
2
2
|
|
|
3
|
+
## Release v0.156.0 (2026-10-22)
|
|
4
|
+
|
|
5
|
+
### API Changes
|
|
6
|
+
* Add `start_endpoint()` and `stop_endpoint()` methods for [w.vector_search_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/vectorsearch/vector_search_endpoints.html) workspace-level service.
|
|
7
|
+
* Add `include_external_spend` field for `databricks.sdk.service.billing.BudgetConfiguration`.
|
|
8
|
+
* Add `include_external_spend` field for `databricks.sdk.service.billing.CreateBudgetConfigurationBudget`.
|
|
9
|
+
* Add `include_external_spend` field for `databricks.sdk.service.billing.UpdateBudgetConfigurationBudget`.
|
|
10
|
+
* Add `regex` field for `databricks.sdk.service.iamv2.IdentityVisibilityFilter`.
|
|
11
|
+
* Add `relative_error` field for `databricks.sdk.service.ml.ApproxCountDistinctFunction`.
|
|
12
|
+
* Add `relative_error` field for `databricks.sdk.service.ml.ApproxPercentileFunction`.
|
|
13
|
+
* Add `condition`, `min_time_between_triggers` and `wait_after_last_change` fields for `databricks.sdk.service.ml.TableTrigger`.
|
|
14
|
+
* Add `onedrive_options` field for `databricks.sdk.service.pipelines.ConnectorOptions`.
|
|
15
|
+
* Add `stopping`, `stopped` and `starting` enum values for `databricks.sdk.service.aisearch.EndpointStatusState`.
|
|
16
|
+
* Add `operation_action_type_unbind` enum value for `databricks.sdk.service.bundledeployments.OperationActionType`.
|
|
17
|
+
* Add `onedrive` enum value for `databricks.sdk.service.pipelines.IngestionSourceType`.
|
|
18
|
+
* Add `stopping`, `stopped` and `starting` enum values for `databricks.sdk.service.vectorsearch.EndpointStatusState`.
|
|
19
|
+
|
|
20
|
+
## Release v0.155.0 (2026-10-21)
|
|
21
|
+
|
|
22
|
+
### API Changes
|
|
23
|
+
* Add `sdp_source` field for `databricks.sdk.service.ml.DataSource`.
|
|
24
|
+
* Add `customer_version_label`, `max_dbu` and `reyden_cluster_size_multiplier` fields for `databricks.sdk.service.sql.CreateWarehouseRequest`.
|
|
25
|
+
* Add `customer_version_label`, `max_dbu` and `reyden_cluster_size_multiplier` fields for `databricks.sdk.service.sql.EditWarehouseRequest`.
|
|
26
|
+
* Add `customer_version_label`, `max_dbu` and `reyden_cluster_size_multiplier` fields for `databricks.sdk.service.sql.EndpointInfo`.
|
|
27
|
+
* Add `customer_version_label`, `max_dbu` and `reyden_cluster_size_multiplier` fields for `databricks.sdk.service.sql.GetWarehouseResponse`.
|
|
28
|
+
* [Breaking] Remove `replication_config` field for `databricks.sdk.service.sharing.CreateShare`.
|
|
29
|
+
* [Breaking] Remove `replication_config` field for `databricks.sdk.service.sharing.ShareInfo`.
|
|
30
|
+
|
|
3
31
|
## Release v0.154.0 (2026-10-19)
|
|
4
32
|
|
|
5
33
|
### API Changes
|
|
@@ -267,6 +267,11 @@ class Config:
|
|
|
267
267
|
# When enabled, the SDK will probe the storage proxy and use it if available.
|
|
268
268
|
experimental_files_ext_enable_storage_proxy: bool = False
|
|
269
269
|
|
|
270
|
+
# Whether to ask the workspace which endpoints to use for file transfers (GET /api/2.0/fs/endpoints).
|
|
271
|
+
# When disabled, or when the server cannot answer, the SDK uses a built-in order: Presigned URL, then
|
|
272
|
+
# Files API 2.0 on the workspace host.
|
|
273
|
+
experimental_files_ext_enable_endpoints_api: bool = False
|
|
274
|
+
|
|
270
275
|
def __init__(
|
|
271
276
|
self,
|
|
272
277
|
*,
|
|
@@ -16,6 +16,7 @@ from collections.abc import Iterator
|
|
|
16
16
|
from concurrent.futures import ThreadPoolExecutor, as_completed
|
|
17
17
|
from dataclasses import dataclass
|
|
18
18
|
from datetime import timedelta
|
|
19
|
+
from enum import Enum
|
|
19
20
|
from io import BytesIO
|
|
20
21
|
from queue import Empty, Full, Queue
|
|
21
22
|
from tempfile import mkstemp
|
|
@@ -746,6 +747,35 @@ class _PresignedUrl:
|
|
|
746
747
|
part_number: int | None = None
|
|
747
748
|
|
|
748
749
|
|
|
750
|
+
class _ResolvedEndpoint(Enum):
|
|
751
|
+
"""A file transfer protocol this SDK can speak, identified by the (api, api_version) pair the
|
|
752
|
+
endpoints API returns."""
|
|
753
|
+
|
|
754
|
+
IO_OFFLOAD = "IO_OFFLOAD"
|
|
755
|
+
FILES_API_V2 = "FILES_API_V2"
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
# Maps the server's (api, api_version) to a protocol compiled into this SDK. Pairs not listed here are
|
|
759
|
+
# skipped, which lets the server advertise newer protocols without breaking older SDKs. IO_OFFLOAD is
|
|
760
|
+
# unversioned during the preview, so a versioned IO_OFFLOAD is newer than this SDK.
|
|
761
|
+
_RECOGNIZED_ENDPOINTS: dict[tuple[str, Optional[str]], _ResolvedEndpoint] = {
|
|
762
|
+
("IO_OFFLOAD", None): _ResolvedEndpoint.IO_OFFLOAD,
|
|
763
|
+
("FILES_API", "2.0"): _ResolvedEndpoint.FILES_API_V2,
|
|
764
|
+
}
|
|
765
|
+
|
|
766
|
+
_ENDPOINT_SCHEMES = ("http", "https")
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
@dataclass(frozen=True)
|
|
770
|
+
class _Endpoint:
|
|
771
|
+
"""One entry of the ordered endpoint list a file transfer walks, best first."""
|
|
772
|
+
|
|
773
|
+
kind: _ResolvedEndpoint
|
|
774
|
+
base_url: str
|
|
775
|
+
"""Scheme and hostname as returned by the server, e.g. https://example.cloud.databricks.com."""
|
|
776
|
+
multipart_upload_supported: bool
|
|
777
|
+
|
|
778
|
+
|
|
749
779
|
class _PresignedUrlRequestBuilder:
|
|
750
780
|
"""Builds presigned URL requests for file upload operations.
|
|
751
781
|
|
|
@@ -928,6 +958,12 @@ class FilesExt(files.FilesAPI):
|
|
|
928
958
|
# Timeout in seconds for the storage-proxy health check probe.
|
|
929
959
|
_STORAGE_PROXY_PROBE_TIMEOUT: float = 3.0
|
|
930
960
|
|
|
961
|
+
_ENDPOINTS_API_PATH: str = "/api/2.0/fs/endpoints"
|
|
962
|
+
|
|
963
|
+
# Endpoint discovery is a single attempt bounded by this timeout: it precedes a transfer, so it
|
|
964
|
+
# must fail fast to the default order rather than retry and stall the upload or download.
|
|
965
|
+
_ENDPOINTS_RESOLVE_TIMEOUT_SECONDS: float = 10.0
|
|
966
|
+
|
|
931
967
|
@dataclass(frozen=True)
|
|
932
968
|
class _UploadContext:
|
|
933
969
|
target_path: str
|
|
@@ -956,13 +992,129 @@ class FilesExt(files.FilesAPI):
|
|
|
956
992
|
self._dp_hostname_available: Optional[bool] = None
|
|
957
993
|
self._cached_storage_proxy_session: Optional[requests.Session] = None
|
|
958
994
|
self._storage_proxy_session_lock = Lock()
|
|
995
|
+
self._cached_endpoints: Optional[list[_Endpoint]] = None
|
|
996
|
+
self._endpoints_lock = Lock()
|
|
959
997
|
|
|
960
|
-
def
|
|
961
|
-
"""Returns the
|
|
998
|
+
def _resolve_endpoints(self) -> list[_Endpoint]:
|
|
999
|
+
"""Returns the ordered endpoints to try for a file transfer, best first.
|
|
962
1000
|
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
1001
|
+
The server is asked once per client and its answer, including a failure, is cached. Anything
|
|
1002
|
+
short of a usable list falls back to the built-in order, so endpoint discovery never fails a
|
|
1003
|
+
transfer.
|
|
1004
|
+
"""
|
|
1005
|
+
if not self._config.experimental_files_ext_enable_endpoints_api:
|
|
1006
|
+
return self._default_endpoints()
|
|
1007
|
+
with self._endpoints_lock:
|
|
1008
|
+
if self._cached_endpoints is None:
|
|
1009
|
+
self._cached_endpoints = self._fetch_endpoints() or self._default_endpoints()
|
|
1010
|
+
return list(self._cached_endpoints)
|
|
1011
|
+
|
|
1012
|
+
def _default_endpoints(self) -> list[_Endpoint]:
|
|
1013
|
+
host = self._config.host
|
|
1014
|
+
return [
|
|
1015
|
+
_Endpoint(_ResolvedEndpoint.IO_OFFLOAD, host, multipart_upload_supported=True),
|
|
1016
|
+
_Endpoint(_ResolvedEndpoint.FILES_API_V2, host, multipart_upload_supported=False),
|
|
1017
|
+
]
|
|
1018
|
+
|
|
1019
|
+
def _fetch_endpoints(self) -> list[_Endpoint]:
|
|
1020
|
+
"""Fetches the endpoint list from the server, keeping only entries this SDK can speak.
|
|
1021
|
+
|
|
1022
|
+
Discovery runs before a transfer, so it is a single short-timeout attempt with no retries: a
|
|
1023
|
+
slow or failing endpoint must fall back to the default order quickly rather than hold up the
|
|
1024
|
+
upload or download.
|
|
1025
|
+
"""
|
|
1026
|
+
url = f"{self._config.host}{self._ENDPOINTS_API_PATH}"
|
|
1027
|
+
try:
|
|
1028
|
+
response = self._cloud_provider_session().request(
|
|
1029
|
+
"GET",
|
|
1030
|
+
url,
|
|
1031
|
+
headers={**self._config.authenticate(), "Accept": "application/json"},
|
|
1032
|
+
timeout=self._ENDPOINTS_RESOLVE_TIMEOUT_SECONDS,
|
|
1033
|
+
)
|
|
1034
|
+
except Exception as e:
|
|
1035
|
+
# Broad on purpose: network and auth failures must all fail safe to the default order.
|
|
1036
|
+
_LOG.warning(f"Failed to resolve file endpoints, using the default endpoints: {e}")
|
|
1037
|
+
return []
|
|
1038
|
+
|
|
1039
|
+
# Lets a failure below be traced to the server's request log.
|
|
1040
|
+
request_id = response.headers.get("x-request-id")
|
|
1041
|
+
if response.status_code == 404:
|
|
1042
|
+
# Not a warning: until the server-side rollout completes, some workspaces do not serve the API.
|
|
1043
|
+
_LOG.info(
|
|
1044
|
+
f"Endpoints API is not served for this workspace (request ID {request_id}), using the default endpoints."
|
|
1045
|
+
)
|
|
1046
|
+
return []
|
|
1047
|
+
if response.status_code != 200:
|
|
1048
|
+
_LOG.warning(
|
|
1049
|
+
f"Unexpected status resolving file endpoints ({response.status_code}, request ID {request_id}), "
|
|
1050
|
+
"using the default endpoints."
|
|
1051
|
+
)
|
|
1052
|
+
return []
|
|
1053
|
+
try:
|
|
1054
|
+
body = response.json()
|
|
1055
|
+
except Exception as e:
|
|
1056
|
+
_LOG.warning(
|
|
1057
|
+
f"Failed to parse endpoints response (request ID {request_id}), using the default endpoints: {e}"
|
|
1058
|
+
)
|
|
1059
|
+
return []
|
|
1060
|
+
|
|
1061
|
+
# Proto3 JSON leaves out an empty repeated field.
|
|
1062
|
+
entries = body.get("endpoints", []) if isinstance(body, dict) else None
|
|
1063
|
+
if not isinstance(entries, list):
|
|
1064
|
+
_LOG.warning(
|
|
1065
|
+
f"Unexpected endpoints response (request ID {request_id}), using the default endpoints: {body}"
|
|
1066
|
+
)
|
|
1067
|
+
return []
|
|
1068
|
+
endpoints = []
|
|
1069
|
+
for entry in entries:
|
|
1070
|
+
kind = self._endpoint_kind(entry)
|
|
1071
|
+
if kind is None:
|
|
1072
|
+
# Not a warning: an older SDK is expected to skip entries for APIs added after it shipped.
|
|
1073
|
+
_LOG.info(f"Skipping endpoint this SDK cannot use (request ID {request_id}): {entry}")
|
|
1074
|
+
continue
|
|
1075
|
+
endpoint = self._parse_endpoint(entry, kind)
|
|
1076
|
+
if endpoint is None:
|
|
1077
|
+
_LOG.warning(
|
|
1078
|
+
f"Skipping {kind.value} endpoint with an unusable address (request ID {request_id}): {entry}"
|
|
1079
|
+
)
|
|
1080
|
+
continue
|
|
1081
|
+
endpoints.append(endpoint)
|
|
1082
|
+
if not endpoints:
|
|
1083
|
+
_LOG.warning(f"No usable endpoints in the response (request ID {request_id}), using the default endpoints.")
|
|
1084
|
+
return endpoints
|
|
1085
|
+
|
|
1086
|
+
@staticmethod
|
|
1087
|
+
def _endpoint_kind(entry) -> Optional[_ResolvedEndpoint]:
|
|
1088
|
+
"""Returns the protocol of a listed endpoint, or None if this SDK does not speak it."""
|
|
1089
|
+
if not isinstance(entry, dict):
|
|
1090
|
+
return None
|
|
1091
|
+
api = entry.get("api")
|
|
1092
|
+
api_version = entry.get("api_version")
|
|
1093
|
+
# The entry is unvalidated JSON: an unhashable value such as a list would make the lookup below raise
|
|
1094
|
+
# instead of skipping the entry. IO_OFFLOAD entries have no api_version, so None is allowed.
|
|
1095
|
+
if not isinstance(api, str) or not (api_version is None or isinstance(api_version, str)):
|
|
1096
|
+
return None
|
|
1097
|
+
return _RECOGNIZED_ENDPOINTS.get((api, api_version))
|
|
1098
|
+
|
|
1099
|
+
@staticmethod
|
|
1100
|
+
def _parse_endpoint(entry: dict, kind: _ResolvedEndpoint) -> Optional[_Endpoint]:
|
|
1101
|
+
scheme = entry.get("scheme")
|
|
1102
|
+
hostname = entry.get("hostname")
|
|
1103
|
+
if scheme not in _ENDPOINT_SCHEMES or not isinstance(hostname, str) or not hostname:
|
|
1104
|
+
return None
|
|
1105
|
+
# Mirrors the proto getter: an unset optional bool reads as false.
|
|
1106
|
+
multipart_upload_supported = entry.get("multipart_upload_supported") is True
|
|
1107
|
+
return _Endpoint(kind, f"{scheme}://{hostname}", multipart_upload_supported)
|
|
1108
|
+
|
|
1109
|
+
def _active_endpoint(self) -> _Endpoint:
|
|
1110
|
+
"""The endpoint used for bulk file transfer.
|
|
1111
|
+
|
|
1112
|
+
Selected by the storage-proxy probe: the storage proxy (a direct Files API path) when the probe
|
|
1113
|
+
finds it available, otherwise the offload (presigned) path on the workspace host. The probe runs
|
|
1114
|
+
once and its result is cached.
|
|
1115
|
+
|
|
1116
|
+
This is the single-endpoint selection; PR wiring the endpoints API replaces it with a walk over
|
|
1117
|
+
the server-resolved list.
|
|
966
1118
|
"""
|
|
967
1119
|
if self._config.experimental_files_ext_enable_storage_proxy:
|
|
968
1120
|
if self._dp_hostname_available is None:
|
|
@@ -972,19 +1124,28 @@ class FilesExt(files.FilesAPI):
|
|
|
972
1124
|
else:
|
|
973
1125
|
_LOG.info("Storage proxy is not available, will use presigned URLs.")
|
|
974
1126
|
if self._dp_hostname_available:
|
|
975
|
-
return
|
|
976
|
-
|
|
1127
|
+
return _Endpoint(
|
|
1128
|
+
_ResolvedEndpoint.FILES_API_V2, self._STORAGE_PROXY_HOSTNAME, multipart_upload_supported=True
|
|
1129
|
+
)
|
|
1130
|
+
return _Endpoint(_ResolvedEndpoint.IO_OFFLOAD, self._config.host, multipart_upload_supported=True)
|
|
1131
|
+
|
|
1132
|
+
def _get_hostname(self) -> str:
|
|
1133
|
+
"""Returns the scheme+hostname for file operations, e.g. https://example.cloud.databricks.com."""
|
|
1134
|
+
return self._active_endpoint().base_url
|
|
977
1135
|
|
|
978
1136
|
def _create_request_builder(self):
|
|
979
|
-
"""Creates the
|
|
1137
|
+
"""Creates the request builder for the active endpoint."""
|
|
1138
|
+
return self._request_builder_for(self._active_endpoint())
|
|
1139
|
+
|
|
1140
|
+
def _request_builder_for(self, endpoint: _Endpoint):
|
|
1141
|
+
"""Maps an endpoint to the builder that speaks its protocol.
|
|
980
1142
|
|
|
981
|
-
|
|
982
|
-
|
|
1143
|
+
The offload path coordinates presigned URLs through the workspace API; the direct Files API path
|
|
1144
|
+
builds URLs straight at the endpoint host.
|
|
983
1145
|
"""
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
return _PresignedUrlRequestBuilder(self._api, hostname)
|
|
1146
|
+
if endpoint.kind == _ResolvedEndpoint.IO_OFFLOAD:
|
|
1147
|
+
return _PresignedUrlRequestBuilder(self._api, endpoint.base_url)
|
|
1148
|
+
return _StorageProxyRequestBuilder(endpoint.base_url)
|
|
988
1149
|
|
|
989
1150
|
def _resolve_workspace_id(self) -> Optional[str]:
|
|
990
1151
|
"""Resolves the workspace ID by querying the SCIM Me endpoint."""
|
|
@@ -193,8 +193,15 @@ class BudgetConfiguration:
|
|
|
193
193
|
"""Databricks account ID."""
|
|
194
194
|
|
|
195
195
|
alert_configurations: Optional[List[AlertConfiguration]] = None
|
|
196
|
-
"""Alerts to configure when this budget is in a triggered state. Budgets must have
|
|
197
|
-
alert configuration.
|
|
196
|
+
"""Alerts to configure when this budget is in a triggered state. Budgets must have at least one
|
|
197
|
+
alert configuration. A budget can have up to four shared alerts per time period, each with a
|
|
198
|
+
unique ``quantity_threshold``. Budgets with ``resource_type`` set to
|
|
199
|
+
``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY`` can also use per-user alerts, with optional
|
|
200
|
+
``principal_overrides``. These budgets can have at most one per-user alert per time period, and
|
|
201
|
+
can use shared alerts, a per-user alert, or both. The ``BLOCK_USAGE`` action is only supported
|
|
202
|
+
on budgets with ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. At most one
|
|
203
|
+
shared alert per time period can have a ``BLOCK_USAGE`` action, and it must be the shared alert
|
|
204
|
+
with the highest threshold in that period."""
|
|
198
205
|
|
|
199
206
|
budget_configuration_id: Optional[str] = None
|
|
200
207
|
"""Databricks budget configuration ID."""
|
|
@@ -210,6 +217,12 @@ class BudgetConfiguration:
|
|
|
210
217
|
of what is considered for this budget. Leave empty to include all usage for this account. All
|
|
211
218
|
provided filters must be matched for usage to be included."""
|
|
212
219
|
|
|
220
|
+
include_external_spend: Optional[bool] = None
|
|
221
|
+
"""Whether this budget tracks external pass-through spend (third-party costs billed through a
|
|
222
|
+
Databricks product) in addition to internal Databricks spend. Only applicable to Unity Gateway
|
|
223
|
+
budgets, i.e. when ``resource_type`` is ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. This field is
|
|
224
|
+
immutable after create."""
|
|
225
|
+
|
|
213
226
|
resource_type: Optional[BudgetResourceType] = None
|
|
214
227
|
"""The resource scope for this budget. Determines whether the budget tracks all resources or a
|
|
215
228
|
specific resource."""
|
|
@@ -232,6 +245,8 @@ class BudgetConfiguration:
|
|
|
232
245
|
body["display_name"] = self.display_name
|
|
233
246
|
if self.filter:
|
|
234
247
|
body["filter"] = self.filter.as_dict()
|
|
248
|
+
if self.include_external_spend is not None:
|
|
249
|
+
body["include_external_spend"] = self.include_external_spend
|
|
235
250
|
if self.resource_type is not None:
|
|
236
251
|
body["resource_type"] = self.resource_type.value
|
|
237
252
|
if self.update_time is not None:
|
|
@@ -253,6 +268,8 @@ class BudgetConfiguration:
|
|
|
253
268
|
body["display_name"] = self.display_name
|
|
254
269
|
if self.filter:
|
|
255
270
|
body["filter"] = self.filter
|
|
271
|
+
if self.include_external_spend is not None:
|
|
272
|
+
body["include_external_spend"] = self.include_external_spend
|
|
256
273
|
if self.resource_type is not None:
|
|
257
274
|
body["resource_type"] = self.resource_type
|
|
258
275
|
if self.update_time is not None:
|
|
@@ -269,6 +286,7 @@ class BudgetConfiguration:
|
|
|
269
286
|
create_time=_int64(d, "create_time"),
|
|
270
287
|
display_name=d.get("display_name", None),
|
|
271
288
|
filter=_from_dict(d, "filter", BudgetConfigurationFilter),
|
|
289
|
+
include_external_spend=d.get("include_external_spend", None),
|
|
272
290
|
resource_type=_enum(d, "resource_type", BudgetResourceType),
|
|
273
291
|
update_time=_int64(d, "update_time"),
|
|
274
292
|
)
|
|
@@ -504,8 +522,15 @@ class CreateBudgetConfigurationBudget:
|
|
|
504
522
|
"""Databricks account ID."""
|
|
505
523
|
|
|
506
524
|
alert_configurations: Optional[List[CreateBudgetConfigurationBudgetAlertConfigurations]] = None
|
|
507
|
-
"""Alerts to configure when this budget is in a triggered state. Budgets must have
|
|
508
|
-
alert configuration.
|
|
525
|
+
"""Alerts to configure when this budget is in a triggered state. Budgets must have at least one
|
|
526
|
+
alert configuration. A budget can have up to four shared alerts per time period, each with a
|
|
527
|
+
unique ``quantity_threshold``. Budgets with ``resource_type`` set to
|
|
528
|
+
``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY`` can also use per-user alerts, with optional
|
|
529
|
+
``principal_overrides``. These budgets can have at most one per-user alert per time period, and
|
|
530
|
+
can use shared alerts, a per-user alert, or both. The ``BLOCK_USAGE`` action is only supported
|
|
531
|
+
on budgets with ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. At most one
|
|
532
|
+
shared alert per time period can have a ``BLOCK_USAGE`` action, and it must be the shared alert
|
|
533
|
+
with the highest threshold in that period."""
|
|
509
534
|
|
|
510
535
|
display_name: Optional[str] = None
|
|
511
536
|
"""Human-readable name of budget configuration. Max Length: 128"""
|
|
@@ -515,6 +540,12 @@ class CreateBudgetConfigurationBudget:
|
|
|
515
540
|
of what is considered for this budget. Leave empty to include all usage for this account. All
|
|
516
541
|
provided filters must be matched for usage to be included."""
|
|
517
542
|
|
|
543
|
+
include_external_spend: Optional[bool] = None
|
|
544
|
+
"""Whether this budget tracks external pass-through spend (third-party costs billed through a
|
|
545
|
+
Databricks product) in addition to internal Databricks spend. Only applicable to Unity Gateway
|
|
546
|
+
budgets, i.e. when ``resource_type`` is ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. This field is
|
|
547
|
+
immutable after create."""
|
|
548
|
+
|
|
518
549
|
resource_type: Optional[BudgetResourceType] = None
|
|
519
550
|
"""The resource scope for this budget. Determines whether the budget tracks all resources or a
|
|
520
551
|
specific resource."""
|
|
@@ -530,6 +561,8 @@ class CreateBudgetConfigurationBudget:
|
|
|
530
561
|
body["display_name"] = self.display_name
|
|
531
562
|
if self.filter:
|
|
532
563
|
body["filter"] = self.filter.as_dict()
|
|
564
|
+
if self.include_external_spend is not None:
|
|
565
|
+
body["include_external_spend"] = self.include_external_spend
|
|
533
566
|
if self.resource_type is not None:
|
|
534
567
|
body["resource_type"] = self.resource_type.value
|
|
535
568
|
return body
|
|
@@ -545,6 +578,8 @@ class CreateBudgetConfigurationBudget:
|
|
|
545
578
|
body["display_name"] = self.display_name
|
|
546
579
|
if self.filter:
|
|
547
580
|
body["filter"] = self.filter
|
|
581
|
+
if self.include_external_spend is not None:
|
|
582
|
+
body["include_external_spend"] = self.include_external_spend
|
|
548
583
|
if self.resource_type is not None:
|
|
549
584
|
body["resource_type"] = self.resource_type
|
|
550
585
|
return body
|
|
@@ -559,6 +594,7 @@ class CreateBudgetConfigurationBudget:
|
|
|
559
594
|
),
|
|
560
595
|
display_name=d.get("display_name", None),
|
|
561
596
|
filter=_from_dict(d, "filter", BudgetConfigurationFilter),
|
|
597
|
+
include_external_spend=d.get("include_external_spend", None),
|
|
562
598
|
resource_type=_enum(d, "resource_type", BudgetResourceType),
|
|
563
599
|
)
|
|
564
600
|
|
|
@@ -1470,8 +1506,15 @@ class UpdateBudgetConfigurationBudget:
|
|
|
1470
1506
|
"""Databricks account ID."""
|
|
1471
1507
|
|
|
1472
1508
|
alert_configurations: Optional[List[AlertConfiguration]] = None
|
|
1473
|
-
"""Alerts to configure when this budget is in a triggered state. Budgets must have
|
|
1474
|
-
alert configuration.
|
|
1509
|
+
"""Alerts to configure when this budget is in a triggered state. Budgets must have at least one
|
|
1510
|
+
alert configuration. A budget can have up to four shared alerts per time period, each with a
|
|
1511
|
+
unique ``quantity_threshold``. Budgets with ``resource_type`` set to
|
|
1512
|
+
``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY`` can also use per-user alerts, with optional
|
|
1513
|
+
``principal_overrides``. These budgets can have at most one per-user alert per time period, and
|
|
1514
|
+
can use shared alerts, a per-user alert, or both. The ``BLOCK_USAGE`` action is only supported
|
|
1515
|
+
on budgets with ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. At most one
|
|
1516
|
+
shared alert per time period can have a ``BLOCK_USAGE`` action, and it must be the shared alert
|
|
1517
|
+
with the highest threshold in that period."""
|
|
1475
1518
|
|
|
1476
1519
|
budget_configuration_id: Optional[str] = None
|
|
1477
1520
|
"""Databricks budget configuration ID."""
|
|
@@ -1484,6 +1527,12 @@ class UpdateBudgetConfigurationBudget:
|
|
|
1484
1527
|
of what is considered for this budget. Leave empty to include all usage for this account. All
|
|
1485
1528
|
provided filters must be matched for usage to be included."""
|
|
1486
1529
|
|
|
1530
|
+
include_external_spend: Optional[bool] = None
|
|
1531
|
+
"""Whether this budget tracks external pass-through spend (third-party costs billed through a
|
|
1532
|
+
Databricks product) in addition to internal Databricks spend. Only applicable to Unity Gateway
|
|
1533
|
+
budgets, i.e. when ``resource_type`` is ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. This field is
|
|
1534
|
+
immutable after create."""
|
|
1535
|
+
|
|
1487
1536
|
resource_type: Optional[BudgetResourceType] = None
|
|
1488
1537
|
"""The resource scope for this budget. Determines whether the budget tracks all resources or a
|
|
1489
1538
|
specific resource."""
|
|
@@ -1501,6 +1550,8 @@ class UpdateBudgetConfigurationBudget:
|
|
|
1501
1550
|
body["display_name"] = self.display_name
|
|
1502
1551
|
if self.filter:
|
|
1503
1552
|
body["filter"] = self.filter.as_dict()
|
|
1553
|
+
if self.include_external_spend is not None:
|
|
1554
|
+
body["include_external_spend"] = self.include_external_spend
|
|
1504
1555
|
if self.resource_type is not None:
|
|
1505
1556
|
body["resource_type"] = self.resource_type.value
|
|
1506
1557
|
return body
|
|
@@ -1518,6 +1569,8 @@ class UpdateBudgetConfigurationBudget:
|
|
|
1518
1569
|
body["display_name"] = self.display_name
|
|
1519
1570
|
if self.filter:
|
|
1520
1571
|
body["filter"] = self.filter
|
|
1572
|
+
if self.include_external_spend is not None:
|
|
1573
|
+
body["include_external_spend"] = self.include_external_spend
|
|
1521
1574
|
if self.resource_type is not None:
|
|
1522
1575
|
body["resource_type"] = self.resource_type
|
|
1523
1576
|
return body
|
|
@@ -1531,6 +1584,7 @@ class UpdateBudgetConfigurationBudget:
|
|
|
1531
1584
|
budget_configuration_id=d.get("budget_configuration_id", None),
|
|
1532
1585
|
display_name=d.get("display_name", None),
|
|
1533
1586
|
filter=_from_dict(d, "filter", BudgetConfigurationFilter),
|
|
1587
|
+
include_external_spend=d.get("include_external_spend", None),
|
|
1534
1588
|
resource_type=_enum(d, "resource_type", BudgetResourceType),
|
|
1535
1589
|
)
|
|
1536
1590
|
|
{databricks_sdk-0.154.0 → databricks_sdk-0.156.0}/databricks/sdk/service/bundledeployments.py
RENAMED
|
@@ -559,10 +559,11 @@ class Operation:
|
|
|
559
559
|
rejected with ABORTED so the caller can re-read and retry."""
|
|
560
560
|
|
|
561
561
|
state: Optional[str] = None
|
|
562
|
-
"""Serialized local config state after the operation. Its presence records whether the resource
|
|
563
|
-
still
|
|
564
|
-
leaves resource state unchanged. State is stored
|
|
565
|
-
state but omits it from its response, as do
|
|
562
|
+
"""Serialized local config state after the operation. Its presence records whether the resource is
|
|
563
|
+
still tracked by the deployment. Explicitly clearing state removes the resource from the
|
|
564
|
+
deployment; omitting it from the update mask leaves resource state unchanged. State is stored
|
|
565
|
+
only on Resources. UpdateOperation accepts state but omits it from its response, as do
|
|
566
|
+
subsequent GetOperation and ListOperations.
|
|
566
567
|
|
|
567
568
|
Mutable: may be updated after creation via UpdateOperation. When updating, the caller must echo
|
|
568
569
|
the last-observed ``sequence_id`` as a concurrency precondition.
|
|
@@ -674,6 +675,7 @@ class OperationActionType(Enum):
|
|
|
674
675
|
OPERATION_ACTION_TYPE_INITIAL_REGISTER = "OPERATION_ACTION_TYPE_INITIAL_REGISTER"
|
|
675
676
|
OPERATION_ACTION_TYPE_RECREATE = "OPERATION_ACTION_TYPE_RECREATE"
|
|
676
677
|
OPERATION_ACTION_TYPE_RESIZE = "OPERATION_ACTION_TYPE_RESIZE"
|
|
678
|
+
OPERATION_ACTION_TYPE_UNBIND = "OPERATION_ACTION_TYPE_UNBIND"
|
|
677
679
|
OPERATION_ACTION_TYPE_UPDATE = "OPERATION_ACTION_TYPE_UPDATE"
|
|
678
680
|
OPERATION_ACTION_TYPE_UPDATE_WITH_ID = "OPERATION_ACTION_TYPE_UPDATE_WITH_ID"
|
|
679
681
|
|
|
@@ -1529,8 +1531,8 @@ class BundleDeploymentsAPI:
|
|
|
1529
1531
|
value it last observed, and the server rejects the update with ``ABORTED`` if the operation has been
|
|
1530
1532
|
modified since. On success the server increments ``sequence_id``; updates to ``state``,
|
|
1531
1533
|
``resource_id``, and ``dashboard_metadata`` are mirrored onto the corresponding deployment-level
|
|
1532
|
-
resource. Listing ``state`` in ``update_mask`` with no value clears it, which removes the
|
|
1533
|
-
a delete
|
|
1534
|
+
resource. Listing ``state`` in ``update_mask`` with no value clears it, which removes the tracked
|
|
1535
|
+
resource, so a delete or unbind that succeeds must clear ``state``. The parent version must be in
|
|
1534
1536
|
progress, and after the update is applied a succeeded operation cannot carry an ``error_message``. See
|
|
1535
1537
|
the ``state`` and ``resource_id`` fields for the rest.
|
|
1536
1538
|
|
|
@@ -7531,9 +7531,10 @@ class ModelProviderServiceConfig:
|
|
|
7531
7531
|
cross the trust boundary to the upstream provider."""
|
|
7532
7532
|
|
|
7533
7533
|
allow_all_targets: Optional[bool] = None
|
|
7534
|
-
"""When true,
|
|
7535
|
-
|
|
7536
|
-
|
|
7534
|
+
"""When true, allows models from the provider's built-in model catalog in addition to explicit
|
|
7535
|
+
``targets``. When false, only models listed in ``targets`` are routable. Defaults to false.
|
|
7536
|
+
CUSTOM providers have no built-in model catalog and must leave this false and list their models
|
|
7537
|
+
in ``targets``."""
|
|
7537
7538
|
|
|
7538
7539
|
amazon_bedrock: Optional[ModelProviderServiceConfigAmazonBedrockProviderConfig] = None
|
|
7539
7540
|
|
|
@@ -7588,8 +7589,9 @@ class ModelProviderServiceConfig:
|
|
|
7588
7589
|
"""Models and provider-native API types exposed by this provider service. Each entry must include
|
|
7589
7590
|
at least one ``native_api_types`` value. When ``allow_all_targets`` is false, at least one entry
|
|
7590
7591
|
is required and model service destinations can reference only listed models. When
|
|
7591
|
-
``allow_all_targets`` is true,
|
|
7592
|
-
|
|
7592
|
+
``allow_all_targets`` is true, models from the provider's built-in model catalog are also
|
|
7593
|
+
routable. CUSTOM providers must explicitly list their models here and cannot enable
|
|
7594
|
+
``allow_all_targets``."""
|
|
7593
7595
|
|
|
7594
7596
|
def as_dict(self) -> dict:
|
|
7595
7597
|
"""Serializes the ModelProviderServiceConfig into a dictionary suitable for use as a JSON request body."""
|
|
@@ -8051,7 +8053,7 @@ class ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth:
|
|
|
8051
8053
|
|
|
8052
8054
|
@dataclass
|
|
8053
8055
|
class ModelProviderServiceConfigCustomProviderConfig:
|
|
8054
|
-
"""Custom OpenAI-compatible provider configuration
|
|
8056
|
+
"""Custom OpenAI-compatible provider configuration."""
|
|
8055
8057
|
|
|
8056
8058
|
direct: Optional[ModelProviderServiceConfigCustomProviderDirectConfig] = None
|
|
8057
8059
|
"""Endpoint and authentication configuration for the custom provider."""
|
|
@@ -14464,8 +14466,16 @@ class AiGatewayAPI:
|
|
|
14464
14466
|
|
|
14465
14467
|
def create_skill(self, skill: Skill, parent: str, skill_id: str) -> Skill:
|
|
14466
14468
|
"""Creates a skill in a Unity Catalog schema and provisions its managed bundle storage. Specify its name
|
|
14467
|
-
in ``skill_id``. The request contains an optional comment but no bundle bytes.
|
|
14468
|
-
|
|
14469
|
+
in ``skill_id``. The request contains an optional comment but no bundle bytes.
|
|
14470
|
+
|
|
14471
|
+
To publish a skill:
|
|
14472
|
+
|
|
14473
|
+
1. Call CreateSkill to create the skill in Unity Catalog.
|
|
14474
|
+
2. Upload every bundle file, including ``SKILL.md`` at the bundle root, with the Files API: ``PUT
|
|
14475
|
+
/api/2.0/fs/files/Skills/{catalog}/{schema}/{skill}/{file_path}``. The CreateSkill caller owns the
|
|
14476
|
+
skill and can upload. Other callers need ``READ_VOLUME`` and ``WRITE_VOLUME`` on the skill.
|
|
14477
|
+
3. Call FinalizeSkill to validate ``SKILL.md`` and set the skill's ``bundle_name`` and ``description``
|
|
14478
|
+
from its frontmatter ``name`` and ``description``.
|
|
14469
14479
|
|
|
14470
14480
|
You must be the owner of the parent schema or have ``CREATE_VOLUME`` and ``USE_SCHEMA`` on it, plus
|
|
14471
14481
|
``USE_CATALOG`` on the parent catalog.
|
|
@@ -14651,12 +14661,13 @@ class AiGatewayAPI:
|
|
|
14651
14661
|
self._api.do("DELETE", f"/api/2.1/unity-catalog/{name}", query=query, headers=headers)
|
|
14652
14662
|
|
|
14653
14663
|
def finalize_skill(self, name: str) -> Skill:
|
|
14654
|
-
"""Finalizes a skill after its bundle
|
|
14655
|
-
|
|
14656
|
-
|
|
14657
|
-
``
|
|
14658
|
-
|
|
14659
|
-
|
|
14664
|
+
"""Finalizes a skill after its bundle files are uploaded or changed through the Files API. Call it again
|
|
14665
|
+
after every bundle change. This method reads SKILL.md through the Files API using the caller's
|
|
14666
|
+
authorization. Its YAML frontmatter must contain an agentskills.io-compliant ``name`` and a nonblank
|
|
14667
|
+
``description`` within the configured UTF-8 byte limit. On success, it replaces ``bundle_name`` and
|
|
14668
|
+
``description``; refreshes ``finalize_time``, ``update_time``, and ``updated_by``; and returns the
|
|
14669
|
+
updated skill. ``comment`` is preserved. Re-finalization uses the latest SKILL.md and is
|
|
14670
|
+
last-write-wins without an etag precondition. Validation failures do not change metadata.
|
|
14660
14671
|
|
|
14661
14672
|
You must be the owner of the skill or have ``READ_VOLUME`` on it, plus ``USE_CATALOG`` on the parent
|
|
14662
14673
|
catalog and ``USE_SCHEMA`` on the parent schema.
|
|
@@ -14819,7 +14830,7 @@ class AiGatewayAPI:
|
|
|
14819
14830
|
returned.
|
|
14820
14831
|
|
|
14821
14832
|
:param page_size: int (optional)
|
|
14822
|
-
Maximum number of MCP services to return. Defaults to
|
|
14833
|
+
Maximum number of MCP services to return. Defaults to 200 when unset or 0; the maximum is 200. Use
|
|
14823
14834
|
``page_token`` to retrieve additional pages.
|
|
14824
14835
|
:param page_token: str (optional)
|
|
14825
14836
|
Opaque pagination token from the previous response.
|
|
@@ -14877,7 +14888,7 @@ class AiGatewayAPI:
|
|
|
14877
14888
|
``MANAGE``) are returned.
|
|
14878
14889
|
|
|
14879
14890
|
:param page_size: int (optional)
|
|
14880
|
-
Maximum number of provider services to return. Defaults to
|
|
14891
|
+
Maximum number of provider services to return. Defaults to 200 when unset or 0; the maximum is 200.
|
|
14881
14892
|
Use ``page_token`` to retrieve additional pages.
|
|
14882
14893
|
:param page_token: str (optional)
|
|
14883
14894
|
Opaque pagination token from the previous response.
|
|
@@ -14932,10 +14943,10 @@ class AiGatewayAPI:
|
|
|
14932
14943
|
|
|
14933
14944
|
Requires ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA`` on the parent schema. Only model
|
|
14934
14945
|
services the caller can access (as owner or through ``EXECUTE``, ``READ_METADATA``, or ``MANAGE``) are
|
|
14935
|
-
returned.
|
|
14946
|
+
returned by default.
|
|
14936
14947
|
|
|
14937
14948
|
:param page_size: int (optional)
|
|
14938
|
-
Maximum number of model services to return. Defaults to
|
|
14949
|
+
Maximum number of model services to return. Defaults to 200 when unset or 0; the maximum is 200. Use
|
|
14939
14950
|
``page_token`` to retrieve additional pages.
|
|
14940
14951
|
:param page_token: str (optional)
|
|
14941
14952
|
Opaque pagination token from the previous response.
|
|
@@ -14993,7 +15004,7 @@ class AiGatewayAPI:
|
|
|
14993
15004
|
Required: skill listing is schema-scoped, so ``parent`` must be set; an unset or empty ``parent`` is
|
|
14994
15005
|
rejected with INVALID_PARAMETER_VALUE.
|
|
14995
15006
|
:param page_size: int (optional)
|
|
14996
|
-
Maximum number of skills to return. Defaults to
|
|
15007
|
+
Maximum number of skills to return. Defaults to 200 when unset or 0; the maximum is 200. Use
|
|
14997
15008
|
``page_token`` to retrieve additional pages.
|
|
14998
15009
|
:param page_token: str (optional)
|
|
14999
15010
|
Opaque pagination token from a previous request.
|
|
@@ -15201,8 +15212,13 @@ class AiGatewayAPI:
|
|
|
15201
15212
|
conditional on the skill not having changed since it was read. Bundle files, grants, tags, and
|
|
15202
15213
|
ownership are unchanged.
|
|
15203
15214
|
|
|
15204
|
-
|
|
15205
|
-
catalog
|
|
15215
|
+
To update the bundle, add, overwrite (``overwrite=true``), or delete files under
|
|
15216
|
+
``/Skills/{catalog}/{schema}/{skill}/`` with the Files API, then call FinalizeSkill. Changing bundle
|
|
15217
|
+
files requires being the owner of the skill or having ``READ_VOLUME`` and ``WRITE_VOLUME`` on it;
|
|
15218
|
+
``MANAGE`` does not grant access to bundle files.
|
|
15219
|
+
|
|
15220
|
+
To call UpdateSkill, you must be the owner of the skill or have ``MANAGE`` on it, plus ``USE_CATALOG``
|
|
15221
|
+
on the parent catalog and ``USE_SCHEMA`` on the parent schema.
|
|
15206
15222
|
|
|
15207
15223
|
:param name: str
|
|
15208
15224
|
Resource name of the skill. Format: ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` component
|