Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat(serverless_jobs): add method to get jobs limits #713

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.

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
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions scaleway-async/scaleway_async/jobs/v1alpha1/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
from .types import GetJobDefinitionRequest
from .types import GetJobDefinitionSecretRequest
from .types import GetJobRunRequest
from .types import GetJobsLimitsRequest
from .types import JobsLimits
from .types import ListJobDefinitionSecretsRequest
from .types import ListJobDefinitionSecretsResponse
from .types import ListJobDefinitionsRequest
Expand Down Expand Up @@ -60,6 +62,8 @@
"GetJobDefinitionRequest",
"GetJobDefinitionSecretRequest",
"GetJobRunRequest",
"GetJobsLimitsRequest",
"JobsLimits",
"ListJobDefinitionSecretsRequest",
"ListJobDefinitionSecretsResponse",
"ListJobDefinitionsRequest",
Expand Down
30 changes: 30 additions & 0 deletions scaleway-async/scaleway_async/jobs/v1alpha1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
CreateJobDefinitionSecretsResponse,
JobDefinition,
JobRun,
JobsLimits,
ListJobDefinitionSecretsResponse,
ListJobDefinitionsResponse,
ListJobRunsResponse,
Expand All @@ -38,6 +39,7 @@
unmarshal_JobDefinition,
unmarshal_JobRun,
unmarshal_CreateJobDefinitionSecretsResponse,
unmarshal_JobsLimits,
unmarshal_ListJobDefinitionSecretsResponse,
unmarshal_ListJobDefinitionsResponse,
unmarshal_ListJobRunsResponse,
Expand Down Expand Up @@ -802,3 +804,31 @@ async def list_jobs_resources(

self._throw_on_error(res)
return unmarshal_ListJobsResourcesResponse(res.json())

async def get_jobs_limits(
self,
*,
region: Optional[Region] = None,
) -> JobsLimits:
"""
Get jobs limits for the console.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`JobsLimits <JobsLimits>`

Usage:
::

result = await api.get_jobs_limits()
"""

param_region = validate_path_param(
"region", region or self.client.default_region
)

res = self._request(
"GET",
f"/serverless-jobs/v1alpha1/regions/{param_region}/jobs-limits",
)

self._throw_on_error(res)
return unmarshal_JobsLimits(res.json())
16 changes: 16 additions & 0 deletions scaleway-async/scaleway_async/jobs/v1alpha1/marshalling.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
JobDefinition,
JobRun,
CreateJobDefinitionSecretsResponse,
JobsLimits,
ListJobDefinitionSecretsResponse,
ListJobDefinitionsResponse,
ListJobRunsResponse,
Expand Down Expand Up @@ -305,6 +306,21 @@ def unmarshal_CreateJobDefinitionSecretsResponse(
return CreateJobDefinitionSecretsResponse(**args)


def unmarshal_JobsLimits(data: Any) -> JobsLimits:
if not isinstance(data, dict):
raise TypeError(
"Unmarshalling the type 'JobsLimits' failed as data isn't a dictionary."
)

args: Dict[str, Any] = {}

field = data.get("secrets_per_job_definition", None)
if field is not None:
args["secrets_per_job_definition"] = field

return JobsLimits(**args)


def unmarshal_ListJobDefinitionSecretsResponse(
data: Any,
) -> ListJobDefinitionSecretsResponse:
Expand Down
13 changes: 13 additions & 0 deletions scaleway-async/scaleway_async/jobs/v1alpha1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,19 @@ class GetJobRunRequest:
"""


@dataclass
class GetJobsLimitsRequest:
region: Optional[Region]
"""
Region to target. If none is passed will use default region from the config.
"""


@dataclass
class JobsLimits:
secrets_per_job_definition: int


@dataclass
class ListJobDefinitionSecretsRequest:
job_definition_id: str
Expand Down
4 changes: 4 additions & 0 deletions scaleway/scaleway/jobs/v1alpha1/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
from .types import GetJobDefinitionRequest
from .types import GetJobDefinitionSecretRequest
from .types import GetJobRunRequest
from .types import GetJobsLimitsRequest
from .types import JobsLimits
from .types import ListJobDefinitionSecretsRequest
from .types import ListJobDefinitionSecretsResponse
from .types import ListJobDefinitionsRequest
Expand Down Expand Up @@ -60,6 +62,8 @@
"GetJobDefinitionRequest",
"GetJobDefinitionSecretRequest",
"GetJobRunRequest",
"GetJobsLimitsRequest",
"JobsLimits",
"ListJobDefinitionSecretsRequest",
"ListJobDefinitionSecretsResponse",
"ListJobDefinitionsRequest",
Expand Down
30 changes: 30 additions & 0 deletions scaleway/scaleway/jobs/v1alpha1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
CreateJobDefinitionSecretsResponse,
JobDefinition,
JobRun,
JobsLimits,
ListJobDefinitionSecretsResponse,
ListJobDefinitionsResponse,
ListJobRunsResponse,
Expand All @@ -38,6 +39,7 @@
unmarshal_JobDefinition,
unmarshal_JobRun,
unmarshal_CreateJobDefinitionSecretsResponse,
unmarshal_JobsLimits,
unmarshal_ListJobDefinitionSecretsResponse,
unmarshal_ListJobDefinitionsResponse,
unmarshal_ListJobRunsResponse,
Expand Down Expand Up @@ -802,3 +804,31 @@ def list_jobs_resources(

self._throw_on_error(res)
return unmarshal_ListJobsResourcesResponse(res.json())

def get_jobs_limits(
self,
*,
region: Optional[Region] = None,
) -> JobsLimits:
"""
Get jobs limits for the console.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`JobsLimits <JobsLimits>`

Usage:
::

result = api.get_jobs_limits()
"""

param_region = validate_path_param(
"region", region or self.client.default_region
)

res = self._request(
"GET",
f"/serverless-jobs/v1alpha1/regions/{param_region}/jobs-limits",
)

self._throw_on_error(res)
return unmarshal_JobsLimits(res.json())
16 changes: 16 additions & 0 deletions scaleway/scaleway/jobs/v1alpha1/marshalling.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
JobDefinition,
JobRun,
CreateJobDefinitionSecretsResponse,
JobsLimits,
ListJobDefinitionSecretsResponse,
ListJobDefinitionsResponse,
ListJobRunsResponse,
Expand Down Expand Up @@ -305,6 +306,21 @@ def unmarshal_CreateJobDefinitionSecretsResponse(
return CreateJobDefinitionSecretsResponse(**args)


def unmarshal_JobsLimits(data: Any) -> JobsLimits:
if not isinstance(data, dict):
raise TypeError(
"Unmarshalling the type 'JobsLimits' failed as data isn't a dictionary."
)

args: Dict[str, Any] = {}

field = data.get("secrets_per_job_definition", None)
if field is not None:
args["secrets_per_job_definition"] = field

return JobsLimits(**args)


def unmarshal_ListJobDefinitionSecretsResponse(
data: Any,
) -> ListJobDefinitionSecretsResponse:
Expand Down
13 changes: 13 additions & 0 deletions scaleway/scaleway/jobs/v1alpha1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,19 @@ class GetJobRunRequest:
"""


@dataclass
class GetJobsLimitsRequest:
region: Optional[Region]
"""
Region to target. If none is passed will use default region from the config.
"""


@dataclass
class JobsLimits:
secrets_per_job_definition: int


@dataclass
class ListJobDefinitionSecretsRequest:
job_definition_id: str
Expand Down