Regenerate client from commit 63a241d of spec repo

Author: ci.datadog-api-spec

.generator/schemas/v1/openapi.yaml

@@ -19420,7 +19420,7 @@ components:
           description: The description of the widget.
           type: string
         requests:
-          description: One or more Topology requests.
+          description: One Topology request.
           items:
             $ref: "#/components/schemas/TopologyRequest"
           minItems: 1
@@ -19449,10 +19449,14 @@ components:
       x-enum-varnames:
         - TOPOLOGY_MAP
     TopologyQuery:
+      description: A topology data source query.
+      oneOf:
+        - $ref: "#/components/schemas/TopologyQueryDataStreamsOrServiceMap"
+    TopologyQueryDataStreamsOrServiceMap:
       description: Query to service-based topology data sources like the service map or data streams.
       properties:
         data_source:
-          $ref: "#/components/schemas/TopologyQueryDataSource"
+          $ref: "#/components/schemas/TopologyQueryDataStreamsOrServiceMapDataSource"
         filters:
           description: Your environment and primary tag (or * if enabled for your account).
           example: ["env:prod", "az:us-east"]
@@ -19461,16 +19465,24 @@ components:
             type: string
           minItems: 1
           type: array
+        query_string:
+          description: A search string for filtering services, used in `data_streams` queries only. When set, this replaces the `service` field
+          example: "service:myservice"
+          type: string
         service:
           description: Name of the service
-          example: myService
+          example: myservice
           type: string
+      required:
+        - data_source
+        - filters
       type: object
-    TopologyQueryDataSource:
+    TopologyQueryDataStreamsOrServiceMapDataSource:
       description: Name of the data source
       enum:
         - data_streams
         - service_map
+      example: data_streams
       type: string
       x-enum-varnames:
         - DATA_STREAMS

docs/datadog_api_client.v1.model.rst

@@ -6101,10 +6101,17 @@ datadog\_api\_client.v1.model.topology\_query module
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v1.model.topology\_query\_data\_source module
-------------------------------------------------------------------
+datadog\_api\_client.v1.model.topology\_query\_data\_streams\_or\_service\_map module
+-------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.topology_query_data_streams_or_service_map
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.topology\_query\_data\_streams\_or\_service\_map\_data\_source module
+---------------------------------------------------------------------------------------------------
 
-.. automodule:: datadog_api_client.v1.model.topology_query_data_source
+.. automodule:: datadog_api_client.v1.model.topology_query_data_streams_or_service_map_data_source
    :members:
    :show-inheritance:
 

examples/v1/dashboards/CreateDashboard_2652180930.py

@@ -8,8 +8,10 @@
 from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
 from datadog_api_client.v1.model.topology_map_widget_definition import TopologyMapWidgetDefinition
 from datadog_api_client.v1.model.topology_map_widget_definition_type import TopologyMapWidgetDefinitionType
-from datadog_api_client.v1.model.topology_query import TopologyQuery
-from datadog_api_client.v1.model.topology_query_data_source import TopologyQueryDataSource
+from datadog_api_client.v1.model.topology_query_data_streams_or_service_map import TopologyQueryDataStreamsOrServiceMap
+from datadog_api_client.v1.model.topology_query_data_streams_or_service_map_data_source import (
+    TopologyQueryDataStreamsOrServiceMapDataSource,
+)
 from datadog_api_client.v1.model.topology_request import TopologyRequest
 from datadog_api_client.v1.model.topology_request_type import TopologyRequestType
 from datadog_api_client.v1.model.widget import Widget
@@ -35,8 +37,8 @@
                 requests=[
                     TopologyRequest(
                         request_type=TopologyRequestType.TOPOLOGY,
-                        query=TopologyQuery(
-                            data_source=TopologyQueryDataSource.SERVICE_MAP,
+                        query=TopologyQueryDataStreamsOrServiceMap(
+                            data_source=TopologyQueryDataStreamsOrServiceMapDataSource.SERVICE_MAP,
                             service="",
                             filters=[
                                 "env:none",

examples/v1/dashboards/CreateDashboard_2815497946.py

@@ -0,0 +1,63 @@
+"""
+Create a new dashboard with topology_map data_streams widget
+"""
+
+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.topology_map_widget_definition import TopologyMapWidgetDefinition
+from datadog_api_client.v1.model.topology_map_widget_definition_type import TopologyMapWidgetDefinitionType
+from datadog_api_client.v1.model.topology_query_data_streams_or_service_map import TopologyQueryDataStreamsOrServiceMap
+from datadog_api_client.v1.model.topology_query_data_streams_or_service_map_data_source import (
+    TopologyQueryDataStreamsOrServiceMapDataSource,
+)
+from datadog_api_client.v1.model.topology_request import TopologyRequest
+from datadog_api_client.v1.model.topology_request_type import TopologyRequestType
+from datadog_api_client.v1.model.widget import Widget
+from datadog_api_client.v1.model.widget_layout import WidgetLayout
+from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
+
+body = Dashboard(
+    title="Example-Dashboard",
+    description="",
+    widgets=[
+        Widget(
+            layout=WidgetLayout(
+                x=0,
+                y=0,
+                width=47,
+                height=15,
+            ),
+            definition=TopologyMapWidgetDefinition(
+                title="",
+                title_size="16",
+                title_align=WidgetTextAlign.LEFT,
+                type=TopologyMapWidgetDefinitionType.TOPOLOGY_MAP,
+                requests=[
+                    TopologyRequest(
+                        request_type=TopologyRequestType.TOPOLOGY,
+                        query=TopologyQueryDataStreamsOrServiceMap(
+                            data_source=TopologyQueryDataStreamsOrServiceMapDataSource.DATA_STREAMS,
+                            service="",
+                            filters=[
+                                "env:prod",
+                            ],
+                            query_string="service:myservice",
+                        ),
+                    ),
+                ],
+            ),
+        ),
+    ],
+    template_variables=[],
+    layout_type=DashboardLayoutType.FREE,
+    notify_list=[],
+)
+
+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/topology_map_widget_definition.py

@@ -74,7 +74,7 @@ def __init__(
         :param description: The description of the widget.
         :type description: str, optional
 
-        :param requests: One or more Topology requests.
+        :param requests: One Topology request.
         :type requests: [TopologyRequest]
 
         :param title: Title of your widget.

src/datadog_api_client/v1/model/topology_query.py

@@ -3,66 +3,47 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
-from typing import List, Union, TYPE_CHECKING
 
 from datadog_api_client.model_utils import (
-    ModelNormal,
+    ModelComposed,
     cached_property,
-    unset,
-    UnsetType,
 )
 
 
-if TYPE_CHECKING:
-    from datadog_api_client.v1.model.topology_query_data_source import TopologyQueryDataSource
-
-
-class TopologyQuery(ModelNormal):
-    validations = {
-        "filters": {
-            "min_items": 1,
-        },
-    }
-
-    @cached_property
-    def openapi_types(_):
-        from datadog_api_client.v1.model.topology_query_data_source import TopologyQueryDataSource
-
-        return {
-            "data_source": (TopologyQueryDataSource,),
-            "filters": ([str],),
-            "service": (str,),
-        }
-
-    attribute_map = {
-        "data_source": "data_source",
-        "filters": "filters",
-        "service": "service",
-    }
-
-    def __init__(
-        self_,
-        data_source: Union[TopologyQueryDataSource, UnsetType] = unset,
-        filters: Union[List[str], UnsetType] = unset,
-        service: Union[str, UnsetType] = unset,
-        **kwargs,
-    ):
+class TopologyQuery(ModelComposed):
+    def __init__(self, **kwargs):
         """
-        Query to service-based topology data sources like the service map or data streams.
+        A topology data source query.
 
         :param data_source: Name of the data source
-        :type data_source: TopologyQueryDataSource, optional
+        :type data_source: TopologyQueryDataStreamsOrServiceMapDataSource
 
         :param filters: Your environment and primary tag (or * if enabled for your account).
-        :type filters: [str], optional
+        :type filters: [str]
+
+        :param query_string: A search string for filtering services, used in `data_streams` queries only. When set, this replaces the `service` field
+        :type query_string: str, optional
 
         :param service: Name of the service
         :type service: str, optional
         """
-        if data_source is not unset:
-            kwargs["data_source"] = data_source
-        if filters is not unset:
-            kwargs["filters"] = filters
-        if service is not unset:
-            kwargs["service"] = service
         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.topology_query_data_streams_or_service_map import (
+            TopologyQueryDataStreamsOrServiceMap,
+        )
+
+        return {
+            "oneOf": [
+                TopologyQueryDataStreamsOrServiceMap,
+            ],
+        }

src/datadog_api_client/v1/model/topology_query_data_streams_or_service_map.py

@@ -0,0 +1,79 @@
+# 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 List, Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v1.model.topology_query_data_streams_or_service_map_data_source import (
+        TopologyQueryDataStreamsOrServiceMapDataSource,
+    )
+
+
+class TopologyQueryDataStreamsOrServiceMap(ModelNormal):
+    validations = {
+        "filters": {
+            "min_items": 1,
+        },
+    }
+
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v1.model.topology_query_data_streams_or_service_map_data_source import (
+            TopologyQueryDataStreamsOrServiceMapDataSource,
+        )
+
+        return {
+            "data_source": (TopologyQueryDataStreamsOrServiceMapDataSource,),
+            "filters": ([str],),
+            "query_string": (str,),
+            "service": (str,),
+        }
+
+    attribute_map = {
+        "data_source": "data_source",
+        "filters": "filters",
+        "query_string": "query_string",
+        "service": "service",
+    }
+
+    def __init__(
+        self_,
+        data_source: TopologyQueryDataStreamsOrServiceMapDataSource,
+        filters: List[str],
+        query_string: Union[str, UnsetType] = unset,
+        service: Union[str, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        Query to service-based topology data sources like the service map or data streams.
+
+        :param data_source: Name of the data source
+        :type data_source: TopologyQueryDataStreamsOrServiceMapDataSource
+
+        :param filters: Your environment and primary tag (or * if enabled for your account).
+        :type filters: [str]
+
+        :param query_string: A search string for filtering services, used in ``data_streams`` queries only. When set, this replaces the ``service`` field
+        :type query_string: str, optional
+
+        :param service: Name of the service
+        :type service: str, optional
+        """
+        if query_string is not unset:
+            kwargs["query_string"] = query_string
+        if service is not unset:
+            kwargs["service"] = service
+        super().__init__(kwargs)
+
+        self_.data_source = data_source
+        self_.filters = filters

…t/v1/model/topology_query_data_source.py …ta_streams_or_service_map_data_source.pysrc/datadog_api_client/v1/model/topology_query_data_source.py renamed to src/datadog_api_client/v1/model/topology_query_data_streams_or_service_map_data_source.py src/datadog_api_client/v1/model/topology_query_data_source.py renamed to src/datadog_api_client/v1/model/topology_query_data_streams_or_service_map_data_source.py

@@ -12,7 +12,7 @@
 from typing import ClassVar
 
 
-class TopologyQueryDataSource(ModelSimple):
+class TopologyQueryDataStreamsOrServiceMapDataSource(ModelSimple):
     """
     Name of the data source
 
@@ -24,8 +24,8 @@ class TopologyQueryDataSource(ModelSimple):
         "data_streams",
         "service_map",
     }
-    DATA_STREAMS: ClassVar["TopologyQueryDataSource"]
-    SERVICE_MAP: ClassVar["TopologyQueryDataSource"]
+    DATA_STREAMS: ClassVar["TopologyQueryDataStreamsOrServiceMapDataSource"]
+    SERVICE_MAP: ClassVar["TopologyQueryDataStreamsOrServiceMapDataSource"]
 
     @cached_property
     def openapi_types(_):
@@ -34,5 +34,9 @@ def openapi_types(_):
         }
 
 
-TopologyQueryDataSource.DATA_STREAMS = TopologyQueryDataSource("data_streams")
-TopologyQueryDataSource.SERVICE_MAP = TopologyQueryDataSource("service_map")
+TopologyQueryDataStreamsOrServiceMapDataSource.DATA_STREAMS = TopologyQueryDataStreamsOrServiceMapDataSource(
+    "data_streams"
+)
+TopologyQueryDataStreamsOrServiceMapDataSource.SERVICE_MAP = TopologyQueryDataStreamsOrServiceMapDataSource(
+    "service_map"
+)