# This file was auto-generated by Fern from our API Definition.
import datetime as dt
import typing
from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.request_options import RequestOptions
from ...types.gcswif_export_storage import GcswifExportStorage
from ...types.status_c5a_enum import StatusC5AEnum
from .raw_client import AsyncRawGcswifClient, RawGcswifClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class GcswifClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawGcswifClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawGcswifClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawGcswifClient
"""
return self._raw_client
def list(
self,
*,
project: int,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[GcswifExportStorage]:
"""
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 GCS export storage connections that were set up with WIF authentication.
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
-------
typing.List[GcswifExportStorage]
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.export_storage.gcswif.list(
project=1,
)
"""
_response = self._raw_client.list(project=project, ordering=ordering, request_options=request_options)
return _response.data
def create(
self,
*,
project: int,
bucket: typing.Optional[str] = OMIT,
can_delete_objects: typing.Optional[bool] = OMIT,
description: typing.Optional[str] = OMIT,
google_application_credentials: typing.Optional[str] = OMIT,
google_project_id: typing.Optional[str] = OMIT,
google_project_number: typing.Optional[str] = OMIT,
google_service_account_email: typing.Optional[str] = OMIT,
google_wif_pool_id: typing.Optional[str] = OMIT,
google_wif_provider_id: 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,
status: typing.Optional[StatusC5AEnum] = OMIT,
synchronizable: typing.Optional[bool] = OMIT,
title: typing.Optional[str] = OMIT,
traceback: typing.Optional[str] = OMIT,
use_blob_urls: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> GcswifExportStorage:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create an GCS export storage connection with WIF authentication to store annotations.
Parameters
----------
project : int
A unique integer value identifying this project.
bucket : typing.Optional[str]
GCS bucket name
can_delete_objects : typing.Optional[bool]
Deletion from storage enabled
description : typing.Optional[str]
Cloud storage description
google_application_credentials : typing.Optional[str]
The content of GOOGLE_APPLICATION_CREDENTIALS json file
google_project_id : typing.Optional[str]
Google project ID
google_project_number : typing.Optional[str]
Google project number
google_service_account_email : typing.Optional[str]
Google service account email
google_wif_pool_id : typing.Optional[str]
Google WIF pool ID
google_wif_provider_id : typing.Optional[str]
Google WIF provider ID
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]
GCS bucket prefix
regex_filter : typing.Optional[str]
Cloud storage regex for filtering objects
status : typing.Optional[StatusC5AEnum]
synchronizable : typing.Optional[bool]
title : typing.Optional[str]
Cloud storage title
traceback : typing.Optional[str]
Traceback report for the last failed sync
use_blob_urls : typing.Optional[bool]
Interpret objects as BLOBs and generate URLs
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GcswifExportStorage
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.export_storage.gcswif.create(
project=1,
)
"""
_response = self._raw_client.create(
project=project,
bucket=bucket,
can_delete_objects=can_delete_objects,
description=description,
google_application_credentials=google_application_credentials,
google_project_id=google_project_id,
google_project_number=google_project_number,
google_service_account_email=google_service_account_email,
google_wif_pool_id=google_wif_pool_id,
google_wif_provider_id=google_wif_provider_id,
last_sync=last_sync,
last_sync_count=last_sync_count,
last_sync_job=last_sync_job,
meta=meta,
prefix=prefix,
regex_filter=regex_filter,
status=status,
synchronizable=synchronizable,
title=title,
traceback=traceback,
use_blob_urls=use_blob_urls,
request_options=request_options,
)
return _response.data
def validate(
self,
*,
project: int,
bucket: typing.Optional[str] = OMIT,
can_delete_objects: typing.Optional[bool] = OMIT,
description: typing.Optional[str] = OMIT,
google_application_credentials: typing.Optional[str] = OMIT,
google_project_id: typing.Optional[str] = OMIT,
google_project_number: typing.Optional[str] = OMIT,
google_service_account_email: typing.Optional[str] = OMIT,
google_wif_pool_id: typing.Optional[str] = OMIT,
google_wif_provider_id: 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,
status: typing.Optional[StatusC5AEnum] = OMIT,
synchronizable: typing.Optional[bool] = OMIT,
title: typing.Optional[str] = OMIT,
traceback: typing.Optional[str] = OMIT,
use_blob_urls: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> None:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a specific GCS export storage connection that was set up with WIF authentication.
Parameters
----------
project : int
A unique integer value identifying this project.
bucket : typing.Optional[str]
GCS bucket name
can_delete_objects : typing.Optional[bool]
Deletion from storage enabled
description : typing.Optional[str]
Cloud storage description
google_application_credentials : typing.Optional[str]
The content of GOOGLE_APPLICATION_CREDENTIALS json file
google_project_id : typing.Optional[str]
Google project ID
google_project_number : typing.Optional[str]
Google project number
google_service_account_email : typing.Optional[str]
Google service account email
google_wif_pool_id : typing.Optional[str]
Google WIF pool ID
google_wif_provider_id : typing.Optional[str]
Google WIF provider ID
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]
GCS bucket prefix
regex_filter : typing.Optional[str]
Cloud storage regex for filtering objects
status : typing.Optional[StatusC5AEnum]
synchronizable : typing.Optional[bool]
title : typing.Optional[str]
Cloud storage title
traceback : typing.Optional[str]
Traceback report for the last failed sync
use_blob_urls : typing.Optional[bool]
Interpret objects as BLOBs and generate URLs
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.export_storage.gcswif.validate(
project=1,
)
"""
_response = self._raw_client.validate(
project=project,
bucket=bucket,
can_delete_objects=can_delete_objects,
description=description,
google_application_credentials=google_application_credentials,
google_project_id=google_project_id,
google_project_number=google_project_number,
google_service_account_email=google_service_account_email,
google_wif_pool_id=google_wif_pool_id,
google_wif_provider_id=google_wif_provider_id,
last_sync=last_sync,
last_sync_count=last_sync_count,
last_sync_job=last_sync_job,
meta=meta,
prefix=prefix,
regex_filter=regex_filter,
status=status,
synchronizable=synchronizable,
title=title,
traceback=traceback,
use_blob_urls=use_blob_urls,
request_options=request_options,
)
return _response.data
def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcswifExportStorage:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a specific GCS export storage connection that was set up with WIF authentication.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GcswifExportStorage
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.export_storage.gcswif.get(
id=1,
)
"""
_response = self._raw_client.get(id, request_options=request_options)
return _response.data
def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific GCS export storage connection that was set up with WIF authentication.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.export_storage.gcswif.delete(
id=1,
)
"""
_response = self._raw_client.delete(id, request_options=request_options)
return _response.data
def update(
self,
id: int,
*,
bucket: typing.Optional[str] = OMIT,
can_delete_objects: typing.Optional[bool] = OMIT,
description: typing.Optional[str] = OMIT,
google_application_credentials: typing.Optional[str] = OMIT,
google_project_id: typing.Optional[str] = OMIT,
google_project_number: typing.Optional[str] = OMIT,
google_service_account_email: typing.Optional[str] = OMIT,
google_wif_pool_id: typing.Optional[str] = OMIT,
google_wif_provider_id: 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,
status: typing.Optional[StatusC5AEnum] = OMIT,
synchronizable: typing.Optional[bool] = OMIT,
title: typing.Optional[str] = OMIT,
traceback: typing.Optional[str] = OMIT,
use_blob_urls: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> GcswifExportStorage:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific GCS export storage connection that was set up with WIF authentication.
Parameters
----------
id : int
bucket : typing.Optional[str]
GCS bucket name
can_delete_objects : typing.Optional[bool]
Deletion from storage enabled
description : typing.Optional[str]
Cloud storage description
google_application_credentials : typing.Optional[str]
The content of GOOGLE_APPLICATION_CREDENTIALS json file
google_project_id : typing.Optional[str]
Google project ID
google_project_number : typing.Optional[str]
Google project number
google_service_account_email : typing.Optional[str]
Google service account email
google_wif_pool_id : typing.Optional[str]
Google WIF pool ID
google_wif_provider_id : typing.Optional[str]
Google WIF provider ID
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]
GCS bucket prefix
project : typing.Optional[int]
A unique integer value identifying this project.
regex_filter : typing.Optional[str]
Cloud storage regex for filtering objects
status : typing.Optional[StatusC5AEnum]
synchronizable : typing.Optional[bool]
title : typing.Optional[str]
Cloud storage title
traceback : typing.Optional[str]
Traceback report for the last failed sync
use_blob_urls : typing.Optional[bool]
Interpret objects as BLOBs and generate URLs
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GcswifExportStorage
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.export_storage.gcswif.update(
id=1,
)
"""
_response = self._raw_client.update(
id,
bucket=bucket,
can_delete_objects=can_delete_objects,
description=description,
google_application_credentials=google_application_credentials,
google_project_id=google_project_id,
google_project_number=google_project_number,
google_service_account_email=google_service_account_email,
google_wif_pool_id=google_wif_pool_id,
google_wif_provider_id=google_wif_provider_id,
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,
status=status,
synchronizable=synchronizable,
title=title,
traceback=traceback,
use_blob_urls=use_blob_urls,
request_options=request_options,
)
return _response.data
def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcswifExportStorage:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Sync tasks from an GCS WIF export storage.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GcswifExportStorage
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.export_storage.gcswif.sync(
id=1,
)
"""
_response = self._raw_client.sync(id, request_options=request_options)
return _response.data
class AsyncGcswifClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawGcswifClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawGcswifClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawGcswifClient
"""
return self._raw_client
async def list(
self,
*,
project: int,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[GcswifExportStorage]:
"""
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 GCS export storage connections that were set up with WIF authentication.
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
-------
typing.List[GcswifExportStorage]
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.export_storage.gcswif.list(
project=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.list(project=project, ordering=ordering, request_options=request_options)
return _response.data
async def create(
self,
*,
project: int,
bucket: typing.Optional[str] = OMIT,
can_delete_objects: typing.Optional[bool] = OMIT,
description: typing.Optional[str] = OMIT,
google_application_credentials: typing.Optional[str] = OMIT,
google_project_id: typing.Optional[str] = OMIT,
google_project_number: typing.Optional[str] = OMIT,
google_service_account_email: typing.Optional[str] = OMIT,
google_wif_pool_id: typing.Optional[str] = OMIT,
google_wif_provider_id: 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,
status: typing.Optional[StatusC5AEnum] = OMIT,
synchronizable: typing.Optional[bool] = OMIT,
title: typing.Optional[str] = OMIT,
traceback: typing.Optional[str] = OMIT,
use_blob_urls: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> GcswifExportStorage:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create an GCS export storage connection with WIF authentication to store annotations.
Parameters
----------
project : int
A unique integer value identifying this project.
bucket : typing.Optional[str]
GCS bucket name
can_delete_objects : typing.Optional[bool]
Deletion from storage enabled
description : typing.Optional[str]
Cloud storage description
google_application_credentials : typing.Optional[str]
The content of GOOGLE_APPLICATION_CREDENTIALS json file
google_project_id : typing.Optional[str]
Google project ID
google_project_number : typing.Optional[str]
Google project number
google_service_account_email : typing.Optional[str]
Google service account email
google_wif_pool_id : typing.Optional[str]
Google WIF pool ID
google_wif_provider_id : typing.Optional[str]
Google WIF provider ID
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]
GCS bucket prefix
regex_filter : typing.Optional[str]
Cloud storage regex for filtering objects
status : typing.Optional[StatusC5AEnum]
synchronizable : typing.Optional[bool]
title : typing.Optional[str]
Cloud storage title
traceback : typing.Optional[str]
Traceback report for the last failed sync
use_blob_urls : typing.Optional[bool]
Interpret objects as BLOBs and generate URLs
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GcswifExportStorage
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.export_storage.gcswif.create(
project=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.create(
project=project,
bucket=bucket,
can_delete_objects=can_delete_objects,
description=description,
google_application_credentials=google_application_credentials,
google_project_id=google_project_id,
google_project_number=google_project_number,
google_service_account_email=google_service_account_email,
google_wif_pool_id=google_wif_pool_id,
google_wif_provider_id=google_wif_provider_id,
last_sync=last_sync,
last_sync_count=last_sync_count,
last_sync_job=last_sync_job,
meta=meta,
prefix=prefix,
regex_filter=regex_filter,
status=status,
synchronizable=synchronizable,
title=title,
traceback=traceback,
use_blob_urls=use_blob_urls,
request_options=request_options,
)
return _response.data
async def validate(
self,
*,
project: int,
bucket: typing.Optional[str] = OMIT,
can_delete_objects: typing.Optional[bool] = OMIT,
description: typing.Optional[str] = OMIT,
google_application_credentials: typing.Optional[str] = OMIT,
google_project_id: typing.Optional[str] = OMIT,
google_project_number: typing.Optional[str] = OMIT,
google_service_account_email: typing.Optional[str] = OMIT,
google_wif_pool_id: typing.Optional[str] = OMIT,
google_wif_provider_id: 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,
status: typing.Optional[StatusC5AEnum] = OMIT,
synchronizable: typing.Optional[bool] = OMIT,
title: typing.Optional[str] = OMIT,
traceback: typing.Optional[str] = OMIT,
use_blob_urls: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> None:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a specific GCS export storage connection that was set up with WIF authentication.
Parameters
----------
project : int
A unique integer value identifying this project.
bucket : typing.Optional[str]
GCS bucket name
can_delete_objects : typing.Optional[bool]
Deletion from storage enabled
description : typing.Optional[str]
Cloud storage description
google_application_credentials : typing.Optional[str]
The content of GOOGLE_APPLICATION_CREDENTIALS json file
google_project_id : typing.Optional[str]
Google project ID
google_project_number : typing.Optional[str]
Google project number
google_service_account_email : typing.Optional[str]
Google service account email
google_wif_pool_id : typing.Optional[str]
Google WIF pool ID
google_wif_provider_id : typing.Optional[str]
Google WIF provider ID
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]
GCS bucket prefix
regex_filter : typing.Optional[str]
Cloud storage regex for filtering objects
status : typing.Optional[StatusC5AEnum]
synchronizable : typing.Optional[bool]
title : typing.Optional[str]
Cloud storage title
traceback : typing.Optional[str]
Traceback report for the last failed sync
use_blob_urls : typing.Optional[bool]
Interpret objects as BLOBs and generate URLs
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.export_storage.gcswif.validate(
project=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.validate(
project=project,
bucket=bucket,
can_delete_objects=can_delete_objects,
description=description,
google_application_credentials=google_application_credentials,
google_project_id=google_project_id,
google_project_number=google_project_number,
google_service_account_email=google_service_account_email,
google_wif_pool_id=google_wif_pool_id,
google_wif_provider_id=google_wif_provider_id,
last_sync=last_sync,
last_sync_count=last_sync_count,
last_sync_job=last_sync_job,
meta=meta,
prefix=prefix,
regex_filter=regex_filter,
status=status,
synchronizable=synchronizable,
title=title,
traceback=traceback,
use_blob_urls=use_blob_urls,
request_options=request_options,
)
return _response.data
async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcswifExportStorage:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a specific GCS export storage connection that was set up with WIF authentication.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GcswifExportStorage
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.export_storage.gcswif.get(
id=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.get(id, request_options=request_options)
return _response.data
async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific GCS export storage connection that was set up with WIF authentication.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.export_storage.gcswif.delete(
id=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.delete(id, request_options=request_options)
return _response.data
async def update(
self,
id: int,
*,
bucket: typing.Optional[str] = OMIT,
can_delete_objects: typing.Optional[bool] = OMIT,
description: typing.Optional[str] = OMIT,
google_application_credentials: typing.Optional[str] = OMIT,
google_project_id: typing.Optional[str] = OMIT,
google_project_number: typing.Optional[str] = OMIT,
google_service_account_email: typing.Optional[str] = OMIT,
google_wif_pool_id: typing.Optional[str] = OMIT,
google_wif_provider_id: 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,
status: typing.Optional[StatusC5AEnum] = OMIT,
synchronizable: typing.Optional[bool] = OMIT,
title: typing.Optional[str] = OMIT,
traceback: typing.Optional[str] = OMIT,
use_blob_urls: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> GcswifExportStorage:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific GCS export storage connection that was set up with WIF authentication.
Parameters
----------
id : int
bucket : typing.Optional[str]
GCS bucket name
can_delete_objects : typing.Optional[bool]
Deletion from storage enabled
description : typing.Optional[str]
Cloud storage description
google_application_credentials : typing.Optional[str]
The content of GOOGLE_APPLICATION_CREDENTIALS json file
google_project_id : typing.Optional[str]
Google project ID
google_project_number : typing.Optional[str]
Google project number
google_service_account_email : typing.Optional[str]
Google service account email
google_wif_pool_id : typing.Optional[str]
Google WIF pool ID
google_wif_provider_id : typing.Optional[str]
Google WIF provider ID
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]
GCS bucket prefix
project : typing.Optional[int]
A unique integer value identifying this project.
regex_filter : typing.Optional[str]
Cloud storage regex for filtering objects
status : typing.Optional[StatusC5AEnum]
synchronizable : typing.Optional[bool]
title : typing.Optional[str]
Cloud storage title
traceback : typing.Optional[str]
Traceback report for the last failed sync
use_blob_urls : typing.Optional[bool]
Interpret objects as BLOBs and generate URLs
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GcswifExportStorage
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.export_storage.gcswif.update(
id=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.update(
id,
bucket=bucket,
can_delete_objects=can_delete_objects,
description=description,
google_application_credentials=google_application_credentials,
google_project_id=google_project_id,
google_project_number=google_project_number,
google_service_account_email=google_service_account_email,
google_wif_pool_id=google_wif_pool_id,
google_wif_provider_id=google_wif_provider_id,
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,
status=status,
synchronizable=synchronizable,
title=title,
traceback=traceback,
use_blob_urls=use_blob_urls,
request_options=request_options,
)
return _response.data
async def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcswifExportStorage:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Sync tasks from an GCS WIF export storage.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GcswifExportStorage
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.export_storage.gcswif.sync(
id=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.sync(id, request_options=request_options)
return _response.data