refactor(serverless_jobs): returns a list of job runs when starting a job definition (#436)

Author: scaleway-bot

scaleway-async/scaleway_async/jobs/v1alpha1/__init__.py

@@ -9,6 +9,7 @@
 from .types import JobRun
 from .types import ListJobDefinitionsResponse
 from .types import ListJobRunsResponse
+from .types import StartJobDefinitionResponse
 from .types import UpdateJobDefinitionRequestCronScheduleConfig
 from .content import JOB_RUN_TRANSIENT_STATUSES
 from .api import JobsV1Alpha1API
@@ -23,6 +24,7 @@
     "JobRun",
     "ListJobDefinitionsResponse",
     "ListJobRunsResponse",
+    "StartJobDefinitionResponse",
     "UpdateJobDefinitionRequestCronScheduleConfig",
     "JOB_RUN_TRANSIENT_STATUSES",
     "JobsV1Alpha1API",

scaleway-async/scaleway_async/jobs/v1alpha1/api.py

@@ -20,6 +20,7 @@
     JobRun,
     ListJobDefinitionsResponse,
     ListJobRunsResponse,
+    StartJobDefinitionResponse,
     UpdateJobDefinitionRequestCronScheduleConfig,
     CreateJobDefinitionRequest,
     UpdateJobDefinitionRequest,
@@ -33,6 +34,7 @@
     unmarshal_JobRun,
     unmarshal_ListJobDefinitionsResponse,
     unmarshal_ListJobRunsResponse,
+    unmarshal_StartJobDefinitionResponse,
 )
 
 
@@ -332,7 +334,7 @@ async def start_job_definition(
         command: Optional[str] = None,
         environment_variables: Optional[Dict[str, str]] = None,
         replicas: Optional[int] = None,
-    ) -> JobRun:
+    ) -> StartJobDefinitionResponse:
         """
         Run an existing job definition by its unique identifier. This will create a new job run.
         :param region: Region to target. If none is passed will use default region from the config.
@@ -344,7 +346,7 @@ async def start_job_definition(
         :param replicas: Number of jobs to run.
 
         One-of ('_replicas'): at most one of 'replicas' could be set.
-        :return: :class:`JobRun <JobRun>`
+        :return: :class:`StartJobDefinitionResponse <StartJobDefinitionResponse>`
 
         Usage:
         ::
@@ -375,7 +377,7 @@ async def start_job_definition(
         )
 
         self._throw_on_error(res)
-        return unmarshal_JobRun(res.json())
+        return unmarshal_StartJobDefinitionResponse(res.json())
 
     async def get_job_run(
         self,

scaleway-async/scaleway_async/jobs/v1alpha1/marshalling.py

@@ -16,6 +16,7 @@
     JobRun,
     ListJobDefinitionsResponse,
     ListJobRunsResponse,
+    StartJobDefinitionResponse,
     UpdateJobDefinitionRequestCronScheduleConfig,
     CreateJobDefinitionRequest,
     UpdateJobDefinitionRequest,
@@ -184,6 +185,22 @@ def unmarshal_ListJobRunsResponse(data: Any) -> ListJobRunsResponse:
     return ListJobRunsResponse(**args)
 
 
+def unmarshal_StartJobDefinitionResponse(data: Any) -> StartJobDefinitionResponse:
+    if type(data) is not dict:
+        raise TypeError(
+            f"Unmarshalling the type 'StartJobDefinitionResponse' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("job_runs", None)
+    args["job_runs"] = (
+        [unmarshal_JobRun(v) for v in field] if field is not None else None
+    )
+
+    return StartJobDefinitionResponse(**args)
+
+
 def marshal_CreateJobDefinitionRequestCronScheduleConfig(
     request: CreateJobDefinitionRequestCronScheduleConfig,
     defaults: ProfileDefaults,

scaleway-async/scaleway_async/jobs/v1alpha1/types.py

@@ -23,6 +23,7 @@ class JobRunState(str, Enum, metaclass=StrEnumMeta):
     SUCCEEDED = "succeeded"
     FAILED = "failed"
     CANCELED = "canceled"
+    INTERNAL_ERROR = "internal_error"
 
     def __str__(self) -> str:
         return str(self.value)
@@ -138,6 +139,11 @@ class ListJobRunsResponse:
     total_count: int
 
 
+@dataclass
+class StartJobDefinitionResponse:
+    job_runs: List[JobRun]
+
+
 @dataclass
 class UpdateJobDefinitionRequestCronScheduleConfig:
     schedule: Optional[str]

scaleway/scaleway/jobs/v1alpha1/__init__.py

@@ -9,6 +9,7 @@
 from .types import JobRun
 from .types import ListJobDefinitionsResponse
 from .types import ListJobRunsResponse
+from .types import StartJobDefinitionResponse
 from .types import UpdateJobDefinitionRequestCronScheduleConfig
 from .content import JOB_RUN_TRANSIENT_STATUSES
 from .api import JobsV1Alpha1API
@@ -23,6 +24,7 @@
     "JobRun",
     "ListJobDefinitionsResponse",
     "ListJobRunsResponse",
+    "StartJobDefinitionResponse",
     "UpdateJobDefinitionRequestCronScheduleConfig",
     "JOB_RUN_TRANSIENT_STATUSES",
     "JobsV1Alpha1API",

scaleway/scaleway/jobs/v1alpha1/api.py

@@ -20,6 +20,7 @@
     JobRun,
     ListJobDefinitionsResponse,
     ListJobRunsResponse,
+    StartJobDefinitionResponse,
     UpdateJobDefinitionRequestCronScheduleConfig,
     CreateJobDefinitionRequest,
     UpdateJobDefinitionRequest,
@@ -33,6 +34,7 @@
     unmarshal_JobRun,
     unmarshal_ListJobDefinitionsResponse,
     unmarshal_ListJobRunsResponse,
+    unmarshal_StartJobDefinitionResponse,
 )
 
 
@@ -332,7 +334,7 @@ def start_job_definition(
         command: Optional[str] = None,
         environment_variables: Optional[Dict[str, str]] = None,
         replicas: Optional[int] = None,
-    ) -> JobRun:
+    ) -> StartJobDefinitionResponse:
         """
         Run an existing job definition by its unique identifier. This will create a new job run.
         :param region: Region to target. If none is passed will use default region from the config.
@@ -344,7 +346,7 @@ def start_job_definition(
         :param replicas: Number of jobs to run.
 
         One-of ('_replicas'): at most one of 'replicas' could be set.
-        :return: :class:`JobRun <JobRun>`
+        :return: :class:`StartJobDefinitionResponse <StartJobDefinitionResponse>`
 
         Usage:
         ::
@@ -375,7 +377,7 @@ def start_job_definition(
         )
 
         self._throw_on_error(res)
-        return unmarshal_JobRun(res.json())
+        return unmarshal_StartJobDefinitionResponse(res.json())
 
     def get_job_run(
         self,

scaleway/scaleway/jobs/v1alpha1/marshalling.py

@@ -16,6 +16,7 @@
     JobRun,
     ListJobDefinitionsResponse,
     ListJobRunsResponse,
+    StartJobDefinitionResponse,
     UpdateJobDefinitionRequestCronScheduleConfig,
     CreateJobDefinitionRequest,
     UpdateJobDefinitionRequest,
@@ -184,6 +185,22 @@ def unmarshal_ListJobRunsResponse(data: Any) -> ListJobRunsResponse:
     return ListJobRunsResponse(**args)
 
 
+def unmarshal_StartJobDefinitionResponse(data: Any) -> StartJobDefinitionResponse:
+    if type(data) is not dict:
+        raise TypeError(
+            f"Unmarshalling the type 'StartJobDefinitionResponse' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("job_runs", None)
+    args["job_runs"] = (
+        [unmarshal_JobRun(v) for v in field] if field is not None else None
+    )
+
+    return StartJobDefinitionResponse(**args)
+
+
 def marshal_CreateJobDefinitionRequestCronScheduleConfig(
     request: CreateJobDefinitionRequestCronScheduleConfig,
     defaults: ProfileDefaults,

scaleway/scaleway/jobs/v1alpha1/types.py

@@ -23,6 +23,7 @@ class JobRunState(str, Enum, metaclass=StrEnumMeta):
     SUCCEEDED = "succeeded"
     FAILED = "failed"
     CANCELED = "canceled"
+    INTERNAL_ERROR = "internal_error"
 
     def __str__(self) -> str:
         return str(self.value)
@@ -138,6 +139,11 @@ class ListJobRunsResponse:
     total_count: int
 
 
+@dataclass
+class StartJobDefinitionResponse:
+    job_runs: List[JobRun]
+
+
 @dataclass
 class UpdateJobDefinitionRequestCronScheduleConfig:
     schedule: Optional[str]