Skip to content

Commit df7b9df

Browse files
Update SDK API to 2e18933cc4bc38f0e42a101d503ed9d674289663 (#1233)
This PR updates the SDK to the latest API changes. NO_CHANGELOG=true Co-authored-by: databricks-ci-ghec-1[bot] <184311507+databricks-ci-ghec-1[bot]@users.noreply.github.com>
1 parent aa2fd80 commit df7b9df

9 files changed

Lines changed: 223 additions & 12 deletions

File tree

.codegen/_openapi_sha

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
071223944153a8b9818864fcb3aac9847547e7b0
1+
2e18933cc4bc38f0e42a101d503ed9d674289663

NEXT_CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,6 @@
1313
### Internal Changes
1414

1515
### API Changes
16+
* Add `generate_download_full_query_result()` and `get_download_full_query_result()` methods for [w.genie](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards/genie.html) workspace-level service.
17+
* Add `active_instances` field for `databricks.sdk.service.apps.ComputeStatus`.
18+
* [Breaking] Change `create_role()` method for [w.postgres](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/postgres/postgres.html) workspace-level service. HTTP method/verb has changed.

databricks/sdk/service/apps.py

Lines changed: 13 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

databricks/sdk/service/dashboards.py

Lines changed: 140 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

databricks/sdk/service/postgres.py

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

databricks/sdk/service/tags.py

100755100644
Lines changed: 6 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/dbdataclasses/dashboards.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,14 @@ These dataclasses are used in the SDK to represent API requests and responses fo
5454
.. py:attribute:: POSITIVE
5555
:value: "POSITIVE"
5656

57+
.. autoclass:: GenieGenerateDownloadFullQueryResultResponse
58+
:members:
59+
:undoc-members:
60+
61+
.. autoclass:: GenieGetDownloadFullQueryResultResponse
62+
:members:
63+
:undoc-members:
64+
5765
.. autoclass:: GenieGetMessageQueryResultResponse
5866
:members:
5967
:undoc-members:

docs/workspace/dashboards/genie.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,53 @@
108108
:returns: :class:`GenieGetMessageQueryResultResponse`
109109

110110

111+
.. py:method:: generate_download_full_query_result(space_id: str, conversation_id: str, message_id: str, attachment_id: str) -> GenieGenerateDownloadFullQueryResultResponse
112+
113+
Initiates a new SQL execution and returns a `download_id` that you can use to track the progress of
114+
the download. The query result is stored in an external link and can be retrieved using the [Get
115+
Download Full Query Result](:method:genie/getdownloadfullqueryresult) API. Warning: Databricks
116+
strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.
117+
See [Execute Statement](:method:statementexecution/executestatement) for more details.
118+
119+
:param space_id: str
120+
Genie space ID
121+
:param conversation_id: str
122+
Conversation ID
123+
:param message_id: str
124+
Message ID
125+
:param attachment_id: str
126+
Attachment ID
127+
128+
:returns: :class:`GenieGenerateDownloadFullQueryResultResponse`
129+
130+
131+
.. py:method:: get_download_full_query_result(space_id: str, conversation_id: str, message_id: str, attachment_id: str, download_id: str [, download_id_signature: Optional[str]]) -> GenieGetDownloadFullQueryResultResponse
132+
133+
After [Generating a Full Query Result Download](:method:genie/getdownloadfullqueryresult) and
134+
successfully receiving a `download_id`, use this API to poll the download progress. When the download
135+
is complete, the API returns one or more external links to the query result files. Warning: Databricks
136+
strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.
137+
You must not set an Authorization header in download requests. When using the `EXTERNAL_LINKS`
138+
disposition, Databricks returns presigned URLs that grant temporary access to data. See [Execute
139+
Statement](:method:statementexecution/executestatement) for more details.
140+
141+
:param space_id: str
142+
Genie space ID
143+
:param conversation_id: str
144+
Conversation ID
145+
:param message_id: str
146+
Message ID
147+
:param attachment_id: str
148+
Attachment ID
149+
:param download_id: str
150+
Download ID. This ID is provided by the [Generate Download
151+
endpoint](:method:genie/generateDownloadFullQueryResult)
152+
:param download_id_signature: str (optional)
153+
JWT signature for the download_id to ensure secure access to query results
154+
155+
:returns: :class:`GenieGetDownloadFullQueryResultResponse`
156+
157+
111158
.. py:method:: get_message(space_id: str, conversation_id: str, message_id: str) -> GenieMessage
112159
113160
Get message from conversation.

docs/workspace/tags/workspace_entity_tag_assignments.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
Delete a tag assignment
2121

2222
:param entity_type: str
23-
The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
23+
The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces
2424
:param entity_id: str
2525
The identifier of the entity to which the tag is assigned
2626
:param tag_key: str
@@ -34,7 +34,7 @@
3434
Get a tag assignment
3535

3636
:param entity_type: str
37-
The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
37+
The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces
3838
:param entity_id: str
3939
The identifier of the entity to which the tag is assigned
4040
:param tag_key: str
@@ -48,7 +48,7 @@
4848
List the tag assignments for an entity
4949

5050
:param entity_type: str
51-
The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
51+
The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces
5252
:param entity_id: str
5353
The identifier of the entity to which the tag is assigned
5454
:param page_size: int (optional)
@@ -64,7 +64,7 @@
6464
Update a tag assignment
6565

6666
:param entity_type: str
67-
The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
67+
The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces
6868
:param entity_id: str
6969
The identifier of the entity to which the tag is assigned
7070
:param tag_key: str

0 commit comments

Comments
 (0)