-
Notifications
You must be signed in to change notification settings - Fork 48
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
Add number_format to each formula in widget
#2413
Open
api-clients-generation-pipeline
wants to merge
1
commit into
master
Choose a base branch
from
datadog-api-spec/generated/3572
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| """ | ||
| Create a new dashboard with timeseries widget with custom_unit | ||
| """ | ||
|
|
||
| from datadog_api_client import ApiClient, Configuration | ||
| from datadog_api_client.v1.api.dashboards_api import DashboardsApi | ||
| from datadog_api_client.v1.model.dashboard import Dashboard | ||
| from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType | ||
| from datadog_api_client.v1.model.dashboard_reflow_type import DashboardReflowType | ||
| from datadog_api_client.v1.model.formula_and_function_metric_data_source import FormulaAndFunctionMetricDataSource | ||
| from datadog_api_client.v1.model.formula_and_function_metric_query_definition import ( | ||
| FormulaAndFunctionMetricQueryDefinition, | ||
| ) | ||
| from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat | ||
| from datadog_api_client.v1.model.number_format_unit_canonical import NumberFormatUnitCanonical | ||
| from datadog_api_client.v1.model.number_format_unit_scale import NumberFormatUnitScale | ||
| from datadog_api_client.v1.model.number_format_unit_scale_type import NumberFormatUnitScaleType | ||
| from datadog_api_client.v1.model.timeseries_widget_definition import TimeseriesWidgetDefinition | ||
| from datadog_api_client.v1.model.timeseries_widget_definition_type import TimeseriesWidgetDefinitionType | ||
| from datadog_api_client.v1.model.timeseries_widget_legend_layout import TimeseriesWidgetLegendLayout | ||
| from datadog_api_client.v1.model.timeseries_widget_request import TimeseriesWidgetRequest | ||
| from datadog_api_client.v1.model.widget import Widget | ||
| from datadog_api_client.v1.model.widget_display_type import WidgetDisplayType | ||
| from datadog_api_client.v1.model.widget_formula import WidgetFormula | ||
| from datadog_api_client.v1.model.widget_layout import WidgetLayout | ||
| from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan | ||
| from datadog_api_client.v1.model.widget_number_format import WidgetNumberFormat | ||
| from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign | ||
|
|
||
| body = Dashboard( | ||
| title="Example-Dashboard", | ||
| description="", | ||
| widgets=[ | ||
| Widget( | ||
| definition=TimeseriesWidgetDefinition( | ||
| title="", | ||
| title_size="16", | ||
| title_align=WidgetTextAlign.LEFT, | ||
| show_legend=True, | ||
| legend_layout=TimeseriesWidgetLegendLayout.AUTO, | ||
| time=WidgetLegacyLiveSpan(), | ||
| type=TimeseriesWidgetDefinitionType.TIMESERIES, | ||
| requests=[ | ||
| TimeseriesWidgetRequest( | ||
| formulas=[ | ||
| WidgetFormula( | ||
| formula="query1", | ||
| number_format=WidgetNumberFormat( | ||
| unit_scale=NumberFormatUnitScale( | ||
| type=NumberFormatUnitScaleType.CANONICAL_UNIT, | ||
| unit_name="apdex", | ||
| ), | ||
| unit=NumberFormatUnitCanonical( | ||
| type=NumberFormatUnitScaleType.CANONICAL_UNIT, | ||
| unit_name="fraction", | ||
| ), | ||
| ), | ||
| ), | ||
| ], | ||
| queries=[ | ||
| FormulaAndFunctionMetricQueryDefinition( | ||
| data_source=FormulaAndFunctionMetricDataSource.METRICS, | ||
| name="query1", | ||
| query="avg:system.cpu.user{*}", | ||
| ), | ||
| ], | ||
| response_format=FormulaAndFunctionResponseFormat.TIMESERIES, | ||
| display_type=WidgetDisplayType.LINE, | ||
| ), | ||
| ], | ||
| ), | ||
| layout=WidgetLayout( | ||
| x=0, | ||
| y=0, | ||
| width=12, | ||
| height=5, | ||
| ), | ||
| ), | ||
| ], | ||
| template_variables=[], | ||
| layout_type=DashboardLayoutType.ORDERED, | ||
| notify_list=[], | ||
| reflow_type=DashboardReflowType.FIXED, | ||
| ) | ||
|
|
||
| configuration = Configuration() | ||
| with ApiClient(configuration) as api_client: | ||
| api_instance = DashboardsApi(api_client) | ||
| response = api_instance.create_dashboard(body=body) | ||
|
|
||
| print(response) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. | ||
| # This product includes software developed at Datadog (https://www.datadoghq.com/). | ||
| # Copyright 2019-Present Datadog, Inc. | ||
| from __future__ import annotations | ||
|
|
||
|
|
||
| from datadog_api_client.model_utils import ( | ||
| ModelComposed, | ||
| cached_property, | ||
| ) | ||
|
|
||
|
|
||
| class NumberFormatUnit(ModelComposed): | ||
| def __init__(self, **kwargs): | ||
| """ | ||
| Number format unit. | ||
|
|
||
| :param per_unit_name: The name of the unit per item. | ||
| :type per_unit_name: str, optional | ||
|
|
||
| :param type: The type of unit scale. | ||
| :type type: NumberFormatUnitScaleType, optional | ||
|
|
||
| :param unit_name: The name of the unit. | ||
| :type unit_name: str, optional | ||
|
|
||
| :param label: The label for the custom unit. | ||
| :type label: str, optional | ||
| """ | ||
| super().__init__(kwargs) | ||
|
|
||
| @cached_property | ||
| def _composed_schemas(_): | ||
| # we need this here to make our import statements work | ||
| # we must store _composed_schemas in here so the code is only run | ||
| # when we invoke this method. If we kept this at the class | ||
| # level we would get an error because the class level | ||
| # code would be run when this module is imported, and these composed | ||
| # classes don't exist yet because their module has not finished | ||
| # loading | ||
| from datadog_api_client.v1.model.number_format_unit_canonical import NumberFormatUnitCanonical | ||
| from datadog_api_client.v1.model.number_format_unit_custom import NumberFormatUnitCustom | ||
|
|
||
| return { | ||
| "oneOf": [ | ||
| NumberFormatUnitCanonical, | ||
| NumberFormatUnitCustom, | ||
| ], | ||
| } |
62 changes: 62 additions & 0 deletions
62
src/datadog_api_client/v1/model/number_format_unit_canonical.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. | ||
| # This product includes software developed at Datadog (https://www.datadoghq.com/). | ||
| # Copyright 2019-Present Datadog, Inc. | ||
| from __future__ import annotations | ||
|
|
||
| from typing import Union, TYPE_CHECKING | ||
|
|
||
| from datadog_api_client.model_utils import ( | ||
| ModelNormal, | ||
| cached_property, | ||
| unset, | ||
| UnsetType, | ||
| ) | ||
|
|
||
|
|
||
| if TYPE_CHECKING: | ||
| from datadog_api_client.v1.model.number_format_unit_scale_type import NumberFormatUnitScaleType | ||
|
|
||
|
|
||
| class NumberFormatUnitCanonical(ModelNormal): | ||
| @cached_property | ||
| def openapi_types(_): | ||
| from datadog_api_client.v1.model.number_format_unit_scale_type import NumberFormatUnitScaleType | ||
|
|
||
| return { | ||
| "per_unit_name": (str,), | ||
| "type": (NumberFormatUnitScaleType,), | ||
| "unit_name": (str,), | ||
| } | ||
|
|
||
| attribute_map = { | ||
| "per_unit_name": "per_unit_name", | ||
| "type": "type", | ||
| "unit_name": "unit_name", | ||
| } | ||
|
|
||
| def __init__( | ||
| self_, | ||
| per_unit_name: Union[str, UnsetType] = unset, | ||
| type: Union[NumberFormatUnitScaleType, UnsetType] = unset, | ||
| unit_name: Union[str, UnsetType] = unset, | ||
| **kwargs, | ||
| ): | ||
| """ | ||
| Canonical unit. | ||
|
|
||
| :param per_unit_name: The name of the unit per item. | ||
| :type per_unit_name: str, optional | ||
|
|
||
| :param type: The type of unit scale. | ||
| :type type: NumberFormatUnitScaleType, optional | ||
|
|
||
| :param unit_name: The name of the unit. | ||
| :type unit_name: str, optional | ||
| """ | ||
| if per_unit_name is not unset: | ||
| kwargs["per_unit_name"] = per_unit_name | ||
| if type is not unset: | ||
| kwargs["type"] = type | ||
| if unit_name is not unset: | ||
| kwargs["unit_name"] = unit_name | ||
| super().__init__(kwargs) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔴 Code Quality Violation
first parameter of a class function should be self (...read more)
In a class method (that is not a class method nor a static method), the first argument must be
selfby convention.Learn More