Skip to content

Commit 0db51aa

Browse files
robot-ci-heartexfern-api[bot]Jo Booth
authored
feat: BROS-450: Add Databricks SDK (#612)
Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Jo Booth <jo@humansignal.com>
1 parent d600d98 commit 0db51aa

21 files changed

Lines changed: 8140 additions & 1932 deletions

File tree

‎.mock/definition/exportStorage/databricks.yml‎

Lines changed: 363 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,363 @@
1+
imports:
2+
root: ../__package__.yml
3+
service:
4+
auth: false
5+
base-path: ''
6+
endpoints:
7+
list:
8+
path: /api/storages/export/databricks
9+
method: GET
10+
auth: true
11+
docs: Get a list of all Databricks Files export storage connections.
12+
source:
13+
openapi: openapi/openapi.yaml
14+
display-name: List Databricks export storages
15+
request:
16+
name: DatabricksListRequest
17+
query-parameters:
18+
ordering:
19+
type: optional<string>
20+
docs: Which field to use when ordering the results.
21+
project:
22+
type: optional<integer>
23+
docs: Project ID
24+
response:
25+
docs: ''
26+
type: list<root.DatabricksExportStorage>
27+
examples:
28+
- response:
29+
body:
30+
- can_delete_objects: true
31+
catalog: catalog
32+
created_at: '2024-01-15T09:30:00Z'
33+
description: description
34+
host: host
35+
id: 1
36+
last_sync: '2024-01-15T09:30:00Z'
37+
last_sync_count: 1
38+
last_sync_job: last_sync_job
39+
meta:
40+
key: value
41+
prefix: prefix
42+
project: 1
43+
regex_filter: regex_filter
44+
request_timeout_s: 1
45+
schema: schema
46+
status: initialized
47+
stream_chunk_bytes: 1
48+
synchronizable: true
49+
title: title
50+
traceback: traceback
51+
type: type
52+
use_blob_urls: true
53+
verify_tls: true
54+
volume: volume
55+
audiences:
56+
- public
57+
create:
58+
path: /api/storages/export/databricks
59+
method: POST
60+
auth: true
61+
docs: Create a Databricks Files export storage connection.
62+
source:
63+
openapi: openapi/openapi.yaml
64+
display-name: Create Databricks export storage
65+
request:
66+
body: root.DatabricksExportStorageRequest
67+
content-type: application/json
68+
response:
69+
docs: ''
70+
type: root.DatabricksExportStorage
71+
examples:
72+
- request:
73+
catalog: catalog
74+
host: host
75+
project: 1
76+
schema: schema
77+
volume: volume
78+
response:
79+
body:
80+
can_delete_objects: true
81+
catalog: catalog
82+
created_at: '2024-01-15T09:30:00Z'
83+
description: description
84+
host: host
85+
id: 1
86+
last_sync: '2024-01-15T09:30:00Z'
87+
last_sync_count: 1
88+
last_sync_job: last_sync_job
89+
meta:
90+
key: value
91+
prefix: prefix
92+
project: 1
93+
regex_filter: regex_filter
94+
request_timeout_s: 1
95+
schema: schema
96+
status: initialized
97+
stream_chunk_bytes: 1
98+
synchronizable: true
99+
title: title
100+
traceback: traceback
101+
type: type
102+
use_blob_urls: true
103+
verify_tls: true
104+
volume: volume
105+
audiences:
106+
- public
107+
validate:
108+
path: /api/storages/export/databricks/validate
109+
method: POST
110+
auth: true
111+
docs: Validate a specific Databricks Files export storage connection.
112+
source:
113+
openapi: openapi/openapi.yaml
114+
display-name: Validate Databricks export storage
115+
request:
116+
body: root.DatabricksExportStorageRequest
117+
content-type: application/json
118+
examples:
119+
- request:
120+
catalog: catalog
121+
host: host
122+
project: 1
123+
schema: schema
124+
volume: volume
125+
audiences:
126+
- public
127+
get:
128+
path: /api/storages/export/databricks/{id}
129+
method: GET
130+
auth: true
131+
docs: Get a specific Databricks Files export storage connection.
132+
source:
133+
openapi: openapi/openapi.yaml
134+
path-parameters:
135+
id: integer
136+
display-name: Get Databricks export storage
137+
response:
138+
docs: ''
139+
type: root.DatabricksExportStorage
140+
examples:
141+
- path-parameters:
142+
id: 1
143+
response:
144+
body:
145+
can_delete_objects: true
146+
catalog: catalog
147+
created_at: '2024-01-15T09:30:00Z'
148+
description: description
149+
host: host
150+
id: 1
151+
last_sync: '2024-01-15T09:30:00Z'
152+
last_sync_count: 1
153+
last_sync_job: last_sync_job
154+
meta:
155+
key: value
156+
prefix: prefix
157+
project: 1
158+
regex_filter: regex_filter
159+
request_timeout_s: 1
160+
schema: schema
161+
status: initialized
162+
stream_chunk_bytes: 1
163+
synchronizable: true
164+
title: title
165+
traceback: traceback
166+
type: type
167+
use_blob_urls: true
168+
verify_tls: true
169+
volume: volume
170+
audiences:
171+
- public
172+
delete:
173+
path: /api/storages/export/databricks/{id}
174+
method: DELETE
175+
auth: true
176+
docs: Delete a specific Databricks Files export storage connection.
177+
source:
178+
openapi: openapi/openapi.yaml
179+
path-parameters:
180+
id: integer
181+
display-name: Delete Databricks export storage
182+
examples:
183+
- path-parameters:
184+
id: 1
185+
audiences:
186+
- public
187+
update:
188+
path: /api/storages/export/databricks/{id}
189+
method: PATCH
190+
auth: true
191+
docs: Update a specific Databricks Files export storage connection.
192+
source:
193+
openapi: openapi/openapi.yaml
194+
path-parameters:
195+
id: integer
196+
display-name: Update Databricks export storage
197+
request:
198+
name: PatchedDatabricksExportStorageRequest
199+
body:
200+
properties:
201+
can_delete_objects:
202+
type: optional<boolean>
203+
docs: Deletion from storage enabled
204+
catalog:
205+
type: optional<string>
206+
docs: UC catalog name
207+
validation:
208+
minLength: 1
209+
description:
210+
type: optional<string>
211+
docs: Cloud storage description
212+
host:
213+
type: optional<string>
214+
docs: Databricks workspace base URL (https://...)
215+
validation:
216+
minLength: 1
217+
last_sync:
218+
type: optional<datetime>
219+
docs: Last sync finished time
220+
last_sync_count:
221+
type: optional<integer>
222+
docs: Count of tasks synced last time
223+
validation:
224+
min: 0
225+
max: 2147483647
226+
last_sync_job:
227+
type: optional<string>
228+
docs: Last sync job ID
229+
validation:
230+
maxLength: 256
231+
meta: optional<unknown>
232+
prefix:
233+
type: optional<string>
234+
docs: Export path prefix under the volume
235+
project:
236+
type: optional<integer>
237+
docs: A unique integer value identifying this project.
238+
regex_filter:
239+
type: optional<string>
240+
docs: Regex for filtering objects
241+
request_timeout_s:
242+
type: optional<integer>
243+
validation:
244+
min: 0
245+
max: 2147483647
246+
schema:
247+
type: optional<string>
248+
docs: UC schema name
249+
validation:
250+
minLength: 1
251+
status: optional<root.StatusC5AEnum>
252+
stream_chunk_bytes:
253+
type: optional<integer>
254+
validation:
255+
min: 0
256+
max: 2147483647
257+
synchronizable:
258+
type: optional<boolean>
259+
default: true
260+
title:
261+
type: optional<string>
262+
docs: Cloud storage title
263+
validation:
264+
maxLength: 256
265+
token: optional<string>
266+
traceback:
267+
type: optional<string>
268+
docs: Traceback report for the last failed sync
269+
use_blob_urls:
270+
type: optional<boolean>
271+
docs: Generate blob URLs in tasks
272+
verify_tls:
273+
type: optional<boolean>
274+
docs: Verify TLS certificates
275+
volume:
276+
type: optional<string>
277+
docs: UC volume name
278+
validation:
279+
minLength: 1
280+
content-type: application/json
281+
response:
282+
docs: ''
283+
type: root.DatabricksExportStorage
284+
examples:
285+
- path-parameters:
286+
id: 1
287+
request: {}
288+
response:
289+
body:
290+
can_delete_objects: true
291+
catalog: catalog
292+
created_at: '2024-01-15T09:30:00Z'
293+
description: description
294+
host: host
295+
id: 1
296+
last_sync: '2024-01-15T09:30:00Z'
297+
last_sync_count: 1
298+
last_sync_job: last_sync_job
299+
meta:
300+
key: value
301+
prefix: prefix
302+
project: 1
303+
regex_filter: regex_filter
304+
request_timeout_s: 1
305+
schema: schema
306+
status: initialized
307+
stream_chunk_bytes: 1
308+
synchronizable: true
309+
title: title
310+
traceback: traceback
311+
type: type
312+
use_blob_urls: true
313+
verify_tls: true
314+
volume: volume
315+
audiences:
316+
- public
317+
sync:
318+
path: /api/storages/export/databricks/{id}/sync
319+
method: POST
320+
auth: true
321+
docs: Export annotations to a Databricks Files storage.
322+
source:
323+
openapi: openapi/openapi.yaml
324+
path-parameters:
325+
id: integer
326+
display-name: Sync Databricks export storage
327+
response:
328+
docs: ''
329+
type: root.DatabricksExportStorage
330+
examples:
331+
- path-parameters:
332+
id: 1
333+
response:
334+
body:
335+
can_delete_objects: true
336+
catalog: catalog
337+
created_at: '2024-01-15T09:30:00Z'
338+
description: description
339+
host: host
340+
id: 1
341+
last_sync: '2024-01-15T09:30:00Z'
342+
last_sync_count: 1
343+
last_sync_job: last_sync_job
344+
meta:
345+
key: value
346+
prefix: prefix
347+
project: 1
348+
regex_filter: regex_filter
349+
request_timeout_s: 1
350+
schema: schema
351+
status: initialized
352+
stream_chunk_bytes: 1
353+
synchronizable: true
354+
title: title
355+
traceback: traceback
356+
type: type
357+
use_blob_urls: true
358+
verify_tls: true
359+
volume: volume
360+
audiences:
361+
- public
362+
source:
363+
openapi: openapi/openapi.yaml

0 commit comments

Comments
 (0)