Skip to content

feat(serverless_jobs): add state filter to list job runs #834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 17, 2025
Merged

feat(serverless_jobs): add state filter to list job runs #834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions scaleway-async/scaleway_async/jobs/v1alpha1/api.py
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading