Add support for routes in datadog logs destination (#3106)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

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

.generator/schemas/v2/openapi.yaml

@@ -36571,6 +36571,18 @@ components:
           items:
             type: string
           type: array
+        routes:
+          description: A list of routing rules that forward matching logs to Datadog
+            using dedicated API keys.
+          example:
+          - api_key_key: API_KEY_IDENTIFIER
+            include: service:api
+            route_id: datadog-logs-route-us1
+            site: us1
+          items:
+            $ref: '#/components/schemas/ObservabilityPipelineDatadogLogsDestinationRoute'
+          maxItems: 100
+          type: array
         type:
           $ref: '#/components/schemas/ObservabilityPipelineDatadogLogsDestinationType'
       required:
@@ -36580,6 +36592,29 @@ components:
       type: object
       x-pipeline-types:
       - logs
+    ObservabilityPipelineDatadogLogsDestinationRoute:
+      description: Defines how the `datadog_logs` destination routes matching logs
+        to a Datadog site using a specific API key.
+      properties:
+        api_key_key:
+          description: Name of the environment variable or secret that stores the
+            Datadog API key used by this route.
+          example: API_KEY_IDENTIFIER
+          type: string
+        include:
+          description: A Datadog search query that determines which logs are forwarded
+            using this route.
+          example: service:api
+          type: string
+        route_id:
+          description: Unique identifier for this route within the destination.
+          example: datadog-logs-route-us
+          type: string
+        site:
+          description: Datadog site where matching logs are sent (for example, `us1`).
+          example: us1
+          type: string
+      type: object
     ObservabilityPipelineDatadogLogsDestinationType:
       default: datadog_logs
       description: The destination type. The value should always be `datadog_logs`.

docs/datadog_api_client.v2.model.rst

@@ -15859,6 +15859,13 @@ datadog\_api\_client.v2.model.observability\_pipeline\_datadog\_logs\_destinatio
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.observability\_pipeline\_datadog\_logs\_destination\_route module
+-----------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination_route
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.observability\_pipeline\_datadog\_logs\_destination\_type module
 ----------------------------------------------------------------------------------------------
 

src/datadog_api_client/v2/model/observability_pipeline_config_destination_item.py

@@ -64,6 +64,9 @@ def __init__(self, **kwargs):
         :param container_name: The name of the Azure Blob Storage container to store logs in.
         :type container_name: str
 
+        :param routes: A list of routing rules that forward matching logs to Datadog using dedicated API keys.
+        :type routes: [ObservabilityPipelineDatadogLogsDestinationRoute], optional
+
         :param api_version: The Elasticsearch API version to use. Set to `auto` to auto-detect.
         :type api_version: ObservabilityPipelineElasticsearchDestinationApiVersion, optional
 

src/datadog_api_client/v2/model/observability_pipeline_datadog_logs_destination.py

@@ -3,40 +3,63 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
-from typing import List, TYPE_CHECKING
+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.v2.model.observability_pipeline_datadog_logs_destination_route import (
+        ObservabilityPipelineDatadogLogsDestinationRoute,
+    )
     from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination_type import (
         ObservabilityPipelineDatadogLogsDestinationType,
     )
 
 
 class ObservabilityPipelineDatadogLogsDestination(ModelNormal):
+    validations = {
+        "routes": {
+            "max_items": 100,
+        },
+    }
+
     @cached_property
     def openapi_types(_):
+        from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination_route import (
+            ObservabilityPipelineDatadogLogsDestinationRoute,
+        )
         from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination_type import (
             ObservabilityPipelineDatadogLogsDestinationType,
         )
 
         return {
             "id": (str,),
             "inputs": ([str],),
+            "routes": ([ObservabilityPipelineDatadogLogsDestinationRoute],),
             "type": (ObservabilityPipelineDatadogLogsDestinationType,),
         }
 
     attribute_map = {
         "id": "id",
         "inputs": "inputs",
+        "routes": "routes",
         "type": "type",
     }
 
-    def __init__(self_, id: str, inputs: List[str], type: ObservabilityPipelineDatadogLogsDestinationType, **kwargs):
+    def __init__(
+        self_,
+        id: str,
+        inputs: List[str],
+        type: ObservabilityPipelineDatadogLogsDestinationType,
+        routes: Union[List[ObservabilityPipelineDatadogLogsDestinationRoute], UnsetType] = unset,
+        **kwargs,
+    ):
         """
         The ``datadog_logs`` destination forwards logs to Datadog Log Management.
 
@@ -48,9 +71,14 @@ def __init__(self_, id: str, inputs: List[str], type: ObservabilityPipelineDatad
         :param inputs: A list of component IDs whose output is used as the ``input`` for this component.
         :type inputs: [str]
 
+        :param routes: A list of routing rules that forward matching logs to Datadog using dedicated API keys.
+        :type routes: [ObservabilityPipelineDatadogLogsDestinationRoute], optional
+
         :param type: The destination type. The value should always be ``datadog_logs``.
         :type type: ObservabilityPipelineDatadogLogsDestinationType
         """
+        if routes is not unset:
+            kwargs["routes"] = routes
         super().__init__(kwargs)
 
         self_.id = id

src/datadog_api_client/v2/model/observability_pipeline_datadog_logs_destination_route.py

@@ -0,0 +1,64 @@
+# 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
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+class ObservabilityPipelineDatadogLogsDestinationRoute(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        return {
+            "api_key_key": (str,),
+            "include": (str,),
+            "route_id": (str,),
+            "site": (str,),
+        }
+
+    attribute_map = {
+        "api_key_key": "api_key_key",
+        "include": "include",
+        "route_id": "route_id",
+        "site": "site",
+    }
+
+    def __init__(
+        self_,
+        api_key_key: Union[str, UnsetType] = unset,
+        include: Union[str, UnsetType] = unset,
+        route_id: Union[str, UnsetType] = unset,
+        site: Union[str, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        Defines how the ``datadog_logs`` destination routes matching logs to a Datadog site using a specific API key.
+
+        :param api_key_key: Name of the environment variable or secret that stores the Datadog API key used by this route.
+        :type api_key_key: str, optional
+
+        :param include: A Datadog search query that determines which logs are forwarded using this route.
+        :type include: str, optional
+
+        :param route_id: Unique identifier for this route within the destination.
+        :type route_id: str, optional
+
+        :param site: Datadog site where matching logs are sent (for example, ``us1`` ).
+        :type site: str, optional
+        """
+        if api_key_key is not unset:
+            kwargs["api_key_key"] = api_key_key
+        if include is not unset:
+            kwargs["include"] = include
+        if route_id is not unset:
+            kwargs["route_id"] = route_id
+        if site is not unset:
+            kwargs["site"] = site
+        super().__init__(kwargs)

src/datadog_api_client/v2/models/__init__.py

@@ -3026,6 +3026,9 @@
 from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination import (
     ObservabilityPipelineDatadogLogsDestination,
 )
+from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination_route import (
+    ObservabilityPipelineDatadogLogsDestinationRoute,
+)
 from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination_type import (
     ObservabilityPipelineDatadogLogsDestinationType,
 )
@@ -7667,6 +7670,7 @@
     "ObservabilityPipelineDatadogAgentSource",
     "ObservabilityPipelineDatadogAgentSourceType",
     "ObservabilityPipelineDatadogLogsDestination",
+    "ObservabilityPipelineDatadogLogsDestinationRoute",
     "ObservabilityPipelineDatadogLogsDestinationType",
     "ObservabilityPipelineDatadogMetricsDestination",
     "ObservabilityPipelineDatadogMetricsDestinationType",