Regenerate client from commit 715b041 of spec repo

Author: ci.datadog-api-spec

.generator/schemas/v1/openapi.yaml

@@ -6611,6 +6611,7 @@ components:
         - Select value from matching element
         - Compute array length
         - Append a value to an array
+        - Extract key-value pairs from an array
       properties:
         is_enabled:
           default: false
@@ -6633,6 +6634,7 @@ components:
         - $ref: "#/components/schemas/LogsArrayProcessorOperationAppend"
         - $ref: "#/components/schemas/LogsArrayProcessorOperationLength"
         - $ref: "#/components/schemas/LogsArrayProcessorOperationSelect"
+        - $ref: "#/components/schemas/LogsArrayProcessorOperationExtractKeyValue"
     LogsArrayProcessorOperationAppend:
       description: Operation that appends a value to a target array attribute.
       properties:
@@ -6662,6 +6664,44 @@ components:
       type: string
       x-enum-varnames:
         - APPEND
+    LogsArrayProcessorOperationExtractKeyValue:
+      description: Operation that extracts key-value pairs from a `source` array and stores the result in the `target` attribute.
+      properties:
+        key_to_extract:
+          description: Key of the attribute in each array element that holds the name to use for the extracted attribute.
+          example: name
+          type: string
+        override_on_conflict:
+          default: false
+          description: Whether to override the target element if it's already set.
+          type: boolean
+        source:
+          description: Attribute path of the array to extract key-value pairs from.
+          example: tags
+          type: string
+        target:
+          description: Attribute that receives the extracted key-value pairs. If not specified, the extracted attributes are added at the root level of the log.
+          example: extracted
+          type: string
+        type:
+          $ref: "#/components/schemas/LogsArrayProcessorOperationExtractKeyValueType"
+        value_to_extract:
+          description: Key of the attribute in each array element that holds the value to use for the extracted attribute.
+          example: value
+          type: string
+      required:
+        - type
+        - source
+        - key_to_extract
+        - value_to_extract
+      type: object
+    LogsArrayProcessorOperationExtractKeyValueType:
+      description: Operation type.
+      enum: [key-value]
+      example: key-value
+      type: string
+      x-enum-varnames:
+        - KEY_VALUE
     LogsArrayProcessorOperationLength:
       description: Operation that computes the length of a `source` array and stores the result in the `target` attribute.
       properties:
@@ -6746,7 +6786,7 @@ components:
           type: string
         override_on_conflict:
           default: false
-          description: Override or not the target element if already set,
+          description: Whether to override the target element if it's already set.
           type: boolean
         preserve_source:
           default: false
@@ -7912,7 +7952,7 @@ components:
           type: string
         override_on_conflict:
           default: false
-          description: Override or not the target element if already set.
+          description: Whether to override the target element if it's already set.
           type: boolean
         preserve_source:
           default: false

docs/datadog_api_client.v1.model.rst

@@ -2125,6 +2125,20 @@ datadog\_api\_client.v1.model.logs\_array\_processor\_operation\_append\_type mo
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v1.model.logs\_array\_processor\_operation\_extract\_key\_value module
+-------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.logs_array_processor_operation_extract_key_value
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.logs\_array\_processor\_operation\_extract\_key\_value\_type module
+-------------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.logs_array_processor_operation_extract_key_value_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v1.model.logs\_array\_processor\_operation\_length module
 ------------------------------------------------------------------------------
 

examples/v1/logs-pipelines/CreateLogsPipeline_2595757342.py

@@ -0,0 +1,44 @@
+"""
+Create a pipeline with Array Processor Key Value Operation returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.logs_pipelines_api import LogsPipelinesApi
+from datadog_api_client.v1.model.logs_array_processor import LogsArrayProcessor
+from datadog_api_client.v1.model.logs_array_processor_operation_extract_key_value import (
+    LogsArrayProcessorOperationExtractKeyValue,
+)
+from datadog_api_client.v1.model.logs_array_processor_operation_extract_key_value_type import (
+    LogsArrayProcessorOperationExtractKeyValueType,
+)
+from datadog_api_client.v1.model.logs_array_processor_type import LogsArrayProcessorType
+from datadog_api_client.v1.model.logs_filter import LogsFilter
+from datadog_api_client.v1.model.logs_pipeline import LogsPipeline
+
+body = LogsPipeline(
+    filter=LogsFilter(
+        query="source:python",
+    ),
+    name="testPipelineArrayKeyValue",
+    processors=[
+        LogsArrayProcessor(
+            type=LogsArrayProcessorType.ARRAY_PROCESSOR,
+            is_enabled=True,
+            name="extract_kv",
+            operation=LogsArrayProcessorOperationExtractKeyValue(
+                type=LogsArrayProcessorOperationExtractKeyValueType.KEY_VALUE,
+                source="tags",
+                key_to_extract="name",
+                value_to_extract="value",
+            ),
+        ),
+    ],
+    tags=[],
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = LogsPipelinesApi(api_client)
+    response = api_instance.create_logs_pipeline(body=body)
+
+    print(response)

examples/v1/logs-pipelines/CreateLogsPipeline_4041812833.py

@@ -0,0 +1,46 @@
+"""
+Create a pipeline with Array Processor Key Value Operation with target and override_on_conflict returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.logs_pipelines_api import LogsPipelinesApi
+from datadog_api_client.v1.model.logs_array_processor import LogsArrayProcessor
+from datadog_api_client.v1.model.logs_array_processor_operation_extract_key_value import (
+    LogsArrayProcessorOperationExtractKeyValue,
+)
+from datadog_api_client.v1.model.logs_array_processor_operation_extract_key_value_type import (
+    LogsArrayProcessorOperationExtractKeyValueType,
+)
+from datadog_api_client.v1.model.logs_array_processor_type import LogsArrayProcessorType
+from datadog_api_client.v1.model.logs_filter import LogsFilter
+from datadog_api_client.v1.model.logs_pipeline import LogsPipeline
+
+body = LogsPipeline(
+    filter=LogsFilter(
+        query="source:python",
+    ),
+    name="testPipelineArrayKeyValueTarget",
+    processors=[
+        LogsArrayProcessor(
+            type=LogsArrayProcessorType.ARRAY_PROCESSOR,
+            is_enabled=True,
+            name="extract_kv_to_target",
+            operation=LogsArrayProcessorOperationExtractKeyValue(
+                type=LogsArrayProcessorOperationExtractKeyValueType.KEY_VALUE,
+                source="tags",
+                key_to_extract="name",
+                value_to_extract="value",
+                target="extracted",
+                override_on_conflict=True,
+            ),
+        ),
+    ],
+    tags=[],
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = LogsPipelinesApi(api_client)
+    response = api_instance.create_logs_pipeline(body=body)
+
+    print(response)

src/datadog_api_client/v1/model/logs_array_processor.py

@@ -19,6 +19,9 @@
     from datadog_api_client.v1.model.logs_array_processor_operation_append import LogsArrayProcessorOperationAppend
     from datadog_api_client.v1.model.logs_array_processor_operation_length import LogsArrayProcessorOperationLength
     from datadog_api_client.v1.model.logs_array_processor_operation_select import LogsArrayProcessorOperationSelect
+    from datadog_api_client.v1.model.logs_array_processor_operation_extract_key_value import (
+        LogsArrayProcessorOperationExtractKeyValue,
+    )
 
 
 class LogsArrayProcessor(ModelNormal):
@@ -48,6 +51,7 @@ def __init__(
             LogsArrayProcessorOperationAppend,
             LogsArrayProcessorOperationLength,
             LogsArrayProcessorOperationSelect,
+            LogsArrayProcessorOperationExtractKeyValue,
         ],
         type: LogsArrayProcessorType,
         is_enabled: Union[bool, UnsetType] = unset,
@@ -61,6 +65,7 @@ def __init__(
         * Select value from matching element
         * Compute array length
         * Append a value to an array
+        * Extract key-value pairs from an array
 
         :param is_enabled: Whether or not the processor is enabled.
         :type is_enabled: bool, optional

src/datadog_api_client/v1/model/logs_array_processor_operation.py

@@ -32,6 +32,12 @@ def __init__(self, **kwargs):
 
         :param value_to_extract: Key of the value to extract from the matching element.
         :type value_to_extract: str
+
+        :param key_to_extract: Key of the attribute in each array element that holds the name to use for the extracted attribute.
+        :type key_to_extract: str
+
+        :param override_on_conflict: Whether to override the target element if it's already set.
+        :type override_on_conflict: bool, optional
         """
         super().__init__(kwargs)
 
@@ -47,11 +53,15 @@ def _composed_schemas(_):
         from datadog_api_client.v1.model.logs_array_processor_operation_append import LogsArrayProcessorOperationAppend
         from datadog_api_client.v1.model.logs_array_processor_operation_length import LogsArrayProcessorOperationLength
         from datadog_api_client.v1.model.logs_array_processor_operation_select import LogsArrayProcessorOperationSelect
+        from datadog_api_client.v1.model.logs_array_processor_operation_extract_key_value import (
+            LogsArrayProcessorOperationExtractKeyValue,
+        )
 
         return {
             "oneOf": [
                 LogsArrayProcessorOperationAppend,
                 LogsArrayProcessorOperationLength,
                 LogsArrayProcessorOperationSelect,
+                LogsArrayProcessorOperationExtractKeyValue,
             ],
         }

src/datadog_api_client/v1/model/logs_array_processor_operation_extract_key_value.py

@@ -0,0 +1,87 @@
+# 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.logs_array_processor_operation_extract_key_value_type import (
+        LogsArrayProcessorOperationExtractKeyValueType,
+    )
+
+
+class LogsArrayProcessorOperationExtractKeyValue(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v1.model.logs_array_processor_operation_extract_key_value_type import (
+            LogsArrayProcessorOperationExtractKeyValueType,
+        )
+
+        return {
+            "key_to_extract": (str,),
+            "override_on_conflict": (bool,),
+            "source": (str,),
+            "target": (str,),
+            "type": (LogsArrayProcessorOperationExtractKeyValueType,),
+            "value_to_extract": (str,),
+        }
+
+    attribute_map = {
+        "key_to_extract": "key_to_extract",
+        "override_on_conflict": "override_on_conflict",
+        "source": "source",
+        "target": "target",
+        "type": "type",
+        "value_to_extract": "value_to_extract",
+    }
+
+    def __init__(
+        self_,
+        key_to_extract: str,
+        source: str,
+        type: LogsArrayProcessorOperationExtractKeyValueType,
+        value_to_extract: str,
+        override_on_conflict: Union[bool, UnsetType] = unset,
+        target: Union[str, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        Operation that extracts key-value pairs from a ``source`` array and stores the result in the ``target`` attribute.
+
+        :param key_to_extract: Key of the attribute in each array element that holds the name to use for the extracted attribute.
+        :type key_to_extract: str
+
+        :param override_on_conflict: Whether to override the target element if it's already set.
+        :type override_on_conflict: bool, optional
+
+        :param source: Attribute path of the array to extract key-value pairs from.
+        :type source: str
+
+        :param target: Attribute that receives the extracted key-value pairs. If not specified, the extracted attributes are added at the root level of the log.
+        :type target: str, optional
+
+        :param type: Operation type.
+        :type type: LogsArrayProcessorOperationExtractKeyValueType
+
+        :param value_to_extract: Key of the attribute in each array element that holds the value to use for the extracted attribute.
+        :type value_to_extract: str
+        """
+        if override_on_conflict is not unset:
+            kwargs["override_on_conflict"] = override_on_conflict
+        if target is not unset:
+            kwargs["target"] = target
+        super().__init__(kwargs)
+
+        self_.key_to_extract = key_to_extract
+        self_.source = source
+        self_.type = type
+        self_.value_to_extract = value_to_extract

src/datadog_api_client/v1/model/logs_array_processor_operation_extract_key_value_type.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 LogsArrayProcessorOperationExtractKeyValueType(ModelSimple):
+    """
+    Operation type.
+
+    :param value: If omitted defaults to "key-value". Must be one of ["key-value"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "key-value",
+    }
+    KEY_VALUE: ClassVar["LogsArrayProcessorOperationExtractKeyValueType"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+LogsArrayProcessorOperationExtractKeyValueType.KEY_VALUE = LogsArrayProcessorOperationExtractKeyValueType("key-value")

src/datadog_api_client/v1/model/logs_attribute_remapper.py

@@ -75,7 +75,7 @@ def __init__(
         :param name: Name of the processor.
         :type name: str, optional
 
-        :param override_on_conflict: Override or not the target element if already set,
+        :param override_on_conflict: Whether to override the target element if it's already set.
         :type override_on_conflict: bool, optional
 
         :param preserve_source: Remove or preserve the remapped source element.

src/datadog_api_client/v1/model/logs_processor.py

@@ -36,7 +36,7 @@ def __init__(self, **kwargs):
         :param sources: Array of source attributes.
         :type sources: [str]
 
-        :param override_on_conflict: Override or not the target element if already set,
+        :param override_on_conflict: Whether to override the target element if it's already set.
         :type override_on_conflict: bool, optional
 
         :param preserve_source: Remove or preserve the remapped source element.