diracx-client 0.0.1a33__py3-none-any.whl → 0.0.1a35__py3-none-any.whl

diracx/client/{generated → _generated}/aio/operations/_operations.py

@@ -1,7 +1,7 @@
 # pylint: disable=too-many-lines
 # coding=utf-8
 # --------------------------------------------------------------------------
-# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.10.4, generator: @autorest/python@6.32.1)
+# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.10.4, generator: @autorest/python@6.32.2)
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 from io import IOBase
@@ -36,6 +36,7 @@ from ...operations._operations import (
     build_auth_revoke_refresh_token_request,
     build_auth_userinfo_request,
     build_config_serve_config_request,
+    build_jobs_add_heartbeat_request,
     build_jobs_assign_sandbox_to_job_request,
     build_jobs_get_job_sandbox_request,
     build_jobs_get_job_sandboxes_request,
@@ -72,7 +73,7 @@ class WellKnownOperations:
         **DO NOT** instantiate this class directly.
 
         Instead, you should access the following operations through
-        :class:`~generated.aio.Dirac`'s
+        :class:`~_generated.aio.Dirac`'s
         :attr:`well_known` attribute.
     """
 
@@ -102,7 +103,7 @@ class WellKnownOperations:
         OpenID Connect discovery endpoint.
 
         :return: OpenIDConfiguration
-        :rtype: ~generated.models.OpenIDConfiguration
+        :rtype: ~_generated.models.OpenIDConfiguration
         :raises ~azure.core.exceptions.HttpResponseError:
         """
         error_map: MutableMapping = {
@@ -155,7 +156,7 @@ class WellKnownOperations:
         Get metadata about the dirac installation.
 
         :return: Metadata
-        :rtype: ~generated.models.Metadata
+        :rtype: ~_generated.models.Metadata
         :raises ~azure.core.exceptions.HttpResponseError:
         """
         error_map: MutableMapping = {
@@ -206,7 +207,7 @@ class AuthOperations:  # pylint: disable=abstract-class-instantiated
         **DO NOT** instantiate this class directly.
 
         Instead, you should access the following operations through
-        :class:`~generated.aio.Dirac`'s
+        :class:`~_generated.aio.Dirac`'s
         :attr:`auth` attribute.
     """
 
@@ -269,7 +270,7 @@ class AuthOperations:  # pylint: disable=abstract-class-instantiated
         :keyword scope: Required.
         :paramtype scope: str
         :return: InitiateDeviceFlowResponse
-        :rtype: ~generated.models.InitiateDeviceFlowResponse
+        :rtype: ~_generated.models.InitiateDeviceFlowResponse
         :raises ~azure.core.exceptions.HttpResponseError:
         """
         error_map: MutableMapping = {
@@ -604,7 +605,7 @@ class AuthOperations:  # pylint: disable=abstract-class-instantiated
         Get information about the user's identity.
 
         :return: UserInfoResponse
-        :rtype: ~generated.models.UserInfoResponse
+        :rtype: ~_generated.models.UserInfoResponse
         :raises ~azure.core.exceptions.HttpResponseError:
         """
         error_map: MutableMapping = {
@@ -830,7 +831,7 @@ class ConfigOperations:
         **DO NOT** instantiate this class directly.
 
         Instead, you should access the following operations through
-        :class:`~generated.aio.Dirac`'s
+        :class:`~_generated.aio.Dirac`'s
         :attr:`config` attribute.
     """
 
@@ -937,7 +938,7 @@ class JobsOperations:
         **DO NOT** instantiate this class directly.
 
         Instead, you should access the following operations through
-        :class:`~generated.aio.Dirac`'s
+        :class:`~_generated.aio.Dirac`'s
         :attr:`jobs` attribute.
     """
 
@@ -977,12 +978,12 @@ class JobsOperations:
         should be used to upload the sandbox to the storage backend.
 
         :param body: Required.
-        :type body: ~generated.models.SandboxInfo
+        :type body: ~_generated.models.SandboxInfo
         :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
          Default value is "application/json".
         :paramtype content_type: str
         :return: SandboxUploadResponse
-        :rtype: ~generated.models.SandboxUploadResponse
+        :rtype: ~_generated.models.SandboxUploadResponse
         :raises ~azure.core.exceptions.HttpResponseError:
         """
 
@@ -1006,7 +1007,7 @@ class JobsOperations:
          Default value is "application/json".
         :paramtype content_type: str
         :return: SandboxUploadResponse
-        :rtype: ~generated.models.SandboxUploadResponse
+        :rtype: ~_generated.models.SandboxUploadResponse
         :raises ~azure.core.exceptions.HttpResponseError:
         """
 
@@ -1025,9 +1026,9 @@ class JobsOperations:
         should be used to upload the sandbox to the storage backend.
 
         :param body: Is either a SandboxInfo type or a IO[bytes] type. Required.
-        :type body: ~generated.models.SandboxInfo or IO[bytes]
+        :type body: ~_generated.models.SandboxInfo or IO[bytes]
         :return: SandboxUploadResponse
-        :rtype: ~generated.models.SandboxUploadResponse
+        :rtype: ~_generated.models.SandboxUploadResponse
         :raises ~azure.core.exceptions.HttpResponseError:
         """
         error_map: MutableMapping = {
@@ -1104,7 +1105,7 @@ class JobsOperations:
         :keyword pfn: Required.
         :paramtype pfn: str
         :return: SandboxDownloadResponse
-        :rtype: ~generated.models.SandboxDownloadResponse
+        :rtype: ~_generated.models.SandboxDownloadResponse
         :raises ~azure.core.exceptions.HttpResponseError:
         """
         error_map: MutableMapping = {
@@ -1328,7 +1329,7 @@ class JobsOperations:
         :param job_id: Required.
         :type job_id: int
         :param sandbox_type: Known values are: "input" and "output". Required.
-        :type sandbox_type: str or ~generated.models.SandboxType
+        :type sandbox_type: str or ~_generated.models.SandboxType
         :return: list of any
         :rtype: list[any]
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -1512,14 +1513,14 @@ class JobsOperations:
         Set Job Statuses.
 
         :param body: Required.
-        :type body: dict[str, dict[str, ~generated.models.JobStatusUpdate]]
+        :type body: dict[str, dict[str, ~_generated.models.JobStatusUpdate]]
         :keyword force: Default value is False.
         :paramtype force: bool
         :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
          Default value is "application/json".
         :paramtype content_type: str
         :return: SetJobStatusReturn
-        :rtype: ~generated.models.SetJobStatusReturn
+        :rtype: ~_generated.models.SetJobStatusReturn
         :raises ~azure.core.exceptions.HttpResponseError:
         """
 
@@ -1544,7 +1545,7 @@ class JobsOperations:
          Default value is "application/json".
         :paramtype content_type: str
         :return: SetJobStatusReturn
-        :rtype: ~generated.models.SetJobStatusReturn
+        :rtype: ~_generated.models.SetJobStatusReturn
         :raises ~azure.core.exceptions.HttpResponseError:
         """
 
@@ -1561,11 +1562,11 @@ class JobsOperations:
         Set Job Statuses.
 
         :param body: Is either a {str: {str: JobStatusUpdate}} type or a IO[bytes] type. Required.
-        :type body: dict[str, dict[str, ~generated.models.JobStatusUpdate]] or IO[bytes]
+        :type body: dict[str, dict[str, ~_generated.models.JobStatusUpdate]] or IO[bytes]
         :keyword force: Default value is False.
         :paramtype force: bool
         :return: SetJobStatusReturn
-        :rtype: ~generated.models.SetJobStatusReturn
+        :rtype: ~_generated.models.SetJobStatusReturn
         :raises ~azure.core.exceptions.HttpResponseError:
         """
         error_map: MutableMapping = {
@@ -1626,6 +1627,135 @@ class JobsOperations:
 
         return deserialized  # type: ignore
 
+    @overload
+    async def add_heartbeat(
+        self,
+        body: Dict[str, _models.HeartbeatData],
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any,
+    ) -> List[_models.JobCommand]:
+        """Add Heartbeat.
+
+        Register a heartbeat from the job.
+
+        This endpoint is used by the JobAgent to send heartbeats to the WMS and to
+        receive job commands from the WMS. It also results in stalled jobs being
+        restored to the RUNNING status.
+
+        The ``data`` parameter and return value are mappings keyed by job ID.
+
+        :param body: Required.
+        :type body: dict[str, ~_generated.models.HeartbeatData]
+        :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: list of JobCommand
+        :rtype: list[~_generated.models.JobCommand]
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @overload
+    async def add_heartbeat(
+        self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any
+    ) -> List[_models.JobCommand]:
+        """Add Heartbeat.
+
+        Register a heartbeat from the job.
+
+        This endpoint is used by the JobAgent to send heartbeats to the WMS and to
+        receive job commands from the WMS. It also results in stalled jobs being
+        restored to the RUNNING status.
+
+        The ``data`` parameter and return value are mappings keyed by job ID.
+
+        :param body: Required.
+        :type body: IO[bytes]
+        :keyword content_type: Body Parameter content-type. Content type parameter for binary body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: list of JobCommand
+        :rtype: list[~_generated.models.JobCommand]
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @distributed_trace_async
+    async def add_heartbeat(
+        self, body: Union[Dict[str, _models.HeartbeatData], IO[bytes]], **kwargs: Any
+    ) -> List[_models.JobCommand]:
+        """Add Heartbeat.
+
+        Register a heartbeat from the job.
+
+        This endpoint is used by the JobAgent to send heartbeats to the WMS and to
+        receive job commands from the WMS. It also results in stalled jobs being
+        restored to the RUNNING status.
+
+        The ``data`` parameter and return value are mappings keyed by job ID.
+
+        :param body: Is either a {str: HeartbeatData} type or a IO[bytes] type. Required.
+        :type body: dict[str, ~_generated.models.HeartbeatData] or IO[bytes]
+        :return: list of JobCommand
+        :rtype: list[~_generated.models.JobCommand]
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        error_map: MutableMapping = {
+            401: ClientAuthenticationError,
+            404: ResourceNotFoundError,
+            409: ResourceExistsError,
+            304: ResourceNotModifiedError,
+        }
+        error_map.update(kwargs.pop("error_map", {}) or {})
+
+        _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
+        _params = kwargs.pop("params", {}) or {}
+
+        content_type: Optional[str] = kwargs.pop(
+            "content_type", _headers.pop("Content-Type", None)
+        )
+        cls: ClsType[List[_models.JobCommand]] = kwargs.pop("cls", None)
+
+        content_type = content_type or "application/json"
+        _json = None
+        _content = None
+        if isinstance(body, (IOBase, bytes)):
+            _content = body
+        else:
+            _json = self._serialize.body(body, "{HeartbeatData}")
+
+        _request = build_jobs_add_heartbeat_request(
+            content_type=content_type,
+            json=_json,
+            content=_content,
+            headers=_headers,
+            params=_params,
+        )
+        _request.url = self._client.format_url(_request.url)
+
+        _stream = False
+        pipeline_response: PipelineResponse = (
+            await self._client._pipeline.run(  # pylint: disable=protected-access
+                _request, stream=_stream, **kwargs
+            )
+        )
+
+        response = pipeline_response.http_response
+
+        if response.status_code not in [200]:
+            map_error(
+                status_code=response.status_code, response=response, error_map=error_map
+            )
+            raise HttpResponseError(response=response)
+
+        deserialized = self._deserialize(
+            "[JobCommand]", pipeline_response.http_response
+        )
+
+        if cls:
+            return cls(pipeline_response, deserialized, {})  # type: ignore
+
+        return deserialized  # type: ignore
+
     @distributed_trace_async
     async def reschedule_jobs(
         self, *, job_ids: List[int], reset_jobs: bool = False, **kwargs: Any
@@ -1807,7 +1937,7 @@ class JobsOperations:
         **TODO: Add more docs**.
 
         :param body: Default value is None.
-        :type body: ~generated.models.JobSearchParams
+        :type body: ~_generated.models.JobSearchParams
         :keyword page: Default value is 1.
         :paramtype page: int
         :keyword per_page: Default value is 100.
@@ -1866,7 +1996,7 @@ class JobsOperations:
         **TODO: Add more docs**.
 
         :param body: Is either a JobSearchParams type or a IO[bytes] type. Default value is None.
-        :type body: ~generated.models.JobSearchParams or IO[bytes]
+        :type body: ~_generated.models.JobSearchParams or IO[bytes]
         :keyword page: Default value is 1.
         :paramtype page: int
         :keyword per_page: Default value is 100.
@@ -1954,7 +2084,7 @@ class JobsOperations:
         Show information suitable for plotting.
 
         :param body: Required.
-        :type body: ~generated.models.JobSummaryParams
+        :type body: ~_generated.models.JobSummaryParams
         :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
          Default value is "application/json".
         :paramtype content_type: str
@@ -1990,7 +2120,7 @@ class JobsOperations:
         Show information suitable for plotting.
 
         :param body: Is either a JobSummaryParams type or a IO[bytes] type. Required.
-        :type body: ~generated.models.JobSummaryParams or IO[bytes]
+        :type body: ~_generated.models.JobSummaryParams or IO[bytes]
         :return: any
         :rtype: any
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -2064,7 +2194,7 @@ class JobsOperations:
          Default value is "application/json".
         :paramtype content_type: str
         :return: list of InsertedJob
-        :rtype: list[~generated.models.InsertedJob]
+        :rtype: list[~_generated.models.InsertedJob]
         :raises ~azure.core.exceptions.HttpResponseError:
         """
 
@@ -2082,7 +2212,7 @@ class JobsOperations:
          Default value is "application/json".
         :paramtype content_type: str
         :return: list of InsertedJob
-        :rtype: list[~generated.models.InsertedJob]
+        :rtype: list[~_generated.models.InsertedJob]
         :raises ~azure.core.exceptions.HttpResponseError:
         """
 
@@ -2097,7 +2227,7 @@ class JobsOperations:
         :param body: Is either a [str] type or a IO[bytes] type. Required.
         :type body: list[str] or IO[bytes]
         :return: list of InsertedJob
-        :rtype: list[~generated.models.InsertedJob]
+        :rtype: list[~_generated.models.InsertedJob]
         :raises ~azure.core.exceptions.HttpResponseError:
         """
         error_map: MutableMapping = {

diracx/client/_generated/aio/operations/_patch.py

@@ -0,0 +1,26 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+"""Customize generated code here.
+
+Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
+"""
+from __future__ import annotations
+
+__all__ = [
+    "AuthOperations",
+    "JobsOperations",
+]  # Add all objects you want publicly available to users at this package level
+
+from ....patches.auth.aio import AuthOperations
+from ....patches.jobs.aio import JobsOperations
+
+
+def patch_sdk():
+    """Do not remove from this file.
+
+    `patch_sdk` is a last resort escape hatch that allows you to do customizations
+    you can't accomplish using the techniques described in
+    https://aka.ms/azsdk/python/dpcodegen/python/customize
+    """

diracx/client/{generated → _generated}/models/__init__.py

@@ -1,6 +1,6 @@
 # coding=utf-8
 # --------------------------------------------------------------------------
-# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.10.4, generator: @autorest/python@6.32.1)
+# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.10.4, generator: @autorest/python@6.32.2)
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 # pylint: disable=wrong-import-position
@@ -16,8 +16,10 @@ from ._models import (  # type: ignore
     BodyAuthGetOidcTokenGrantType,
     GroupInfo,
     HTTPValidationError,
+    HeartbeatData,
     InitiateDeviceFlowResponse,
     InsertedJob,
+    JobCommand,
     JobSearchParams,
     JobSearchParamsSearchItem,
     JobStatusUpdate,
@@ -61,8 +63,10 @@ __all__ = [
     "BodyAuthGetOidcTokenGrantType",
     "GroupInfo",
     "HTTPValidationError",
+    "HeartbeatData",
     "InitiateDeviceFlowResponse",
     "InsertedJob",
+    "JobCommand",
     "JobSearchParams",
     "JobSearchParamsSearchItem",
     "JobStatusUpdate",
@@ -96,3 +100,9 @@ __all__ = [
 ]
 __all__.extend([p for p in _patch_all if p not in __all__])  # pyright: ignore
 _patch_sdk()
+if TYPE_CHECKING:
+    __all__.extend(
+        [
+            "DeviceFlowErrorResponse",
+        ]
+    )

diracx/client/{generated → _generated}/models/_enums.py

@@ -1,6 +1,6 @@
 # coding=utf-8
 # --------------------------------------------------------------------------
-# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.10.4, generator: @autorest/python@6.32.1)
+# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.10.4, generator: @autorest/python@6.32.2)
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------