Add new query api methods (#284) (#4056)

Co-authored-by: Martynas Asipauskas <[email protected]>

client/python/armada_client/asyncio_client.py

@@ -202,6 +202,39 @@ async def get_job_status(self, job_ids: List[str]) -> job_pb2.JobStatusResponse:
         resp = await self.job_stub.GetJobStatus(req)
         return resp
 
+    async def get_job_status_by_external_job_uri(
+        self, queue: str, job_set_id: str, external_job_uri: str
+    ) -> job_pb2.JobDetailsResponse:
+        """
+        Retrieves the status of a job based on externalJobUri annotation.
+
+        :param queue: The name of the queue
+        :param job_set_id: The name of the job set (a grouping of jobs)
+        :param external_job_uri: externalJobUri annotation value
+
+        :returns: The response from the server containing the job status.
+        :rtype: JobStatusResponse
+        """
+        req = job_pb2.JobStatusUsingExternalJobUriRequest(
+            queue, job_set_id, external_job_uri
+        )
+        resp = await self.job_stub.GetJobStatusUsingExternalJobUri(req)
+        return resp
+
+    async def get_job_errors(self, job_ids: List[str]) -> job_pb2.JobErrorsResponse:
+        """
+        Retrieves termination reason from query api.
+
+        :param job_ids: A list of unique job identifiers.
+        :type job_ids: List[str]
+
+        :returns: The response from the server containing the job errors.
+        :rtype: JobErrorsResponse
+        """
+        req = job_pb2.JobErrorsRequest(job_ids=job_ids)
+        resp = await self.job_stub.GetJobErrors(req)
+        return resp
+
     async def get_job_details(self, job_ids: List[str]) -> job_pb2.JobDetailsResponse:
         """
         Asynchronously retrieves the details of a job from Armada.

client/python/armada_client/client.py

@@ -177,6 +177,38 @@ def get_job_status(self, job_ids: List[str]) -> job_pb2.JobStatusResponse:
         req = job_pb2.JobStatusRequest(job_ids=job_ids)
         return self.job_stub.GetJobStatus(req)
 
+    def get_job_status_by_external_job_uri(
+        self, queue: str, job_set_id: str, external_job_uri: str
+    ) -> job_pb2.JobDetailsResponse:
+        """
+        Retrieves the status of a job based on externalJobUri annotation.
+
+        :param queue: The name of the queue
+        :param job_set_id: The name of the job set (a grouping of jobs)
+        :param external_job_uri: externalJobUri annotation value
+
+        :returns: The response from the server containing the job status.
+        :rtype: JobStatusResponse
+        """
+        req = job_pb2.JobStatusUsingExternalJobUriRequest(
+            queue, job_set_id, external_job_uri
+        )
+        return self.job_stub.GetJobStatusUsingExternalJobUri(req)
+
+    def get_job_errors(self, job_ids: List[str]) -> job_pb2.JobErrorsResponse:
+        """
+        Retrieves termination reason from query api.
+
+        :param queue: The name of the queue
+        :param job_set_id: The name of the job set (a grouping of jobs)
+        :param external_job_uri: externalJobUri annotation value
+
+        :returns: The response from the server containing the job errors.
+        :rtype: JobErrorsResponse
+        """
+        req = job_pb2.JobErrorsRequest(job_ids=job_ids)
+        return self.job_stub.GetJobErrors(req)
+
     def get_job_details(self, job_ids: List[str]) -> job_pb2.JobDetailsResponse:
         """
         Retrieves the details of a job from Armada.

client/python/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "armada_client"
-version = "0.4.6"
+version = "0.4.7"
 description = "Armada gRPC API python client"
 readme = "README.md"
 requires-python = ">=3.7"

docs/python_armada_client.md

@@ -277,6 +277,38 @@ Retrieves the details of a job from Armada.
 
 
 
+#### get_job_errors(job_ids)
+Retrieves termination reason from query api.
+
+
+* **Parameters**
+
+
+    * **queue** – The name of the queue
+
+
+    * **job_set_id** – The name of the job set (a grouping of jobs)
+
+
+    * **external_job_uri** – externalJobUri annotation value
+
+
+    * **job_ids** (*List**[**str**]*) – 
+
+
+
+* **Returns**
+
+    The response from the server containing the job errors.
+
+
+
+* **Return type**
+
+    JobErrorsResponse
+
+
+
 #### get_job_events_stream(queue, job_set_id, from_message_id=None)
 Get event stream for a job set.
 
@@ -362,6 +394,35 @@ Retrieves the status of a list of jobs from Armada.
 
 
 
+#### get_job_status_by_external_job_uri(queue, job_set_id, external_job_uri)
+Retrieves the status of a job based on externalJobUri annotation.
+
+
+* **Parameters**
+
+
+    * **queue** (*str*) – The name of the queue
+
+
+    * **job_set_id** (*str*) – The name of the job set (a grouping of jobs)
+
+
+    * **external_job_uri** (*str*) – externalJobUri annotation value
+
+
+
+* **Returns**
+
+    The response from the server containing the job status.
+
+
+
+* **Return type**
+
+    JobStatusResponse
+
+
+
 #### get_queue(name)
 Get the queue by name.