Add cloud_cost data source and query definition to dashboards (#1569)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-07-11 14:36:55.813150",
-            "spec_repo_commit": "7ca677d6"
+            "regenerated": "2023-07-11 16:39:33.303769",
+            "spec_repo_commit": "824086bb"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-07-11 14:36:55.830224",
-            "spec_repo_commit": "7ca677d6"
+            "regenerated": "2023-07-11 16:39:33.412435",
+            "spec_repo_commit": "824086bb"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -2466,6 +2466,38 @@ components:
       - service
       - stat
       type: object
+    FormulaAndFunctionCloudCostDataSource:
+      description: Data source for Cloud Cost queries.
+      enum:
+      - cloud_cost
+      example: cloud_cost
+      type: string
+      x-enum-varnames:
+      - CLOUD_COST
+    FormulaAndFunctionCloudCostQueryDefinition:
+      description: A formula and functions Cloud Cost query.
+      example:
+        data_source: cloud_cost
+        name: query1
+        query: sum:aws.cost.amortized{*}
+      properties:
+        aggregator:
+          $ref: '#/components/schemas/WidgetAggregator'
+        data_source:
+          $ref: '#/components/schemas/FormulaAndFunctionCloudCostDataSource'
+        name:
+          description: Name of the query for use in formulas.
+          example: my_query
+          type: string
+        query:
+          description: Query for Cloud Cost data.
+          example: ''
+          type: string
+      required:
+      - data_source
+      - query
+      - name
+      type: object
     FormulaAndFunctionEventAggregation:
       description: Aggregation methods for event platform queries.
       enum:
@@ -2729,6 +2761,7 @@ components:
       - $ref: '#/components/schemas/FormulaAndFunctionApmDependencyStatsQueryDefinition'
       - $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition'
       - $ref: '#/components/schemas/FormulaAndFunctionSLOQueryDefinition'
+      - $ref: '#/components/schemas/FormulaAndFunctionCloudCostQueryDefinition'
       type: object
     FormulaAndFunctionResponseFormat:
       description: Timeseries, scalar, or event list response. Event list response

docs/datadog_api_client.v1.model.rst

@@ -750,6 +750,20 @@ formula\_and\_function\_apm\_resource\_stats\_query\_definition
    :members:
    :show-inheritance:
 
+formula\_and\_function\_cloud\_cost\_data\_source
+-------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.formula_and_function_cloud_cost_data_source
+   :members:
+   :show-inheritance:
+
+formula\_and\_function\_cloud\_cost\_query\_definition
+------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.formula_and_function_cloud_cost_query_definition
+   :members:
+   :show-inheritance:
+
 formula\_and\_function\_event\_aggregation
 ------------------------------------------
 

examples/v1/dashboards/CreateDashboard_1284514532.py

@@ -0,0 +1,70 @@
+"""
+Create a new dashboard with a timeseries widget using formulas and functions cloud cost query
+"""
+
+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.formula_and_function_cloud_cost_data_source import (
+    FormulaAndFunctionCloudCostDataSource,
+)
+from datadog_api_client.v1.model.formula_and_function_cloud_cost_query_definition import (
+    FormulaAndFunctionCloudCostQueryDefinition,
+)
+from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
+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_formula import WidgetFormula
+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(
+    title="Example-Dashboard",
+    widgets=[
+        Widget(
+            definition=TimeseriesWidgetDefinition(
+                title="Example Cloud Cost Query",
+                title_size="16",
+                title_align=WidgetTextAlign.LEFT,
+                type=TimeseriesWidgetDefinitionType.TIMESERIES,
+                requests=[
+                    TimeseriesWidgetRequest(
+                        formulas=[
+                            WidgetFormula(
+                                formula="query1",
+                            ),
+                        ],
+                        queries=[
+                            FormulaAndFunctionCloudCostQueryDefinition(
+                                data_source=FormulaAndFunctionCloudCostDataSource.CLOUD_COST,
+                                name="query1",
+                                query="sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)",
+                            ),
+                        ],
+                        response_format=FormulaAndFunctionResponseFormat.TIMESERIES,
+                        style=WidgetRequestStyle(
+                            palette="dog_classic",
+                            line_type=WidgetLineType.SOLID,
+                            line_width=WidgetLineWidth.NORMAL,
+                        ),
+                        display_type=WidgetDisplayType.BARS,
+                    ),
+                ],
+            ),
+        ),
+    ],
+    layout_type=DashboardLayoutType.ORDERED,
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = DashboardsApi(api_client)
+    response = api_instance.create_dashboard(body=body)
+
+    print(response)

src/datadog_api_client/v1/model/change_widget_request.py

@@ -41,6 +41,9 @@
     from datadog_api_client.v1.model.formula_and_function_slo_query_definition import (
         FormulaAndFunctionSLOQueryDefinition,
     )
+    from datadog_api_client.v1.model.formula_and_function_cloud_cost_query_definition import (
+        FormulaAndFunctionCloudCostQueryDefinition,
+    )
 
 
 class ChangeWidgetRequest(ModelNormal):
@@ -123,6 +126,7 @@ def __init__(
                     FormulaAndFunctionApmDependencyStatsQueryDefinition,
                     FormulaAndFunctionApmResourceStatsQueryDefinition,
                     FormulaAndFunctionSLOQueryDefinition,
+                    FormulaAndFunctionCloudCostQueryDefinition,
                 ]
             ],
             UnsetType,

src/datadog_api_client/v1/model/formula_and_function_cloud_cost_data_source.py

@@ -0,0 +1,35 @@
+# 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 (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class FormulaAndFunctionCloudCostDataSource(ModelSimple):
+    """
+    Data source for Cloud Cost queries.
+
+    :param value: If omitted defaults to "cloud_cost". Must be one of ["cloud_cost"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "cloud_cost",
+    }
+    CLOUD_COST: ClassVar["FormulaAndFunctionCloudCostDataSource"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+FormulaAndFunctionCloudCostDataSource.CLOUD_COST = FormulaAndFunctionCloudCostDataSource("cloud_cost")

src/datadog_api_client/v1/model/formula_and_function_cloud_cost_query_definition.py

@@ -0,0 +1,74 @@
+# 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_aggregator import WidgetAggregator
+    from datadog_api_client.v1.model.formula_and_function_cloud_cost_data_source import (
+        FormulaAndFunctionCloudCostDataSource,
+    )
+
+
+class FormulaAndFunctionCloudCostQueryDefinition(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v1.model.widget_aggregator import WidgetAggregator
+        from datadog_api_client.v1.model.formula_and_function_cloud_cost_data_source import (
+            FormulaAndFunctionCloudCostDataSource,
+        )
+
+        return {
+            "aggregator": (WidgetAggregator,),
+            "data_source": (FormulaAndFunctionCloudCostDataSource,),
+            "name": (str,),
+            "query": (str,),
+        }
+
+    attribute_map = {
+        "aggregator": "aggregator",
+        "data_source": "data_source",
+        "name": "name",
+        "query": "query",
+    }
+
+    def __init__(
+        self_,
+        data_source: FormulaAndFunctionCloudCostDataSource,
+        name: str,
+        query: str,
+        aggregator: Union[WidgetAggregator, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        A formula and functions Cloud Cost query.
+
+        :param aggregator: Aggregator used for the request.
+        :type aggregator: WidgetAggregator, optional
+
+        :param data_source: Data source for Cloud Cost queries.
+        :type data_source: FormulaAndFunctionCloudCostDataSource
+
+        :param name: Name of the query for use in formulas.
+        :type name: str
+
+        :param query: Query for Cloud Cost data.
+        :type query: str
+        """
+        if aggregator is not unset:
+            kwargs["aggregator"] = aggregator
+        super().__init__(kwargs)
+
+        self_.data_source = data_source
+        self_.name = name
+        self_.query = query

src/datadog_api_client/v1/model/formula_and_function_query_definition.py

@@ -128,6 +128,9 @@ def _composed_schemas(_):
         from datadog_api_client.v1.model.formula_and_function_slo_query_definition import (
             FormulaAndFunctionSLOQueryDefinition,
         )
+        from datadog_api_client.v1.model.formula_and_function_cloud_cost_query_definition import (
+            FormulaAndFunctionCloudCostQueryDefinition,
+        )
 
         return {
             "oneOf": [
@@ -137,5 +140,6 @@ def _composed_schemas(_):
                 FormulaAndFunctionApmDependencyStatsQueryDefinition,
                 FormulaAndFunctionApmResourceStatsQueryDefinition,
                 FormulaAndFunctionSLOQueryDefinition,
+                FormulaAndFunctionCloudCostQueryDefinition,
             ],
         }

src/datadog_api_client/v1/model/geomap_widget_request.py

@@ -38,6 +38,9 @@
     from datadog_api_client.v1.model.formula_and_function_slo_query_definition import (
         FormulaAndFunctionSLOQueryDefinition,
     )
+    from datadog_api_client.v1.model.formula_and_function_cloud_cost_query_definition import (
+        FormulaAndFunctionCloudCostQueryDefinition,
+    )
 
 
 class GeomapWidgetRequest(ModelNormal):
@@ -90,6 +93,7 @@ def __init__(
                     FormulaAndFunctionApmDependencyStatsQueryDefinition,
                     FormulaAndFunctionApmResourceStatsQueryDefinition,
                     FormulaAndFunctionSLOQueryDefinition,
+                    FormulaAndFunctionCloudCostQueryDefinition,
                 ]
             ],
             UnsetType,

src/datadog_api_client/v1/model/query_value_widget_request.py

@@ -39,6 +39,9 @@
     from datadog_api_client.v1.model.formula_and_function_slo_query_definition import (
         FormulaAndFunctionSLOQueryDefinition,
     )
+    from datadog_api_client.v1.model.formula_and_function_cloud_cost_query_definition import (
+        FormulaAndFunctionCloudCostQueryDefinition,
+    )
 
 
 class QueryValueWidgetRequest(ModelNormal):
@@ -111,6 +114,7 @@ def __init__(
                     FormulaAndFunctionApmDependencyStatsQueryDefinition,
                     FormulaAndFunctionApmResourceStatsQueryDefinition,
                     FormulaAndFunctionSLOQueryDefinition,
+                    FormulaAndFunctionCloudCostQueryDefinition,
                 ]
             ],
             UnsetType,