label-studio-sdk 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

label_studio_sdk/export_storage/gcs/client.py

@@ -66,6 +66,9 @@ class GcsClient:
     def create(
         self,
         *,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         bucket: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
@@ -82,6 +85,15 @@ class GcsClient:
 
         Parameters
         ----------
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -92,7 +104,7 @@ class GcsClient:
             GCS bucket prefix
 
         google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
 
         google_project_id : typing.Optional[str]
             Google project ID
@@ -118,6 +130,9 @@ class GcsClient:
             "api/storages/export/gcs",
             method="POST",
             json={
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
                 "project": project,
                 "bucket": bucket,
                 "prefix": prefix,
@@ -135,19 +150,58 @@ class GcsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def validate(self, *, request_options: typing.Optional[RequestOptions] = None) -> GcsExportStorage:
+    def validate(
+        self,
+        *,
+        id: typing.Optional[int] = OMIT,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        bucket: typing.Optional[str] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        google_application_credentials: typing.Optional[str] = OMIT,
+        google_project_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
         """
         Validate a specific GCS export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.
 
         Parameters
         ----------
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
+
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
+        project : typing.Optional[int]
+            Project ID
+
+        bucket : typing.Optional[str]
+            GCS bucket name
+
+        prefix : typing.Optional[str]
+            GCS bucket prefix
+
+        google_application_credentials : typing.Optional[str]
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
+
+        google_project_id : typing.Optional[str]
+            Google project ID
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        GcsExportStorage
-
+        None
 
         Examples
         --------
@@ -159,10 +213,24 @@ class GcsClient:
         client.export_storage.gcs.validate()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/export/gcs/validate", method="POST", request_options=request_options
+            "api/storages/export/gcs/validate",
+            method="POST",
+            json={
+                "id": id,
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
+                "project": project,
+                "bucket": bucket,
+                "prefix": prefix,
+                "google_application_credentials": google_application_credentials,
+                "google_project_id": google_project_id,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(GcsExportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -254,6 +322,9 @@ class GcsClient:
         self,
         id: int,
         *,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         bucket: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
@@ -271,6 +342,15 @@ class GcsClient:
         id : int
             A unique integer value identifying this gcs export storage.
 
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -281,7 +361,7 @@ class GcsClient:
             GCS bucket prefix
 
         google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
 
         google_project_id : typing.Optional[str]
             Google project ID
@@ -309,6 +389,9 @@ class GcsClient:
             f"api/storages/export/gcs/{jsonable_encoder(id)}",
             method="PATCH",
             json={
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
                 "project": project,
                 "bucket": bucket,
                 "prefix": prefix,
@@ -419,6 +502,9 @@ class AsyncGcsClient:
     async def create(
         self,
         *,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         bucket: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
@@ -435,6 +521,15 @@ class AsyncGcsClient:
 
         Parameters
         ----------
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -445,7 +540,7 @@ class AsyncGcsClient:
             GCS bucket prefix
 
         google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
 
         google_project_id : typing.Optional[str]
             Google project ID
@@ -471,6 +566,9 @@ class AsyncGcsClient:
             "api/storages/export/gcs",
             method="POST",
             json={
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
                 "project": project,
                 "bucket": bucket,
                 "prefix": prefix,
@@ -488,19 +586,58 @@ class AsyncGcsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def validate(self, *, request_options: typing.Optional[RequestOptions] = None) -> GcsExportStorage:
+    async def validate(
+        self,
+        *,
+        id: typing.Optional[int] = OMIT,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        bucket: typing.Optional[str] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        google_application_credentials: typing.Optional[str] = OMIT,
+        google_project_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
         """
         Validate a specific GCS export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.
 
         Parameters
         ----------
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
+
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
+        project : typing.Optional[int]
+            Project ID
+
+        bucket : typing.Optional[str]
+            GCS bucket name
+
+        prefix : typing.Optional[str]
+            GCS bucket prefix
+
+        google_application_credentials : typing.Optional[str]
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
+
+        google_project_id : typing.Optional[str]
+            Google project ID
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        GcsExportStorage
-
+        None
 
         Examples
         --------
@@ -512,10 +649,24 @@ class AsyncGcsClient:
         await client.export_storage.gcs.validate()
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/gcs/validate", method="POST", request_options=request_options
+            "api/storages/export/gcs/validate",
+            method="POST",
+            json={
+                "id": id,
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
+                "project": project,
+                "bucket": bucket,
+                "prefix": prefix,
+                "google_application_credentials": google_application_credentials,
+                "google_project_id": google_project_id,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(GcsExportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -607,6 +758,9 @@ class AsyncGcsClient:
         self,
         id: int,
         *,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         bucket: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
@@ -624,6 +778,15 @@ class AsyncGcsClient:
         id : int
             A unique integer value identifying this gcs export storage.
 
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -634,7 +797,7 @@ class AsyncGcsClient:
             GCS bucket prefix
 
         google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
 
         google_project_id : typing.Optional[str]
             Google project ID
@@ -662,6 +825,9 @@ class AsyncGcsClient:
             f"api/storages/export/gcs/{jsonable_encoder(id)}",
             method="PATCH",
             json={
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
                 "project": project,
                 "bucket": bucket,
                 "prefix": prefix,

label_studio_sdk/export_storage/gcs/types/gcs_create_response.py

@@ -8,6 +8,21 @@ from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
 class GcsCreateResponse(pydantic_v1.BaseModel):
+    can_delete_objects: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Deletion from storage enabled.
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage description
+    """
+
     project: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
     Project ID
@@ -25,7 +40,7 @@ class GcsCreateResponse(pydantic_v1.BaseModel):
 
     google_application_credentials: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
-    The content of GOOGLE_APPLICATION_CREDENTIALS json file
+    The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
     """
 
     google_project_id: typing.Optional[str] = pydantic_v1.Field(default=None)

label_studio_sdk/export_storage/gcs/types/gcs_update_response.py

@@ -8,6 +8,21 @@ from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
 class GcsUpdateResponse(pydantic_v1.BaseModel):
+    can_delete_objects: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Deletion from storage enabled.
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage description
+    """
+
     project: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
     Project ID
@@ -25,7 +40,7 @@ class GcsUpdateResponse(pydantic_v1.BaseModel):
 
     google_application_credentials: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
-    The content of GOOGLE_APPLICATION_CREDENTIALS json file
+    The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
     """
 
     google_project_id: typing.Optional[str] = pydantic_v1.Field(default=None)