diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index a38d274f9b..aa8e993704 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -19247,6 +19247,23 @@ components: x-enum-varnames: - BARS - AREA + TimeseriesRequestStyle: + description: Define request widget style for timeseries widgets. + properties: + has_value_labels: + description: If true, the value is displayed as a label relative to the + data point. + type: boolean + line_type: + $ref: '#/components/schemas/WidgetLineType' + line_width: + $ref: '#/components/schemas/WidgetLineWidth' + order_by: + $ref: '#/components/schemas/WidgetStyleOrderBy' + palette: + description: Color palette to apply to the widget. + type: string + type: object TimeseriesWidgetDefinition: description: The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. @@ -19401,7 +19418,7 @@ components: security_query: $ref: '#/components/schemas/LogQueryDefinition' style: - $ref: '#/components/schemas/WidgetRequestStyle' + $ref: '#/components/schemas/TimeseriesRequestStyle' type: object ToplistWidgetDefinition: description: The top list visualization enables you to display a list of Tag diff --git a/docs/datadog_api_client.v1.model.rst b/docs/datadog_api_client.v1.model.rst index 11d7ba1320..d049299b95 100644 --- a/docs/datadog_api_client.v1.model.rst +++ b/docs/datadog_api_client.v1.model.rst @@ -5611,6 +5611,13 @@ datadog\_api\_client.v1.model.timeseries\_background\_type module :members: :show-inheritance: +datadog\_api\_client.v1.model.timeseries\_request\_style module +--------------------------------------------------------------- + +.. automodule:: datadog_api_client.v1.model.timeseries_request_style + :members: + :show-inheritance: + datadog\_api\_client.v1.model.timeseries\_widget\_definition module ------------------------------------------------------------------- diff --git a/examples/v1/dashboards/CreateDashboard_1259346254.py b/examples/v1/dashboards/CreateDashboard_1259346254.py index 24db4f984c..58fac2a4d9 100644 --- a/examples/v1/dashboards/CreateDashboard_1259346254.py +++ b/examples/v1/dashboards/CreateDashboard_1259346254.py @@ -6,12 +6,12 @@ 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.timeseries_request_style import TimeseriesRequestStyle 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_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_request_style import WidgetRequestStyle from datadog_api_client.v1.model.widget_style_order_by import WidgetStyleOrderBy body = Dashboard( @@ -24,7 +24,7 @@ requests=[ TimeseriesWidgetRequest( q="avg:system.cpu.user{*} by {host}", - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="warm", order_by=WidgetStyleOrderBy.VALUES, ), diff --git a/examples/v1/dashboards/CreateDashboard_1284514532.py b/examples/v1/dashboards/CreateDashboard_1284514532.py index 9604e504b5..4bb1b53ff0 100644 --- a/examples/v1/dashboards/CreateDashboard_1284514532.py +++ b/examples/v1/dashboards/CreateDashboard_1284514532.py @@ -13,6 +13,7 @@ FormulaAndFunctionCloudCostQueryDefinition, ) from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_request import TimeseriesWidgetRequest @@ -23,7 +24,6 @@ from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth from datadog_api_client.v1.model.widget_live_span import WidgetLiveSpan -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign body = Dashboard( @@ -50,7 +50,7 @@ ), ], response_format=FormulaAndFunctionResponseFormat.TIMESERIES, - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_1307120899.py b/examples/v1/dashboards/CreateDashboard_1307120899.py index 3fbbef0b5f..0d53c6619a 100644 --- a/examples/v1/dashboards/CreateDashboard_1307120899.py +++ b/examples/v1/dashboards/CreateDashboard_1307120899.py @@ -19,6 +19,7 @@ ) from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_column import TimeseriesWidgetLegendColumn @@ -30,7 +31,6 @@ from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle body = Dashboard( title="Example-Dashboard with ci_tests datasource", @@ -73,7 +73,7 @@ ), ], response_format=FormulaAndFunctionResponseFormat.TIMESERIES, - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_1433408735.py b/examples/v1/dashboards/CreateDashboard_1433408735.py index f33752ff1d..fe68304f5a 100644 --- a/examples/v1/dashboards/CreateDashboard_1433408735.py +++ b/examples/v1/dashboards/CreateDashboard_1433408735.py @@ -13,6 +13,7 @@ FormulaAndFunctionCloudCostQueryDefinition, ) from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_request import TimeseriesWidgetRequest @@ -22,7 +23,6 @@ from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign body = Dashboard( @@ -49,7 +49,7 @@ ), ], response_format=FormulaAndFunctionResponseFormat.TIMESERIES, - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_2261785072.py b/examples/v1/dashboards/CreateDashboard_2261785072.py index a599a60ac0..be3100934f 100644 --- a/examples/v1/dashboards/CreateDashboard_2261785072.py +++ b/examples/v1/dashboards/CreateDashboard_2261785072.py @@ -11,6 +11,7 @@ FormulaAndFunctionMetricQueryDefinition, ) from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_request import TimeseriesWidgetRequest @@ -18,7 +19,6 @@ from datadog_api_client.v1.model.widget_display_type import WidgetDisplayType from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle body = Dashboard( layout_type=DashboardLayoutType.ORDERED, @@ -49,7 +49,7 @@ query="avg:system.cpu.user{*}", ), ], - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="purple", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_2278756614.py b/examples/v1/dashboards/CreateDashboard_2278756614.py index f28a5e70fe..34d439a5ee 100644 --- a/examples/v1/dashboards/CreateDashboard_2278756614.py +++ b/examples/v1/dashboards/CreateDashboard_2278756614.py @@ -19,6 +19,7 @@ from datadog_api_client.v1.model.split_graph_widget_definition_type import SplitGraphWidgetDefinitionType from datadog_api_client.v1.model.split_sort import SplitSort from datadog_api_client.v1.model.split_vector_entry_item import SplitVectorEntryItem +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_request import TimeseriesWidgetRequest @@ -27,7 +28,6 @@ from datadog_api_client.v1.model.widget_layout import WidgetLayout from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle from datadog_api_client.v1.model.widget_sort import WidgetSort from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign @@ -60,7 +60,7 @@ query="avg:system.cpu.user{*}", ), ], - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_2800096921.py b/examples/v1/dashboards/CreateDashboard_2800096921.py index cb085e56a0..fb3339bf60 100644 --- a/examples/v1/dashboards/CreateDashboard_2800096921.py +++ b/examples/v1/dashboards/CreateDashboard_2800096921.py @@ -19,6 +19,7 @@ ) from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_column import TimeseriesWidgetLegendColumn @@ -30,7 +31,6 @@ from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle body = Dashboard( title="Example-Dashboard with ci_pipelines datasource", @@ -74,7 +74,7 @@ ), ], response_format=FormulaAndFunctionResponseFormat.TIMESERIES, - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_3066042014.py b/examples/v1/dashboards/CreateDashboard_3066042014.py index b449de3fd3..870c4c3bec 100644 --- a/examples/v1/dashboards/CreateDashboard_3066042014.py +++ b/examples/v1/dashboards/CreateDashboard_3066042014.py @@ -19,6 +19,7 @@ ) from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_column import TimeseriesWidgetLegendColumn @@ -32,7 +33,6 @@ from datadog_api_client.v1.model.widget_live_span_unit import WidgetLiveSpanUnit from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan from datadog_api_client.v1.model.widget_new_live_span_type import WidgetNewLiveSpanType -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle body = Dashboard( title="Example-Dashboard with new live span time", @@ -81,7 +81,7 @@ ), ], response_format=FormulaAndFunctionResponseFormat.TIMESERIES, - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_3451918078.py b/examples/v1/dashboards/CreateDashboard_3451918078.py index c7f4336650..8b153a7964 100644 --- a/examples/v1/dashboards/CreateDashboard_3451918078.py +++ b/examples/v1/dashboards/CreateDashboard_3451918078.py @@ -19,6 +19,7 @@ ) from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_column import TimeseriesWidgetLegendColumn @@ -31,7 +32,6 @@ from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan from datadog_api_client.v1.model.widget_new_fixed_span_type import WidgetNewFixedSpanType -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle body = Dashboard( title="Example-Dashboard with new fixed span time", @@ -80,7 +80,7 @@ ), ], response_format=FormulaAndFunctionResponseFormat.TIMESERIES, - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_3631423980.py b/examples/v1/dashboards/CreateDashboard_3631423980.py index 59b1b74705..8884a49d00 100644 --- a/examples/v1/dashboards/CreateDashboard_3631423980.py +++ b/examples/v1/dashboards/CreateDashboard_3631423980.py @@ -6,6 +6,7 @@ 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.timeseries_request_style import TimeseriesRequestStyle 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_request import TimeseriesWidgetRequest @@ -13,7 +14,6 @@ from datadog_api_client.v1.model.widget_display_type import WidgetDisplayType from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle body = Dashboard( layout_type=DashboardLayoutType.ORDERED, @@ -25,7 +25,7 @@ requests=[ TimeseriesWidgetRequest( q="avg:system.cpu.user{*} by {host}", - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_3982498788.py b/examples/v1/dashboards/CreateDashboard_3982498788.py index 2df52fd441..a34c2e40ae 100644 --- a/examples/v1/dashboards/CreateDashboard_3982498788.py +++ b/examples/v1/dashboards/CreateDashboard_3982498788.py @@ -6,6 +6,7 @@ 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.timeseries_request_style import TimeseriesRequestStyle 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_request import TimeseriesWidgetRequest @@ -13,7 +14,6 @@ from datadog_api_client.v1.model.widget_display_type import WidgetDisplayType from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle body = Dashboard( layout_type=DashboardLayoutType.ORDERED, @@ -26,7 +26,7 @@ TimeseriesWidgetRequest( q="sum:trace.test.errors{env:prod,service:datadog-api-spec} by {resource_name}.as_count()", on_right_yaxis=False, - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="warm", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_41622531.py b/examples/v1/dashboards/CreateDashboard_41622531.py index 1a7465ee80..f946b29db9 100644 --- a/examples/v1/dashboards/CreateDashboard_41622531.py +++ b/examples/v1/dashboards/CreateDashboard_41622531.py @@ -12,6 +12,7 @@ FormulaAndFunctionMetricQueryDefinition, ) from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_column import TimeseriesWidgetLegendColumn @@ -24,7 +25,6 @@ from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle body = Dashboard( title="Example-Dashboard with formula style", @@ -62,7 +62,7 @@ ), ], response_format=FormulaAndFunctionResponseFormat.TIMESERIES, - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_416487533.py b/examples/v1/dashboards/CreateDashboard_416487533.py index e97c037066..07d234bc82 100644 --- a/examples/v1/dashboards/CreateDashboard_416487533.py +++ b/examples/v1/dashboards/CreateDashboard_416487533.py @@ -6,12 +6,12 @@ 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.timeseries_request_style import TimeseriesRequestStyle 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_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_request_style import WidgetRequestStyle from datadog_api_client.v1.model.widget_style_order_by import WidgetStyleOrderBy body = Dashboard( @@ -24,7 +24,7 @@ requests=[ TimeseriesWidgetRequest( q="avg:system.cpu.user{*} by {host}", - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", order_by=WidgetStyleOrderBy.TAGS, ), diff --git a/examples/v1/dashboards/CreateDashboard_4262729673.py b/examples/v1/dashboards/CreateDashboard_4262729673.py index 70ea0a7ae5..84c7fa296c 100644 --- a/examples/v1/dashboards/CreateDashboard_4262729673.py +++ b/examples/v1/dashboards/CreateDashboard_4262729673.py @@ -19,6 +19,7 @@ ) from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_column import TimeseriesWidgetLegendColumn @@ -31,7 +32,6 @@ from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth from datadog_api_client.v1.model.widget_live_span import WidgetLiveSpan -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle body = Dashboard( title="Example-Dashboard with legacy live span time", @@ -78,7 +78,7 @@ ), ], response_format=FormulaAndFunctionResponseFormat.TIMESERIES, - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_607525069.py b/examples/v1/dashboards/CreateDashboard_607525069.py index 09e52f09dd..3740ce4fe3 100644 --- a/examples/v1/dashboards/CreateDashboard_607525069.py +++ b/examples/v1/dashboards/CreateDashboard_607525069.py @@ -19,6 +19,7 @@ ) from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_column import TimeseriesWidgetLegendColumn @@ -30,7 +31,6 @@ from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle body = Dashboard( title="Example-Dashboard with product_analytics datasource", @@ -73,7 +73,7 @@ ), ], response_format=FormulaAndFunctionResponseFormat.TIMESERIES, - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/dashboards/CreateDashboard_985012506.py b/examples/v1/dashboards/CreateDashboard_985012506.py index ce78c7685c..8a180f59e1 100644 --- a/examples/v1/dashboards/CreateDashboard_985012506.py +++ b/examples/v1/dashboards/CreateDashboard_985012506.py @@ -19,6 +19,7 @@ ) from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_column import TimeseriesWidgetLegendColumn @@ -30,7 +31,6 @@ from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle body = Dashboard( title="Example-Dashboard with incident_analytics datasource", @@ -73,7 +73,7 @@ ), ], response_format=FormulaAndFunctionResponseFormat.TIMESERIES, - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, diff --git a/examples/v1/notebooks/CreateNotebook.py b/examples/v1/notebooks/CreateNotebook.py index d21720995e..aa1b8b5f0b 100644 --- a/examples/v1/notebooks/CreateNotebook.py +++ b/examples/v1/notebooks/CreateNotebook.py @@ -18,6 +18,7 @@ from datadog_api_client.v1.model.notebook_split_by import NotebookSplitBy from datadog_api_client.v1.model.notebook_status import NotebookStatus from datadog_api_client.v1.model.notebook_timeseries_cell_attributes import NotebookTimeseriesCellAttributes +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_request import TimeseriesWidgetRequest @@ -26,7 +27,6 @@ from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth from datadog_api_client.v1.model.widget_live_span import WidgetLiveSpan -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle body = NotebookCreateRequest( data=NotebookCreateData( @@ -48,7 +48,7 @@ TimeseriesWidgetRequest( display_type=WidgetDisplayType.LINE, q="avg:system.load.1{*}", - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, palette="dog_classic", diff --git a/examples/v1/notebooks/UpdateNotebook.py b/examples/v1/notebooks/UpdateNotebook.py index c38d25748c..faa47c6b70 100644 --- a/examples/v1/notebooks/UpdateNotebook.py +++ b/examples/v1/notebooks/UpdateNotebook.py @@ -19,6 +19,7 @@ from datadog_api_client.v1.model.notebook_update_data import NotebookUpdateData from datadog_api_client.v1.model.notebook_update_data_attributes import NotebookUpdateDataAttributes from datadog_api_client.v1.model.notebook_update_request import NotebookUpdateRequest +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_request import TimeseriesWidgetRequest @@ -27,7 +28,6 @@ from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth from datadog_api_client.v1.model.widget_live_span import WidgetLiveSpan -from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle # there is a valid "notebook" in the system NOTEBOOK_DATA_ID = environ["NOTEBOOK_DATA_ID"] @@ -52,7 +52,7 @@ TimeseriesWidgetRequest( display_type=WidgetDisplayType.LINE, q="avg:system.load.1{*}", - style=WidgetRequestStyle( + style=TimeseriesRequestStyle( line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, palette="dog_classic", diff --git a/src/datadog_api_client/v1/model/timeseries_request_style.py b/src/datadog_api_client/v1/model/timeseries_request_style.py new file mode 100644 index 0000000000..39c574484c --- /dev/null +++ b/src/datadog_api_client/v1/model/timeseries_request_style.py @@ -0,0 +1,85 @@ +# 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.widget_line_type import WidgetLineType + from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth + from datadog_api_client.v1.model.widget_style_order_by import WidgetStyleOrderBy + + +class TimeseriesRequestStyle(ModelNormal): + @cached_property + def openapi_types(_): + from datadog_api_client.v1.model.widget_line_type import WidgetLineType + from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth + from datadog_api_client.v1.model.widget_style_order_by import WidgetStyleOrderBy + + return { + "has_value_labels": (bool,), + "line_type": (WidgetLineType,), + "line_width": (WidgetLineWidth,), + "order_by": (WidgetStyleOrderBy,), + "palette": (str,), + } + + attribute_map = { + "has_value_labels": "has_value_labels", + "line_type": "line_type", + "line_width": "line_width", + "order_by": "order_by", + "palette": "palette", + } + + def __init__( + self_, + has_value_labels: Union[bool, UnsetType] = unset, + line_type: Union[WidgetLineType, UnsetType] = unset, + line_width: Union[WidgetLineWidth, UnsetType] = unset, + order_by: Union[WidgetStyleOrderBy, UnsetType] = unset, + palette: Union[str, UnsetType] = unset, + **kwargs, + ): + """ + Define request widget style for timeseries widgets. + + :param has_value_labels: If true, the value is displayed as a label relative to the data point. + :type has_value_labels: bool, optional + + :param line_type: Type of lines displayed. + :type line_type: WidgetLineType, optional + + :param line_width: Width of line displayed. + :type line_width: WidgetLineWidth, optional + + :param order_by: How to order series in timeseries visualizations. + + * ``tags`` : Order series alphabetically by tag name (default behavior) + * ``values`` : Order series by their current metric values (typically descending) + :type order_by: WidgetStyleOrderBy, optional + + :param palette: Color palette to apply to the widget. + :type palette: str, optional + """ + if has_value_labels is not unset: + kwargs["has_value_labels"] = has_value_labels + if line_type is not unset: + kwargs["line_type"] = line_type + if line_width is not unset: + kwargs["line_width"] = line_width + if order_by is not unset: + kwargs["order_by"] = order_by + if palette is not unset: + kwargs["palette"] = palette + super().__init__(kwargs) diff --git a/src/datadog_api_client/v1/model/timeseries_widget_request.py b/src/datadog_api_client/v1/model/timeseries_widget_request.py index 61030b2eaa..2b65e337cd 100644 --- a/src/datadog_api_client/v1/model/timeseries_widget_request.py +++ b/src/datadog_api_client/v1/model/timeseries_widget_request.py @@ -21,7 +21,7 @@ from datadog_api_client.v1.model.process_query_definition import ProcessQueryDefinition from datadog_api_client.v1.model.formula_and_function_query_definition import FormulaAndFunctionQueryDefinition from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat - from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle + from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle from datadog_api_client.v1.model.formula_and_function_metric_query_definition import ( FormulaAndFunctionMetricQueryDefinition, ) @@ -55,7 +55,7 @@ def openapi_types(_): from datadog_api_client.v1.model.process_query_definition import ProcessQueryDefinition from datadog_api_client.v1.model.formula_and_function_query_definition import FormulaAndFunctionQueryDefinition from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat - from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle + from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle return { "apm_query": (LogQueryDefinition,), @@ -74,7 +74,7 @@ def openapi_types(_): "response_format": (FormulaAndFunctionResponseFormat,), "rum_query": (LogQueryDefinition,), "security_query": (LogQueryDefinition,), - "style": (WidgetRequestStyle,), + "style": (TimeseriesRequestStyle,), } attribute_map = { @@ -129,7 +129,7 @@ def __init__( response_format: Union[FormulaAndFunctionResponseFormat, UnsetType] = unset, rum_query: Union[LogQueryDefinition, UnsetType] = unset, security_query: Union[LogQueryDefinition, UnsetType] = unset, - style: Union[WidgetRequestStyle, UnsetType] = unset, + style: Union[TimeseriesRequestStyle, UnsetType] = unset, **kwargs, ): """ @@ -183,8 +183,8 @@ def __init__( :param security_query: The log query. :type security_query: LogQueryDefinition, optional - :param style: Define request widget style. - :type style: WidgetRequestStyle, optional + :param style: Define request widget style for timeseries widgets. + :type style: TimeseriesRequestStyle, optional """ if apm_query is not unset: kwargs["apm_query"] = apm_query diff --git a/src/datadog_api_client/v1/models/__init__.py b/src/datadog_api_client/v1/models/__init__.py index 43893fead5..8da99a0f38 100644 --- a/src/datadog_api_client/v1/models/__init__.py +++ b/src/datadog_api_client/v1/models/__init__.py @@ -948,6 +948,7 @@ from datadog_api_client.v1.model.target_format_type import TargetFormatType from datadog_api_client.v1.model.timeseries_background import TimeseriesBackground from datadog_api_client.v1.model.timeseries_background_type import TimeseriesBackgroundType +from datadog_api_client.v1.model.timeseries_request_style import TimeseriesRequestStyle 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_expression_alias import TimeseriesWidgetExpressionAlias @@ -1951,6 +1952,7 @@ "TargetFormatType", "TimeseriesBackground", "TimeseriesBackgroundType", + "TimeseriesRequestStyle", "TimeseriesWidgetDefinition", "TimeseriesWidgetDefinitionType", "TimeseriesWidgetExpressionAlias",