Skip to content
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

feat(cockpit): add update datasource method #590

Merged
merged 1 commit into from
Jul 8, 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
2 changes: 2 additions & 0 deletions scaleway-async/scaleway_async/cockpit/v1/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
from .types import RegionalApiListManagedAlertsRequest
from .types import RegionalApiListTokensRequest
from .types import RegionalApiTriggerTestAlertRequest
from .types import RegionalApiUpdateDataSourceRequest
from .types import UsageOverview
from .api import CockpitV1GlobalAPI
from .api import CockpitV1RegionalAPI
Expand Down Expand Up @@ -123,6 +124,7 @@
"RegionalApiListManagedAlertsRequest",
"RegionalApiListTokensRequest",
"RegionalApiTriggerTestAlertRequest",
"RegionalApiUpdateDataSourceRequest",
"UsageOverview",
"CockpitV1GlobalAPI",
"CockpitV1RegionalAPI",
Expand Down
46 changes: 46 additions & 0 deletions scaleway-async/scaleway_async/cockpit/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
RegionalApiEnableAlertManagerRequest,
RegionalApiEnableManagedAlertsRequest,
RegionalApiTriggerTestAlertRequest,
RegionalApiUpdateDataSourceRequest,
Token,
UsageOverview,
)
Expand Down Expand Up @@ -84,6 +85,7 @@
marshal_RegionalApiEnableAlertManagerRequest,
marshal_RegionalApiEnableManagedAlertsRequest,
marshal_RegionalApiTriggerTestAlertRequest,
marshal_RegionalApiUpdateDataSourceRequest,
)


Expand Down Expand Up @@ -784,6 +786,50 @@ async def list_data_sources_all(
},
)

async def update_data_source(
self,
*,
data_source_id: str,
region: Optional[Region] = None,
name: Optional[str] = None,
) -> DataSource:
"""
Update a data source.
Update a given data source name, specified by the data source ID.
:param data_source_id: ID of the data source to update.
:param region: Region to target. If none is passed will use default region from the config.
:param name: Updated name of the data source.
:return: :class:`DataSource <DataSource>`

Usage:
::

result = await api.update_data_source(
data_source_id="example",
)
"""

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

res = self._request(
"PATCH",
f"/cockpit/v1/regions/{param_region}/data-sources/{param_data_source_id}",
body=marshal_RegionalApiUpdateDataSourceRequest(
RegionalApiUpdateDataSourceRequest(
data_source_id=data_source_id,
region=region,
name=name,
),
self.client,
),
)

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

async def get_usage_overview(
self,
*,
Expand Down
13 changes: 13 additions & 0 deletions scaleway-async/scaleway_async/cockpit/v1/marshalling.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
RegionalApiEnableAlertManagerRequest,
RegionalApiEnableManagedAlertsRequest,
RegionalApiTriggerTestAlertRequest,
RegionalApiUpdateDataSourceRequest,
)


Expand Down Expand Up @@ -818,3 +819,15 @@ def marshal_RegionalApiTriggerTestAlertRequest(
output["project_id"] = request.project_id or defaults.default_project_id

return output


def marshal_RegionalApiUpdateDataSourceRequest(
request: RegionalApiUpdateDataSourceRequest,
defaults: ProfileDefaults,
) -> Dict[str, Any]:
output: Dict[str, Any] = {}

if request.name is not None:
output["name"] = request.name

return output
22 changes: 22 additions & 0 deletions scaleway-async/scaleway_async/cockpit/v1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -1196,6 +1196,28 @@ class RegionalApiTriggerTestAlertRequest:
"""


@dataclass
class RegionalApiUpdateDataSourceRequest:
"""
Update a data source name.
"""

data_source_id: str
"""
ID of the data source to update.
"""

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

name: Optional[str]
"""
Updated name of the data source.
"""


@dataclass
class UsageOverview:
scaleway_metrics_usage: Optional[Usage]
Expand Down
2 changes: 2 additions & 0 deletions scaleway/scaleway/cockpit/v1/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
from .types import RegionalApiListManagedAlertsRequest
from .types import RegionalApiListTokensRequest
from .types import RegionalApiTriggerTestAlertRequest
from .types import RegionalApiUpdateDataSourceRequest
from .types import UsageOverview
from .api import CockpitV1GlobalAPI
from .api import CockpitV1RegionalAPI
Expand Down Expand Up @@ -123,6 +124,7 @@
"RegionalApiListManagedAlertsRequest",
"RegionalApiListTokensRequest",
"RegionalApiTriggerTestAlertRequest",
"RegionalApiUpdateDataSourceRequest",
"UsageOverview",
"CockpitV1GlobalAPI",
"CockpitV1RegionalAPI",
Expand Down
46 changes: 46 additions & 0 deletions scaleway/scaleway/cockpit/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
RegionalApiEnableAlertManagerRequest,
RegionalApiEnableManagedAlertsRequest,
RegionalApiTriggerTestAlertRequest,
RegionalApiUpdateDataSourceRequest,
Token,
UsageOverview,
)
Expand Down Expand Up @@ -84,6 +85,7 @@
marshal_RegionalApiEnableAlertManagerRequest,
marshal_RegionalApiEnableManagedAlertsRequest,
marshal_RegionalApiTriggerTestAlertRequest,
marshal_RegionalApiUpdateDataSourceRequest,
)


Expand Down Expand Up @@ -784,6 +786,50 @@ def list_data_sources_all(
},
)

def update_data_source(
self,
*,
data_source_id: str,
region: Optional[Region] = None,
name: Optional[str] = None,
) -> DataSource:
"""
Update a data source.
Update a given data source name, specified by the data source ID.
:param data_source_id: ID of the data source to update.
:param region: Region to target. If none is passed will use default region from the config.
:param name: Updated name of the data source.
:return: :class:`DataSource <DataSource>`

Usage:
::

result = api.update_data_source(
data_source_id="example",
)
"""

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

res = self._request(
"PATCH",
f"/cockpit/v1/regions/{param_region}/data-sources/{param_data_source_id}",
body=marshal_RegionalApiUpdateDataSourceRequest(
RegionalApiUpdateDataSourceRequest(
data_source_id=data_source_id,
region=region,
name=name,
),
self.client,
),
)

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

def get_usage_overview(
self,
*,
Expand Down
13 changes: 13 additions & 0 deletions scaleway/scaleway/cockpit/v1/marshalling.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
RegionalApiEnableAlertManagerRequest,
RegionalApiEnableManagedAlertsRequest,
RegionalApiTriggerTestAlertRequest,
RegionalApiUpdateDataSourceRequest,
)


Expand Down Expand Up @@ -818,3 +819,15 @@ def marshal_RegionalApiTriggerTestAlertRequest(
output["project_id"] = request.project_id or defaults.default_project_id

return output


def marshal_RegionalApiUpdateDataSourceRequest(
request: RegionalApiUpdateDataSourceRequest,
defaults: ProfileDefaults,
) -> Dict[str, Any]:
output: Dict[str, Any] = {}

if request.name is not None:
output["name"] = request.name

return output
22 changes: 22 additions & 0 deletions scaleway/scaleway/cockpit/v1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -1196,6 +1196,28 @@ class RegionalApiTriggerTestAlertRequest:
"""


@dataclass
class RegionalApiUpdateDataSourceRequest:
"""
Update a data source name.
"""

data_source_id: str
"""
ID of the data source to update.
"""

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

name: Optional[str]
"""
Updated name of the data source.
"""


@dataclass
class UsageOverview:
scaleway_metrics_usage: Optional[Usage]
Expand Down