From de14df4739df223313373adce3a2fa0b7fa63d48 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Fri, 22 May 2026 22:26:44 +0000 Subject: [PATCH] Regenerate client from commit 642016c of spec repo --- .generator/schemas/v2/openapi.yaml | 74 ++++++++++ docs/datadog_api_client.v2.model.rst | 21 +++ .../v2/model/observability_pipeline_config.py | 4 + ...bility_pipeline_config_destination_item.py | 10 ++ ...pipeline_splunk_hec_metrics_destination.py | 138 ++++++++++++++++++ ...unk_hec_metrics_destination_compression.py | 42 ++++++ ...ine_splunk_hec_metrics_destination_type.py | 37 +++++ src/datadog_api_client/v2/models/__init__.py | 12 ++ 8 files changed, 338 insertions(+) create mode 100644 src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination.py create mode 100644 src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination_compression.py create mode 100644 src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination_type.py diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 3bd4dc4902..7ba54ebb51 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -54016,6 +54016,7 @@ components: - $ref: "#/components/schemas/ObservabilityPipelineSyslogNgDestination" - $ref: "#/components/schemas/ObservabilityPipelineDatabricksZerobusDestination" - $ref: "#/components/schemas/ObservabilityPipelineDatadogMetricsDestination" + - $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestination" ObservabilityPipelineConfigPipelineType: default: logs description: The type of data being ingested. Defaults to `logs` if not specified. @@ -58137,6 +58138,79 @@ components: type: string x-enum-varnames: - SPLUNK_HEC + ObservabilityPipelineSplunkHecMetricsDestination: + description: |- + The `splunk_hec_metrics` destination forwards metrics to Splunk using the HTTP Event Collector (HEC). + + **Supported pipeline types:** metrics + properties: + compression: + $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationCompression" + default_namespace: + description: Optional default namespace for metrics sent to Splunk HEC. + example: "custom_namespace" + type: string + endpoint_url_key: + description: Name of the environment variable or secret that holds the Splunk HEC endpoint URL. + example: SPLUNK_HEC_ENDPOINT_URL + type: string + id: + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: splunk-hec-metrics-destination + type: string + index: + description: Optional name of the Splunk index where metrics are written. + example: "metrics" + type: string + inputs: + description: A list of component IDs whose output is used as the `input` for this component. + example: ["metrics-filter-processor"] + items: + description: The ID of a component whose output is used as input for this destination. + type: string + type: array + source: + description: The Splunk source field value for metric events. + example: "observability_pipelines" + type: string + sourcetype: + description: The Splunk sourcetype to assign to metric events. + example: "custom_sourcetype" + type: string + tls: + $ref: "#/components/schemas/ObservabilityPipelineTls" + token_key: + description: Name of the environment variable or secret that holds the Splunk HEC token. + example: SPLUNK_HEC_TOKEN + type: string + type: + $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationType" + required: + - id + - type + - inputs + type: object + x-pipeline-types: [metrics] + ObservabilityPipelineSplunkHecMetricsDestinationCompression: + default: none + description: Compression algorithm applied when sending metrics to Splunk HEC. + enum: + - none + - gzip + example: none + type: string + x-enum-varnames: + - NONE + - GZIP + ObservabilityPipelineSplunkHecMetricsDestinationType: + default: splunk_hec_metrics + description: The destination type. Always `splunk_hec_metrics`. + enum: + - splunk_hec_metrics + example: splunk_hec_metrics + type: string + x-enum-varnames: + - SPLUNK_HEC_METRICS ObservabilityPipelineSplunkHecSource: description: |- The `splunk_hec` source implements the Splunk HTTP Event Collector (HEC) API. diff --git a/docs/datadog_api_client.v2.model.rst b/docs/datadog_api_client.v2.model.rst index 8ebe6f4853..8200d45255 100644 --- a/docs/datadog_api_client.v2.model.rst +++ b/docs/datadog_api_client.v2.model.rst @@ -24840,6 +24840,27 @@ datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_destination\ :members: :show-inheritance: +datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination module +----------------------------------------------------------------------------------------------- + +.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination + :members: + :show-inheritance: + +datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination\_compression module +------------------------------------------------------------------------------------------------------------ + +.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression + :members: + :show-inheritance: + +datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination\_type module +----------------------------------------------------------------------------------------------------- + +.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type + :members: + :show-inheritance: + datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_source module --------------------------------------------------------------------------------- diff --git a/src/datadog_api_client/v2/model/observability_pipeline_config.py b/src/datadog_api_client/v2/model/observability_pipeline_config.py index 13a3ef23e0..afd1a78d88 100644 --- a/src/datadog_api_client/v2/model/observability_pipeline_config.py +++ b/src/datadog_api_client/v2/model/observability_pipeline_config.py @@ -97,6 +97,9 @@ from datadog_api_client.v2.model.observability_pipeline_datadog_metrics_destination import ( ObservabilityPipelineDatadogMetricsDestination, ) + from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination import ( + ObservabilityPipelineSplunkHecMetricsDestination, + ) from datadog_api_client.v2.model.observability_pipeline_datadog_agent_source import ( ObservabilityPipelineDatadogAgentSource, ) @@ -200,6 +203,7 @@ def __init__( ObservabilityPipelineSyslogNgDestination, ObservabilityPipelineDatabricksZerobusDestination, ObservabilityPipelineDatadogMetricsDestination, + ObservabilityPipelineSplunkHecMetricsDestination, ] ], sources: List[ diff --git a/src/datadog_api_client/v2/model/observability_pipeline_config_destination_item.py b/src/datadog_api_client/v2/model/observability_pipeline_config_destination_item.py index 0ddc4d1ff8..be0e39e2c7 100644 --- a/src/datadog_api_client/v2/model/observability_pipeline_config_destination_item.py +++ b/src/datadog_api_client/v2/model/observability_pipeline_config_destination_item.py @@ -226,6 +226,12 @@ def __init__(self, **kwargs): :param unity_catalog_endpoint_key: Name of the environment variable or the secret identifier that references your Databricks workspace URL, which is used to communicate with the Unity Catalog API. :type unity_catalog_endpoint_key: str, optional + + :param default_namespace: Optional default namespace for metrics sent to Splunk HEC. + :type default_namespace: str, optional + + :param source: The Splunk source field value for metric events. + :type source: str, optional """ super().__init__(kwargs) @@ -309,6 +315,9 @@ def _composed_schemas(_): from datadog_api_client.v2.model.observability_pipeline_datadog_metrics_destination import ( ObservabilityPipelineDatadogMetricsDestination, ) + from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination import ( + ObservabilityPipelineSplunkHecMetricsDestination, + ) return { "oneOf": [ @@ -337,5 +346,6 @@ def _composed_schemas(_): ObservabilityPipelineSyslogNgDestination, ObservabilityPipelineDatabricksZerobusDestination, ObservabilityPipelineDatadogMetricsDestination, + ObservabilityPipelineSplunkHecMetricsDestination, ], } diff --git a/src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination.py b/src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination.py new file mode 100644 index 0000000000..4b9e2d65dd --- /dev/null +++ b/src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination.py @@ -0,0 +1,138 @@ +# 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.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression import ( + ObservabilityPipelineSplunkHecMetricsDestinationCompression, + ) + from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls + from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type import ( + ObservabilityPipelineSplunkHecMetricsDestinationType, + ) + + +class ObservabilityPipelineSplunkHecMetricsDestination(ModelNormal): + @cached_property + def openapi_types(_): + from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression import ( + ObservabilityPipelineSplunkHecMetricsDestinationCompression, + ) + from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls + from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type import ( + ObservabilityPipelineSplunkHecMetricsDestinationType, + ) + + return { + "compression": (ObservabilityPipelineSplunkHecMetricsDestinationCompression,), + "default_namespace": (str,), + "endpoint_url_key": (str,), + "id": (str,), + "index": (str,), + "inputs": ([str],), + "source": (str,), + "sourcetype": (str,), + "tls": (ObservabilityPipelineTls,), + "token_key": (str,), + "type": (ObservabilityPipelineSplunkHecMetricsDestinationType,), + } + + attribute_map = { + "compression": "compression", + "default_namespace": "default_namespace", + "endpoint_url_key": "endpoint_url_key", + "id": "id", + "index": "index", + "inputs": "inputs", + "source": "source", + "sourcetype": "sourcetype", + "tls": "tls", + "token_key": "token_key", + "type": "type", + } + + def __init__( + self_, + id: str, + inputs: List[str], + type: ObservabilityPipelineSplunkHecMetricsDestinationType, + compression: Union[ObservabilityPipelineSplunkHecMetricsDestinationCompression, UnsetType] = unset, + default_namespace: Union[str, UnsetType] = unset, + endpoint_url_key: Union[str, UnsetType] = unset, + index: Union[str, UnsetType] = unset, + source: Union[str, UnsetType] = unset, + sourcetype: Union[str, UnsetType] = unset, + tls: Union[ObservabilityPipelineTls, UnsetType] = unset, + token_key: Union[str, UnsetType] = unset, + **kwargs, + ): + """ + The ``splunk_hec_metrics`` destination forwards metrics to Splunk using the HTTP Event Collector (HEC). + + **Supported pipeline types:** metrics + + :param compression: Compression algorithm applied when sending metrics to Splunk HEC. + :type compression: ObservabilityPipelineSplunkHecMetricsDestinationCompression, optional + + :param default_namespace: Optional default namespace for metrics sent to Splunk HEC. + :type default_namespace: str, optional + + :param endpoint_url_key: Name of the environment variable or secret that holds the Splunk HEC endpoint URL. + :type endpoint_url_key: str, optional + + :param id: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the ``input`` to downstream components). + :type id: str + + :param index: Optional name of the Splunk index where metrics are written. + :type index: str, optional + + :param inputs: A list of component IDs whose output is used as the ``input`` for this component. + :type inputs: [str] + + :param source: The Splunk source field value for metric events. + :type source: str, optional + + :param sourcetype: The Splunk sourcetype to assign to metric events. + :type sourcetype: str, optional + + :param tls: Configuration for enabling TLS encryption between the pipeline component and external services. + :type tls: ObservabilityPipelineTls, optional + + :param token_key: Name of the environment variable or secret that holds the Splunk HEC token. + :type token_key: str, optional + + :param type: The destination type. Always ``splunk_hec_metrics``. + :type type: ObservabilityPipelineSplunkHecMetricsDestinationType + """ + if compression is not unset: + kwargs["compression"] = compression + if default_namespace is not unset: + kwargs["default_namespace"] = default_namespace + if endpoint_url_key is not unset: + kwargs["endpoint_url_key"] = endpoint_url_key + if index is not unset: + kwargs["index"] = index + if source is not unset: + kwargs["source"] = source + if sourcetype is not unset: + kwargs["sourcetype"] = sourcetype + if tls is not unset: + kwargs["tls"] = tls + if token_key is not unset: + kwargs["token_key"] = token_key + super().__init__(kwargs) + + self_.id = id + self_.inputs = inputs + self_.type = type diff --git a/src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination_compression.py b/src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination_compression.py new file mode 100644 index 0000000000..a0fb62edb8 --- /dev/null +++ b/src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination_compression.py @@ -0,0 +1,42 @@ +# 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 ObservabilityPipelineSplunkHecMetricsDestinationCompression(ModelSimple): + """ + Compression algorithm applied when sending metrics to Splunk HEC. + + :param value: If omitted defaults to "none". Must be one of ["none", "gzip"]. + :type value: str + """ + + allowed_values = { + "none", + "gzip", + } + NONE: ClassVar["ObservabilityPipelineSplunkHecMetricsDestinationCompression"] + GZIP: ClassVar["ObservabilityPipelineSplunkHecMetricsDestinationCompression"] + + @cached_property + def openapi_types(_): + return { + "value": (str,), + } + + +ObservabilityPipelineSplunkHecMetricsDestinationCompression.NONE = ( + ObservabilityPipelineSplunkHecMetricsDestinationCompression("none") +) +ObservabilityPipelineSplunkHecMetricsDestinationCompression.GZIP = ( + ObservabilityPipelineSplunkHecMetricsDestinationCompression("gzip") +) diff --git a/src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination_type.py b/src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination_type.py new file mode 100644 index 0000000000..825a741bb2 --- /dev/null +++ b/src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination_type.py @@ -0,0 +1,37 @@ +# 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 ObservabilityPipelineSplunkHecMetricsDestinationType(ModelSimple): + """ + The destination type. Always `splunk_hec_metrics`. + + :param value: If omitted defaults to "splunk_hec_metrics". Must be one of ["splunk_hec_metrics"]. + :type value: str + """ + + allowed_values = { + "splunk_hec_metrics", + } + SPLUNK_HEC_METRICS: ClassVar["ObservabilityPipelineSplunkHecMetricsDestinationType"] + + @cached_property + def openapi_types(_): + return { + "value": (str,), + } + + +ObservabilityPipelineSplunkHecMetricsDestinationType.SPLUNK_HEC_METRICS = ( + ObservabilityPipelineSplunkHecMetricsDestinationType("splunk_hec_metrics") +) diff --git a/src/datadog_api_client/v2/models/__init__.py b/src/datadog_api_client/v2/models/__init__.py index 304ac498cc..02ddbcbcdf 100644 --- a/src/datadog_api_client/v2/models/__init__.py +++ b/src/datadog_api_client/v2/models/__init__.py @@ -5091,6 +5091,15 @@ from datadog_api_client.v2.model.observability_pipeline_splunk_hec_destination_type import ( ObservabilityPipelineSplunkHecDestinationType, ) +from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination import ( + ObservabilityPipelineSplunkHecMetricsDestination, +) +from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression import ( + ObservabilityPipelineSplunkHecMetricsDestinationCompression, +) +from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type import ( + ObservabilityPipelineSplunkHecMetricsDestinationType, +) from datadog_api_client.v2.model.observability_pipeline_splunk_hec_source import ObservabilityPipelineSplunkHecSource from datadog_api_client.v2.model.observability_pipeline_splunk_hec_source_type import ( ObservabilityPipelineSplunkHecSourceType, @@ -11786,6 +11795,9 @@ "ObservabilityPipelineSplunkHecDestinationEncoding", "ObservabilityPipelineSplunkHecDestinationTokenStrategy", "ObservabilityPipelineSplunkHecDestinationType", + "ObservabilityPipelineSplunkHecMetricsDestination", + "ObservabilityPipelineSplunkHecMetricsDestinationCompression", + "ObservabilityPipelineSplunkHecMetricsDestinationType", "ObservabilityPipelineSplunkHecSource", "ObservabilityPipelineSplunkHecSourceType", "ObservabilityPipelineSplunkHecSourceValidToken",