Skip to content

Commit

Permalink
feat(serverless_jobs): add state filter to list job runs (#834)
Browse files Browse the repository at this point in the history
  • Loading branch information
scaleway-bot authored Jan 17, 2025
1 parent 68b2e72 commit 7004fcd
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 0 deletions.
7 changes: 7 additions & 0 deletions scaleway-async/scaleway_async/jobs/v1alpha1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
fetch_all_pages_async,
)
from .types import (
JobRunState,
ListJobDefinitionsRequestOrderBy,
ListJobRunsRequestOrderBy,
CreateJobDefinitionRequest,
Expand Down Expand Up @@ -700,6 +701,7 @@ async def list_job_runs(
job_definition_id: Optional[str] = None,
project_id: Optional[str] = None,
organization_id: Optional[str] = None,
state: Optional[JobRunState] = None,
) -> ListJobRunsResponse:
"""
List all job runs with filters.
Expand All @@ -710,6 +712,7 @@ async def list_job_runs(
:param job_definition_id:
:param project_id:
:param organization_id:
:param state:
:return: :class:`ListJobRunsResponse <ListJobRunsResponse>`
Usage:
Expand All @@ -733,6 +736,7 @@ async def list_job_runs(
"page": page,
"page_size": page_size or self.client.default_page_size,
"project_id": project_id or self.client.default_project_id,
"state": state,
},
)

Expand All @@ -749,6 +753,7 @@ async def list_job_runs_all(
job_definition_id: Optional[str] = None,
project_id: Optional[str] = None,
organization_id: Optional[str] = None,
state: Optional[JobRunState] = None,
) -> List[JobRun]:
"""
List all job runs with filters.
Expand All @@ -759,6 +764,7 @@ async def list_job_runs_all(
:param job_definition_id:
:param project_id:
:param organization_id:
:param state:
:return: :class:`List[JobRun] <List[JobRun]>`
Usage:
Expand All @@ -779,6 +785,7 @@ async def list_job_runs_all(
"job_definition_id": job_definition_id,
"project_id": project_id,
"organization_id": organization_id,
"state": state,
},
)

Expand Down
2 changes: 2 additions & 0 deletions scaleway-async/scaleway_async/jobs/v1alpha1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,8 @@ class ListJobRunsRequest:

organization_id: Optional[str]

state: Optional[JobRunState]


@dataclass
class ListJobRunsResponse:
Expand Down
7 changes: 7 additions & 0 deletions scaleway/scaleway/jobs/v1alpha1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
fetch_all_pages,
)
from .types import (
JobRunState,
ListJobDefinitionsRequestOrderBy,
ListJobRunsRequestOrderBy,
CreateJobDefinitionRequest,
Expand Down Expand Up @@ -700,6 +701,7 @@ def list_job_runs(
job_definition_id: Optional[str] = None,
project_id: Optional[str] = None,
organization_id: Optional[str] = None,
state: Optional[JobRunState] = None,
) -> ListJobRunsResponse:
"""
List all job runs with filters.
Expand All @@ -710,6 +712,7 @@ def list_job_runs(
:param job_definition_id:
:param project_id:
:param organization_id:
:param state:
:return: :class:`ListJobRunsResponse <ListJobRunsResponse>`
Usage:
Expand All @@ -733,6 +736,7 @@ def list_job_runs(
"page": page,
"page_size": page_size or self.client.default_page_size,
"project_id": project_id or self.client.default_project_id,
"state": state,
},
)

Expand All @@ -749,6 +753,7 @@ def list_job_runs_all(
job_definition_id: Optional[str] = None,
project_id: Optional[str] = None,
organization_id: Optional[str] = None,
state: Optional[JobRunState] = None,
) -> List[JobRun]:
"""
List all job runs with filters.
Expand All @@ -759,6 +764,7 @@ def list_job_runs_all(
:param job_definition_id:
:param project_id:
:param organization_id:
:param state:
:return: :class:`List[JobRun] <List[JobRun]>`
Usage:
Expand All @@ -779,6 +785,7 @@ def list_job_runs_all(
"job_definition_id": job_definition_id,
"project_id": project_id,
"organization_id": organization_id,
"state": state,
},
)

Expand Down
2 changes: 2 additions & 0 deletions scaleway/scaleway/jobs/v1alpha1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,8 @@ class ListJobRunsRequest:

organization_id: Optional[str]

state: Optional[JobRunState]


@dataclass
class ListJobRunsResponse:
Expand Down

0 comments on commit 7004fcd

Please sign in to comment.