# This file was auto-generated by Fern from our API Definition.
import datetime as dt
import typing
from json.decoder import JSONDecodeError
from ...core.api_error import ApiError
from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.http_response import AsyncHttpResponse, HttpResponse
from ...core.jsonable_encoder import jsonable_encoder
from ...core.request_options import RequestOptions
from ...core.unchecked_base_model import construct_type
from ...types.auth_type_enum import AuthTypeEnum
from ...types.databricks_export_storage import DatabricksExportStorage
from ...types.status_c5a_enum import StatusC5AEnum
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class RawDatabricksClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._client_wrapper = client_wrapper
def list(
self,
*,
project: int,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[typing.List[DatabricksExportStorage]]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a list of all Databricks Files export storage connections.
Parameters
----------
project : int
Project ID
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[typing.List[DatabricksExportStorage]]
"""
_response = self._client_wrapper.httpx_client.request(
"api/storages/export/databricks",
method="GET",
params={
"ordering": ordering,
"project": project,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
typing.List[DatabricksExportStorage],
construct_type(
type_=typing.List[DatabricksExportStorage], # type: ignore
object_=_response.json(),
),
)
return HttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
def create(
self,
*,
catalog: str,
host: str,
project: int,
schema: str,
volume: str,
auth_type: typing.Optional[AuthTypeEnum] = OMIT,
can_delete_objects: typing.Optional[bool] = OMIT,
client_id: typing.Optional[str] = OMIT,
client_secret: typing.Optional[str] = OMIT,
description: typing.Optional[str] = OMIT,
last_sync: typing.Optional[dt.datetime] = OMIT,
last_sync_count: typing.Optional[int] = OMIT,
last_sync_job: typing.Optional[str] = OMIT,
meta: typing.Optional[typing.Any] = OMIT,
prefix: typing.Optional[str] = OMIT,
regex_filter: typing.Optional[str] = OMIT,
request_timeout_s: typing.Optional[int] = OMIT,
status: typing.Optional[StatusC5AEnum] = OMIT,
stream_chunk_bytes: typing.Optional[int] = OMIT,
synchronizable: typing.Optional[bool] = OMIT,
tenant_id: typing.Optional[str] = OMIT,
title: typing.Optional[str] = OMIT,
token: typing.Optional[str] = OMIT,
traceback: typing.Optional[str] = OMIT,
use_blob_urls: typing.Optional[bool] = OMIT,
verify_tls: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[DatabricksExportStorage]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a Databricks Files export storage connection.
Parameters
----------
catalog : str
UC catalog name
host : str
Databricks workspace base URL (https://...)
project : int
A unique integer value identifying this project.
schema : str
UC schema name
volume : str
UC volume name
auth_type : typing.Optional[AuthTypeEnum]
Authentication method: PAT, Databricks SP, or Azure AD SP
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
can_delete_objects : typing.Optional[bool]
Deletion from storage enabled
client_id : typing.Optional[str]
Service principal client/application ID (required for SP modes)
client_secret : typing.Optional[str]
Service principal client secret (required for SP modes)
description : typing.Optional[str]
Cloud storage description
last_sync : typing.Optional[dt.datetime]
Last sync finished time
last_sync_count : typing.Optional[int]
Count of tasks synced last time
last_sync_job : typing.Optional[str]
Last sync job ID
meta : typing.Optional[typing.Any]
Meta and debug information about storage processes
prefix : typing.Optional[str]
Export path prefix under the volume
regex_filter : typing.Optional[str]
Regex for filtering objects
request_timeout_s : typing.Optional[int]
status : typing.Optional[StatusC5AEnum]
stream_chunk_bytes : typing.Optional[int]
synchronizable : typing.Optional[bool]
tenant_id : typing.Optional[str]
Azure AD tenant ID (required for Azure AD SP mode)
title : typing.Optional[str]
Cloud storage title
token : typing.Optional[str]
Databricks personal access token (required for PAT mode)
traceback : typing.Optional[str]
Traceback report for the last failed sync
use_blob_urls : typing.Optional[bool]
Generate blob URLs in tasks
verify_tls : typing.Optional[bool]
Verify TLS certificates
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[DatabricksExportStorage]
"""
_response = self._client_wrapper.httpx_client.request(
"api/storages/export/databricks",
method="POST",
json={
"auth_type": auth_type,
"can_delete_objects": can_delete_objects,
"catalog": catalog,
"client_id": client_id,
"client_secret": client_secret,
"description": description,
"host": host,
"last_sync": last_sync,
"last_sync_count": last_sync_count,
"last_sync_job": last_sync_job,
"meta": meta,
"prefix": prefix,
"project": project,
"regex_filter": regex_filter,
"request_timeout_s": request_timeout_s,
"schema": schema,
"status": status,
"stream_chunk_bytes": stream_chunk_bytes,
"synchronizable": synchronizable,
"tenant_id": tenant_id,
"title": title,
"token": token,
"traceback": traceback,
"use_blob_urls": use_blob_urls,
"verify_tls": verify_tls,
"volume": volume,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
DatabricksExportStorage,
construct_type(
type_=DatabricksExportStorage, # type: ignore
object_=_response.json(),
),
)
return HttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
def validate(
self,
*,
catalog: str,
host: str,
project: int,
schema: str,
volume: str,
auth_type: typing.Optional[AuthTypeEnum] = OMIT,
can_delete_objects: typing.Optional[bool] = OMIT,
client_id: typing.Optional[str] = OMIT,
client_secret: typing.Optional[str] = OMIT,
description: typing.Optional[str] = OMIT,
last_sync: typing.Optional[dt.datetime] = OMIT,
last_sync_count: typing.Optional[int] = OMIT,
last_sync_job: typing.Optional[str] = OMIT,
meta: typing.Optional[typing.Any] = OMIT,
prefix: typing.Optional[str] = OMIT,
regex_filter: typing.Optional[str] = OMIT,
request_timeout_s: typing.Optional[int] = OMIT,
status: typing.Optional[StatusC5AEnum] = OMIT,
stream_chunk_bytes: typing.Optional[int] = OMIT,
synchronizable: typing.Optional[bool] = OMIT,
tenant_id: typing.Optional[str] = OMIT,
title: typing.Optional[str] = OMIT,
token: typing.Optional[str] = OMIT,
traceback: typing.Optional[str] = OMIT,
use_blob_urls: typing.Optional[bool] = OMIT,
verify_tls: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[None]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a specific Databricks Files export storage connection.
Parameters
----------
catalog : str
UC catalog name
host : str
Databricks workspace base URL (https://...)
project : int
A unique integer value identifying this project.
schema : str
UC schema name
volume : str
UC volume name
auth_type : typing.Optional[AuthTypeEnum]
Authentication method: PAT, Databricks SP, or Azure AD SP
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
can_delete_objects : typing.Optional[bool]
Deletion from storage enabled
client_id : typing.Optional[str]
Service principal client/application ID (required for SP modes)
client_secret : typing.Optional[str]
Service principal client secret (required for SP modes)
description : typing.Optional[str]
Cloud storage description
last_sync : typing.Optional[dt.datetime]
Last sync finished time
last_sync_count : typing.Optional[int]
Count of tasks synced last time
last_sync_job : typing.Optional[str]
Last sync job ID
meta : typing.Optional[typing.Any]
Meta and debug information about storage processes
prefix : typing.Optional[str]
Export path prefix under the volume
regex_filter : typing.Optional[str]
Regex for filtering objects
request_timeout_s : typing.Optional[int]
status : typing.Optional[StatusC5AEnum]
stream_chunk_bytes : typing.Optional[int]
synchronizable : typing.Optional[bool]
tenant_id : typing.Optional[str]
Azure AD tenant ID (required for Azure AD SP mode)
title : typing.Optional[str]
Cloud storage title
token : typing.Optional[str]
Databricks personal access token (required for PAT mode)
traceback : typing.Optional[str]
Traceback report for the last failed sync
use_blob_urls : typing.Optional[bool]
Generate blob URLs in tasks
verify_tls : typing.Optional[bool]
Verify TLS certificates
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[None]
"""
_response = self._client_wrapper.httpx_client.request(
"api/storages/export/databricks/validate",
method="POST",
json={
"auth_type": auth_type,
"can_delete_objects": can_delete_objects,
"catalog": catalog,
"client_id": client_id,
"client_secret": client_secret,
"description": description,
"host": host,
"last_sync": last_sync,
"last_sync_count": last_sync_count,
"last_sync_job": last_sync_job,
"meta": meta,
"prefix": prefix,
"project": project,
"regex_filter": regex_filter,
"request_timeout_s": request_timeout_s,
"schema": schema,
"status": status,
"stream_chunk_bytes": stream_chunk_bytes,
"synchronizable": synchronizable,
"tenant_id": tenant_id,
"title": title,
"token": token,
"traceback": traceback,
"use_blob_urls": use_blob_urls,
"verify_tls": verify_tls,
"volume": volume,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return HttpResponse(response=_response, data=None)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
def get(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[DatabricksExportStorage]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a specific Databricks Files export storage connection.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[DatabricksExportStorage]
"""
_response = self._client_wrapper.httpx_client.request(
f"api/storages/export/databricks/{jsonable_encoder(id)}",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
DatabricksExportStorage,
construct_type(
type_=DatabricksExportStorage, # type: ignore
object_=_response.json(),
),
)
return HttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[None]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific Databricks Files export storage connection.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[None]
"""
_response = self._client_wrapper.httpx_client.request(
f"api/storages/export/databricks/{jsonable_encoder(id)}",
method="DELETE",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return HttpResponse(response=_response, data=None)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
def update(
self,
id: int,
*,
auth_type: typing.Optional[AuthTypeEnum] = OMIT,
can_delete_objects: typing.Optional[bool] = OMIT,
catalog: typing.Optional[str] = OMIT,
client_id: typing.Optional[str] = OMIT,
client_secret: typing.Optional[str] = OMIT,
description: typing.Optional[str] = OMIT,
host: typing.Optional[str] = OMIT,
last_sync: typing.Optional[dt.datetime] = OMIT,
last_sync_count: typing.Optional[int] = OMIT,
last_sync_job: typing.Optional[str] = OMIT,
meta: typing.Optional[typing.Any] = OMIT,
prefix: typing.Optional[str] = OMIT,
project: typing.Optional[int] = OMIT,
regex_filter: typing.Optional[str] = OMIT,
request_timeout_s: typing.Optional[int] = OMIT,
schema: typing.Optional[str] = OMIT,
status: typing.Optional[StatusC5AEnum] = OMIT,
stream_chunk_bytes: typing.Optional[int] = OMIT,
synchronizable: typing.Optional[bool] = OMIT,
tenant_id: typing.Optional[str] = OMIT,
title: typing.Optional[str] = OMIT,
token: typing.Optional[str] = OMIT,
traceback: typing.Optional[str] = OMIT,
use_blob_urls: typing.Optional[bool] = OMIT,
verify_tls: typing.Optional[bool] = OMIT,
volume: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[DatabricksExportStorage]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific Databricks Files export storage connection.
Parameters
----------
id : int
auth_type : typing.Optional[AuthTypeEnum]
Authentication method: PAT, Databricks SP, or Azure AD SP
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
can_delete_objects : typing.Optional[bool]
Deletion from storage enabled
catalog : typing.Optional[str]
UC catalog name
client_id : typing.Optional[str]
Service principal client/application ID (required for SP modes)
client_secret : typing.Optional[str]
Service principal client secret (required for SP modes)
description : typing.Optional[str]
Cloud storage description
host : typing.Optional[str]
Databricks workspace base URL (https://...)
last_sync : typing.Optional[dt.datetime]
Last sync finished time
last_sync_count : typing.Optional[int]
Count of tasks synced last time
last_sync_job : typing.Optional[str]
Last sync job ID
meta : typing.Optional[typing.Any]
Meta and debug information about storage processes
prefix : typing.Optional[str]
Export path prefix under the volume
project : typing.Optional[int]
A unique integer value identifying this project.
regex_filter : typing.Optional[str]
Regex for filtering objects
request_timeout_s : typing.Optional[int]
schema : typing.Optional[str]
UC schema name
status : typing.Optional[StatusC5AEnum]
stream_chunk_bytes : typing.Optional[int]
synchronizable : typing.Optional[bool]
tenant_id : typing.Optional[str]
Azure AD tenant ID (required for Azure AD SP mode)
title : typing.Optional[str]
Cloud storage title
token : typing.Optional[str]
Databricks personal access token (required for PAT mode)
traceback : typing.Optional[str]
Traceback report for the last failed sync
use_blob_urls : typing.Optional[bool]
Generate blob URLs in tasks
verify_tls : typing.Optional[bool]
Verify TLS certificates
volume : typing.Optional[str]
UC volume name
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[DatabricksExportStorage]
"""
_response = self._client_wrapper.httpx_client.request(
f"api/storages/export/databricks/{jsonable_encoder(id)}",
method="PATCH",
json={
"auth_type": auth_type,
"can_delete_objects": can_delete_objects,
"catalog": catalog,
"client_id": client_id,
"client_secret": client_secret,
"description": description,
"host": host,
"last_sync": last_sync,
"last_sync_count": last_sync_count,
"last_sync_job": last_sync_job,
"meta": meta,
"prefix": prefix,
"project": project,
"regex_filter": regex_filter,
"request_timeout_s": request_timeout_s,
"schema": schema,
"status": status,
"stream_chunk_bytes": stream_chunk_bytes,
"synchronizable": synchronizable,
"tenant_id": tenant_id,
"title": title,
"token": token,
"traceback": traceback,
"use_blob_urls": use_blob_urls,
"verify_tls": verify_tls,
"volume": volume,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
DatabricksExportStorage,
construct_type(
type_=DatabricksExportStorage, # type: ignore
object_=_response.json(),
),
)
return HttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
def sync(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[DatabricksExportStorage]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Export annotations to a Databricks Files storage.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[DatabricksExportStorage]
"""
_response = self._client_wrapper.httpx_client.request(
f"api/storages/export/databricks/{jsonable_encoder(id)}/sync",
method="POST",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
DatabricksExportStorage,
construct_type(
type_=DatabricksExportStorage, # type: ignore
object_=_response.json(),
),
)
return HttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
class AsyncRawDatabricksClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._client_wrapper = client_wrapper
async def list(
self,
*,
project: int,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[typing.List[DatabricksExportStorage]]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a list of all Databricks Files export storage connections.
Parameters
----------
project : int
Project ID
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[typing.List[DatabricksExportStorage]]
"""
_response = await self._client_wrapper.httpx_client.request(
"api/storages/export/databricks",
method="GET",
params={
"ordering": ordering,
"project": project,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
typing.List[DatabricksExportStorage],
construct_type(
type_=typing.List[DatabricksExportStorage], # type: ignore
object_=_response.json(),
),
)
return AsyncHttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
async def create(
self,
*,
catalog: str,
host: str,
project: int,
schema: str,
volume: str,
auth_type: typing.Optional[AuthTypeEnum] = OMIT,
can_delete_objects: typing.Optional[bool] = OMIT,
client_id: typing.Optional[str] = OMIT,
client_secret: typing.Optional[str] = OMIT,
description: typing.Optional[str] = OMIT,
last_sync: typing.Optional[dt.datetime] = OMIT,
last_sync_count: typing.Optional[int] = OMIT,
last_sync_job: typing.Optional[str] = OMIT,
meta: typing.Optional[typing.Any] = OMIT,
prefix: typing.Optional[str] = OMIT,
regex_filter: typing.Optional[str] = OMIT,
request_timeout_s: typing.Optional[int] = OMIT,
status: typing.Optional[StatusC5AEnum] = OMIT,
stream_chunk_bytes: typing.Optional[int] = OMIT,
synchronizable: typing.Optional[bool] = OMIT,
tenant_id: typing.Optional[str] = OMIT,
title: typing.Optional[str] = OMIT,
token: typing.Optional[str] = OMIT,
traceback: typing.Optional[str] = OMIT,
use_blob_urls: typing.Optional[bool] = OMIT,
verify_tls: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[DatabricksExportStorage]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a Databricks Files export storage connection.
Parameters
----------
catalog : str
UC catalog name
host : str
Databricks workspace base URL (https://...)
project : int
A unique integer value identifying this project.
schema : str
UC schema name
volume : str
UC volume name
auth_type : typing.Optional[AuthTypeEnum]
Authentication method: PAT, Databricks SP, or Azure AD SP
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
can_delete_objects : typing.Optional[bool]
Deletion from storage enabled
client_id : typing.Optional[str]
Service principal client/application ID (required for SP modes)
client_secret : typing.Optional[str]
Service principal client secret (required for SP modes)
description : typing.Optional[str]
Cloud storage description
last_sync : typing.Optional[dt.datetime]
Last sync finished time
last_sync_count : typing.Optional[int]
Count of tasks synced last time
last_sync_job : typing.Optional[str]
Last sync job ID
meta : typing.Optional[typing.Any]
Meta and debug information about storage processes
prefix : typing.Optional[str]
Export path prefix under the volume
regex_filter : typing.Optional[str]
Regex for filtering objects
request_timeout_s : typing.Optional[int]
status : typing.Optional[StatusC5AEnum]
stream_chunk_bytes : typing.Optional[int]
synchronizable : typing.Optional[bool]
tenant_id : typing.Optional[str]
Azure AD tenant ID (required for Azure AD SP mode)
title : typing.Optional[str]
Cloud storage title
token : typing.Optional[str]
Databricks personal access token (required for PAT mode)
traceback : typing.Optional[str]
Traceback report for the last failed sync
use_blob_urls : typing.Optional[bool]
Generate blob URLs in tasks
verify_tls : typing.Optional[bool]
Verify TLS certificates
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[DatabricksExportStorage]
"""
_response = await self._client_wrapper.httpx_client.request(
"api/storages/export/databricks",
method="POST",
json={
"auth_type": auth_type,
"can_delete_objects": can_delete_objects,
"catalog": catalog,
"client_id": client_id,
"client_secret": client_secret,
"description": description,
"host": host,
"last_sync": last_sync,
"last_sync_count": last_sync_count,
"last_sync_job": last_sync_job,
"meta": meta,
"prefix": prefix,
"project": project,
"regex_filter": regex_filter,
"request_timeout_s": request_timeout_s,
"schema": schema,
"status": status,
"stream_chunk_bytes": stream_chunk_bytes,
"synchronizable": synchronizable,
"tenant_id": tenant_id,
"title": title,
"token": token,
"traceback": traceback,
"use_blob_urls": use_blob_urls,
"verify_tls": verify_tls,
"volume": volume,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
DatabricksExportStorage,
construct_type(
type_=DatabricksExportStorage, # type: ignore
object_=_response.json(),
),
)
return AsyncHttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
async def validate(
self,
*,
catalog: str,
host: str,
project: int,
schema: str,
volume: str,
auth_type: typing.Optional[AuthTypeEnum] = OMIT,
can_delete_objects: typing.Optional[bool] = OMIT,
client_id: typing.Optional[str] = OMIT,
client_secret: typing.Optional[str] = OMIT,
description: typing.Optional[str] = OMIT,
last_sync: typing.Optional[dt.datetime] = OMIT,
last_sync_count: typing.Optional[int] = OMIT,
last_sync_job: typing.Optional[str] = OMIT,
meta: typing.Optional[typing.Any] = OMIT,
prefix: typing.Optional[str] = OMIT,
regex_filter: typing.Optional[str] = OMIT,
request_timeout_s: typing.Optional[int] = OMIT,
status: typing.Optional[StatusC5AEnum] = OMIT,
stream_chunk_bytes: typing.Optional[int] = OMIT,
synchronizable: typing.Optional[bool] = OMIT,
tenant_id: typing.Optional[str] = OMIT,
title: typing.Optional[str] = OMIT,
token: typing.Optional[str] = OMIT,
traceback: typing.Optional[str] = OMIT,
use_blob_urls: typing.Optional[bool] = OMIT,
verify_tls: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[None]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a specific Databricks Files export storage connection.
Parameters
----------
catalog : str
UC catalog name
host : str
Databricks workspace base URL (https://...)
project : int
A unique integer value identifying this project.
schema : str
UC schema name
volume : str
UC volume name
auth_type : typing.Optional[AuthTypeEnum]
Authentication method: PAT, Databricks SP, or Azure AD SP
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
can_delete_objects : typing.Optional[bool]
Deletion from storage enabled
client_id : typing.Optional[str]
Service principal client/application ID (required for SP modes)
client_secret : typing.Optional[str]
Service principal client secret (required for SP modes)
description : typing.Optional[str]
Cloud storage description
last_sync : typing.Optional[dt.datetime]
Last sync finished time
last_sync_count : typing.Optional[int]
Count of tasks synced last time
last_sync_job : typing.Optional[str]
Last sync job ID
meta : typing.Optional[typing.Any]
Meta and debug information about storage processes
prefix : typing.Optional[str]
Export path prefix under the volume
regex_filter : typing.Optional[str]
Regex for filtering objects
request_timeout_s : typing.Optional[int]
status : typing.Optional[StatusC5AEnum]
stream_chunk_bytes : typing.Optional[int]
synchronizable : typing.Optional[bool]
tenant_id : typing.Optional[str]
Azure AD tenant ID (required for Azure AD SP mode)
title : typing.Optional[str]
Cloud storage title
token : typing.Optional[str]
Databricks personal access token (required for PAT mode)
traceback : typing.Optional[str]
Traceback report for the last failed sync
use_blob_urls : typing.Optional[bool]
Generate blob URLs in tasks
verify_tls : typing.Optional[bool]
Verify TLS certificates
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[None]
"""
_response = await self._client_wrapper.httpx_client.request(
"api/storages/export/databricks/validate",
method="POST",
json={
"auth_type": auth_type,
"can_delete_objects": can_delete_objects,
"catalog": catalog,
"client_id": client_id,
"client_secret": client_secret,
"description": description,
"host": host,
"last_sync": last_sync,
"last_sync_count": last_sync_count,
"last_sync_job": last_sync_job,
"meta": meta,
"prefix": prefix,
"project": project,
"regex_filter": regex_filter,
"request_timeout_s": request_timeout_s,
"schema": schema,
"status": status,
"stream_chunk_bytes": stream_chunk_bytes,
"synchronizable": synchronizable,
"tenant_id": tenant_id,
"title": title,
"token": token,
"traceback": traceback,
"use_blob_urls": use_blob_urls,
"verify_tls": verify_tls,
"volume": volume,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return AsyncHttpResponse(response=_response, data=None)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
async def get(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[DatabricksExportStorage]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a specific Databricks Files export storage connection.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[DatabricksExportStorage]
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/storages/export/databricks/{jsonable_encoder(id)}",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
DatabricksExportStorage,
construct_type(
type_=DatabricksExportStorage, # type: ignore
object_=_response.json(),
),
)
return AsyncHttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
async def delete(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[None]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific Databricks Files export storage connection.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[None]
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/storages/export/databricks/{jsonable_encoder(id)}",
method="DELETE",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return AsyncHttpResponse(response=_response, data=None)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
async def update(
self,
id: int,
*,
auth_type: typing.Optional[AuthTypeEnum] = OMIT,
can_delete_objects: typing.Optional[bool] = OMIT,
catalog: typing.Optional[str] = OMIT,
client_id: typing.Optional[str] = OMIT,
client_secret: typing.Optional[str] = OMIT,
description: typing.Optional[str] = OMIT,
host: typing.Optional[str] = OMIT,
last_sync: typing.Optional[dt.datetime] = OMIT,
last_sync_count: typing.Optional[int] = OMIT,
last_sync_job: typing.Optional[str] = OMIT,
meta: typing.Optional[typing.Any] = OMIT,
prefix: typing.Optional[str] = OMIT,
project: typing.Optional[int] = OMIT,
regex_filter: typing.Optional[str] = OMIT,
request_timeout_s: typing.Optional[int] = OMIT,
schema: typing.Optional[str] = OMIT,
status: typing.Optional[StatusC5AEnum] = OMIT,
stream_chunk_bytes: typing.Optional[int] = OMIT,
synchronizable: typing.Optional[bool] = OMIT,
tenant_id: typing.Optional[str] = OMIT,
title: typing.Optional[str] = OMIT,
token: typing.Optional[str] = OMIT,
traceback: typing.Optional[str] = OMIT,
use_blob_urls: typing.Optional[bool] = OMIT,
verify_tls: typing.Optional[bool] = OMIT,
volume: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[DatabricksExportStorage]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific Databricks Files export storage connection.
Parameters
----------
id : int
auth_type : typing.Optional[AuthTypeEnum]
Authentication method: PAT, Databricks SP, or Azure AD SP
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
can_delete_objects : typing.Optional[bool]
Deletion from storage enabled
catalog : typing.Optional[str]
UC catalog name
client_id : typing.Optional[str]
Service principal client/application ID (required for SP modes)
client_secret : typing.Optional[str]
Service principal client secret (required for SP modes)
description : typing.Optional[str]
Cloud storage description
host : typing.Optional[str]
Databricks workspace base URL (https://...)
last_sync : typing.Optional[dt.datetime]
Last sync finished time
last_sync_count : typing.Optional[int]
Count of tasks synced last time
last_sync_job : typing.Optional[str]
Last sync job ID
meta : typing.Optional[typing.Any]
Meta and debug information about storage processes
prefix : typing.Optional[str]
Export path prefix under the volume
project : typing.Optional[int]
A unique integer value identifying this project.
regex_filter : typing.Optional[str]
Regex for filtering objects
request_timeout_s : typing.Optional[int]
schema : typing.Optional[str]
UC schema name
status : typing.Optional[StatusC5AEnum]
stream_chunk_bytes : typing.Optional[int]
synchronizable : typing.Optional[bool]
tenant_id : typing.Optional[str]
Azure AD tenant ID (required for Azure AD SP mode)
title : typing.Optional[str]
Cloud storage title
token : typing.Optional[str]
Databricks personal access token (required for PAT mode)
traceback : typing.Optional[str]
Traceback report for the last failed sync
use_blob_urls : typing.Optional[bool]
Generate blob URLs in tasks
verify_tls : typing.Optional[bool]
Verify TLS certificates
volume : typing.Optional[str]
UC volume name
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[DatabricksExportStorage]
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/storages/export/databricks/{jsonable_encoder(id)}",
method="PATCH",
json={
"auth_type": auth_type,
"can_delete_objects": can_delete_objects,
"catalog": catalog,
"client_id": client_id,
"client_secret": client_secret,
"description": description,
"host": host,
"last_sync": last_sync,
"last_sync_count": last_sync_count,
"last_sync_job": last_sync_job,
"meta": meta,
"prefix": prefix,
"project": project,
"regex_filter": regex_filter,
"request_timeout_s": request_timeout_s,
"schema": schema,
"status": status,
"stream_chunk_bytes": stream_chunk_bytes,
"synchronizable": synchronizable,
"tenant_id": tenant_id,
"title": title,
"token": token,
"traceback": traceback,
"use_blob_urls": use_blob_urls,
"verify_tls": verify_tls,
"volume": volume,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
DatabricksExportStorage,
construct_type(
type_=DatabricksExportStorage, # type: ignore
object_=_response.json(),
),
)
return AsyncHttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
async def sync(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[DatabricksExportStorage]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Export annotations to a Databricks Files storage.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[DatabricksExportStorage]
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/storages/export/databricks/{jsonable_encoder(id)}/sync",
method="POST",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
DatabricksExportStorage,
construct_type(
type_=DatabricksExportStorage, # type: ignore
object_=_response.json(),
),
)
return AsyncHttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)