Skip to content

Commit 5ee8556

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit a41d04b of spec repo
1 parent 5a2d212 commit 5ee8556

8 files changed

Lines changed: 365 additions & 0 deletions

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55577,6 +55577,7 @@ components:
5557755577
- $ref: "#/components/schemas/ObservabilityPipelineSyslogNgDestination"
5557855578
- $ref: "#/components/schemas/ObservabilityPipelineDatabricksZerobusDestination"
5557955579
- $ref: "#/components/schemas/ObservabilityPipelineDatadogMetricsDestination"
55580+
- $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestination"
5558055581
ObservabilityPipelineConfigPipelineType:
5558155582
default: logs
5558255583
description: The type of data being ingested. Defaults to `logs` if not specified.
@@ -59698,6 +59699,81 @@ components:
5969859699
type: string
5969959700
x-enum-varnames:
5970059701
- SPLUNK_HEC
59702+
ObservabilityPipelineSplunkHecMetricsDestination:
59703+
description: |-
59704+
The `splunk_hec_metrics` destination forwards metrics to Splunk using the HTTP Event Collector (HEC).
59705+
59706+
**Supported pipeline types:** metrics
59707+
properties:
59708+
buffer:
59709+
$ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
59710+
compression:
59711+
$ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationCompression"
59712+
default_namespace:
59713+
description: Optional default namespace for metrics sent to Splunk HEC.
59714+
example: "custom_namespace"
59715+
type: string
59716+
endpoint_url_key:
59717+
description: Name of the environment variable or secret that holds the Splunk HEC endpoint URL.
59718+
example: SPLUNK_HEC_ENDPOINT_URL
59719+
type: string
59720+
id:
59721+
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).
59722+
example: splunk-hec-metrics-destination
59723+
type: string
59724+
index:
59725+
description: Optional name of the Splunk index where metrics are written.
59726+
example: "metrics"
59727+
type: string
59728+
inputs:
59729+
description: A list of component IDs whose output is used as the `input` for this component.
59730+
example: ["metrics-filter-processor"]
59731+
items:
59732+
description: The ID of a component whose output is used as input for this destination.
59733+
type: string
59734+
type: array
59735+
source:
59736+
description: The Splunk source field value for metric events.
59737+
example: "observability_pipelines"
59738+
type: string
59739+
sourcetype:
59740+
description: The Splunk sourcetype to assign to metric events.
59741+
example: "custom_sourcetype"
59742+
type: string
59743+
tls:
59744+
$ref: "#/components/schemas/ObservabilityPipelineTls"
59745+
token_key:
59746+
description: Name of the environment variable or secret that holds the Splunk HEC token.
59747+
example: SPLUNK_HEC_TOKEN
59748+
type: string
59749+
type:
59750+
$ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationType"
59751+
required:
59752+
- id
59753+
- type
59754+
- inputs
59755+
type: object
59756+
x-pipeline-types: [metrics]
59757+
ObservabilityPipelineSplunkHecMetricsDestinationCompression:
59758+
default: none
59759+
description: Compression algorithm applied when sending metrics to Splunk HEC.
59760+
enum:
59761+
- none
59762+
- gzip
59763+
example: none
59764+
type: string
59765+
x-enum-varnames:
59766+
- NONE
59767+
- GZIP
59768+
ObservabilityPipelineSplunkHecMetricsDestinationType:
59769+
default: splunk_hec_metrics
59770+
description: The destination type. Always `splunk_hec_metrics`.
59771+
enum:
59772+
- splunk_hec_metrics
59773+
example: splunk_hec_metrics
59774+
type: string
59775+
x-enum-varnames:
59776+
- SPLUNK_HEC_METRICS
5970159777
ObservabilityPipelineSplunkHecSource:
5970259778
description: |-
5970359779
The `splunk_hec` source implements the Splunk HTTP Event Collector (HEC) API.

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25449,6 +25449,27 @@ datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_destination\
2544925449
:members:
2545025450
:show-inheritance:
2545125451

25452+
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination module
25453+
-----------------------------------------------------------------------------------------------
25454+
25455+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination
25456+
:members:
25457+
:show-inheritance:
25458+
25459+
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination\_compression module
25460+
------------------------------------------------------------------------------------------------------------
25461+
25462+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression
25463+
:members:
25464+
:show-inheritance:
25465+
25466+
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination\_type module
25467+
-----------------------------------------------------------------------------------------------------
25468+
25469+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type
25470+
:members:
25471+
:show-inheritance:
25472+
2545225473
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_source module
2545325474
---------------------------------------------------------------------------------
2545425475

‎src/datadog_api_client/v2/model/observability_pipeline_config.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,9 @@
9797
from datadog_api_client.v2.model.observability_pipeline_datadog_metrics_destination import (
9898
ObservabilityPipelineDatadogMetricsDestination,
9999
)
100+
from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination import (
101+
ObservabilityPipelineSplunkHecMetricsDestination,
102+
)
100103
from datadog_api_client.v2.model.observability_pipeline_datadog_agent_source import (
101104
ObservabilityPipelineDatadogAgentSource,
102105
)
@@ -200,6 +203,7 @@ def __init__(
200203
ObservabilityPipelineSyslogNgDestination,
201204
ObservabilityPipelineDatabricksZerobusDestination,
202205
ObservabilityPipelineDatadogMetricsDestination,
206+
ObservabilityPipelineSplunkHecMetricsDestination,
203207
]
204208
],
205209
sources: List[

‎src/datadog_api_client/v2/model/observability_pipeline_config_destination_item.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,12 @@ def __init__(self, **kwargs):
226226
227227
: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.
228228
:type unity_catalog_endpoint_key: str, optional
229+
230+
:param default_namespace: Optional default namespace for metrics sent to Splunk HEC.
231+
:type default_namespace: str, optional
232+
233+
:param source: The Splunk source field value for metric events.
234+
:type source: str, optional
229235
"""
230236
super().__init__(kwargs)
231237

@@ -309,6 +315,9 @@ def _composed_schemas(_):
309315
from datadog_api_client.v2.model.observability_pipeline_datadog_metrics_destination import (
310316
ObservabilityPipelineDatadogMetricsDestination,
311317
)
318+
from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination import (
319+
ObservabilityPipelineSplunkHecMetricsDestination,
320+
)
312321

313322
return {
314323
"oneOf": [
@@ -337,5 +346,6 @@ def _composed_schemas(_):
337346
ObservabilityPipelineSyslogNgDestination,
338347
ObservabilityPipelineDatabricksZerobusDestination,
339348
ObservabilityPipelineDatadogMetricsDestination,
349+
ObservabilityPipelineSplunkHecMetricsDestination,
340350
],
341351
}

‎src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination.py‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
from typing import List, Union, TYPE_CHECKING
7+
8+
from datadog_api_client.model_utils import (
9+
ModelNormal,
10+
cached_property,
11+
unset,
12+
UnsetType,
13+
)
14+
15+
16+
if TYPE_CHECKING:
17+
from datadog_api_client.v2.model.observability_pipeline_buffer_options import ObservabilityPipelineBufferOptions
18+
from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression import (
19+
ObservabilityPipelineSplunkHecMetricsDestinationCompression,
20+
)
21+
from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
22+
from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type import (
23+
ObservabilityPipelineSplunkHecMetricsDestinationType,
24+
)
25+
from datadog_api_client.v2.model.observability_pipeline_disk_buffer_options import (
26+
ObservabilityPipelineDiskBufferOptions,
27+
)
28+
from datadog_api_client.v2.model.observability_pipeline_memory_buffer_options import (
29+
ObservabilityPipelineMemoryBufferOptions,
30+
)
31+
from datadog_api_client.v2.model.observability_pipeline_memory_buffer_size_options import (
32+
ObservabilityPipelineMemoryBufferSizeOptions,
33+
)
34+
35+
36+
class ObservabilityPipelineSplunkHecMetricsDestination(ModelNormal):
37+
@cached_property
38+
def openapi_types(_):
39+
from datadog_api_client.v2.model.observability_pipeline_buffer_options import ObservabilityPipelineBufferOptions
40+
from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression import (
41+
ObservabilityPipelineSplunkHecMetricsDestinationCompression,
42+
)
43+
from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
44+
from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type import (
45+
ObservabilityPipelineSplunkHecMetricsDestinationType,
46+
)
47+
48+
return {
49+
"buffer": (ObservabilityPipelineBufferOptions,),
50+
"compression": (ObservabilityPipelineSplunkHecMetricsDestinationCompression,),
51+
"default_namespace": (str,),
52+
"endpoint_url_key": (str,),
53+
"id": (str,),
54+
"index": (str,),
55+
"inputs": ([str],),
56+
"source": (str,),
57+
"sourcetype": (str,),
58+
"tls": (ObservabilityPipelineTls,),
59+
"token_key": (str,),
60+
"type": (ObservabilityPipelineSplunkHecMetricsDestinationType,),
61+
}
62+
63+
attribute_map = {
64+
"buffer": "buffer",
65+
"compression": "compression",
66+
"default_namespace": "default_namespace",
67+
"endpoint_url_key": "endpoint_url_key",
68+
"id": "id",
69+
"index": "index",
70+
"inputs": "inputs",
71+
"source": "source",
72+
"sourcetype": "sourcetype",
73+
"tls": "tls",
74+
"token_key": "token_key",
75+
"type": "type",
76+
}
77+
78+
def __init__(
79+
self_,
80+
id: str,
81+
inputs: List[str],
82+
type: ObservabilityPipelineSplunkHecMetricsDestinationType,
83+
buffer: Union[
84+
ObservabilityPipelineBufferOptions,
85+
ObservabilityPipelineDiskBufferOptions,
86+
ObservabilityPipelineMemoryBufferOptions,
87+
ObservabilityPipelineMemoryBufferSizeOptions,
88+
UnsetType,
89+
] = unset,
90+
compression: Union[ObservabilityPipelineSplunkHecMetricsDestinationCompression, UnsetType] = unset,
91+
default_namespace: Union[str, UnsetType] = unset,
92+
endpoint_url_key: Union[str, UnsetType] = unset,
93+
index: Union[str, UnsetType] = unset,
94+
source: Union[str, UnsetType] = unset,
95+
sourcetype: Union[str, UnsetType] = unset,
96+
tls: Union[ObservabilityPipelineTls, UnsetType] = unset,
97+
token_key: Union[str, UnsetType] = unset,
98+
**kwargs,
99+
):
100+
"""
101+
The ``splunk_hec_metrics`` destination forwards metrics to Splunk using the HTTP Event Collector (HEC).
102+
103+
**Supported pipeline types:** metrics
104+
105+
:param buffer: Configuration for buffer settings on destination components.
106+
:type buffer: ObservabilityPipelineBufferOptions, optional
107+
108+
:param compression: Compression algorithm applied when sending metrics to Splunk HEC.
109+
:type compression: ObservabilityPipelineSplunkHecMetricsDestinationCompression, optional
110+
111+
:param default_namespace: Optional default namespace for metrics sent to Splunk HEC.
112+
:type default_namespace: str, optional
113+
114+
:param endpoint_url_key: Name of the environment variable or secret that holds the Splunk HEC endpoint URL.
115+
:type endpoint_url_key: str, optional
116+
117+
: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).
118+
:type id: str
119+
120+
:param index: Optional name of the Splunk index where metrics are written.
121+
:type index: str, optional
122+
123+
:param inputs: A list of component IDs whose output is used as the ``input`` for this component.
124+
:type inputs: [str]
125+
126+
:param source: The Splunk source field value for metric events.
127+
:type source: str, optional
128+
129+
:param sourcetype: The Splunk sourcetype to assign to metric events.
130+
:type sourcetype: str, optional
131+
132+
:param tls: Configuration for enabling TLS encryption between the pipeline component and external services.
133+
:type tls: ObservabilityPipelineTls, optional
134+
135+
:param token_key: Name of the environment variable or secret that holds the Splunk HEC token.
136+
:type token_key: str, optional
137+
138+
:param type: The destination type. Always ``splunk_hec_metrics``.
139+
:type type: ObservabilityPipelineSplunkHecMetricsDestinationType
140+
"""
141+
if buffer is not unset:
142+
kwargs["buffer"] = buffer
143+
if compression is not unset:
144+
kwargs["compression"] = compression
145+
if default_namespace is not unset:
146+
kwargs["default_namespace"] = default_namespace
147+
if endpoint_url_key is not unset:
148+
kwargs["endpoint_url_key"] = endpoint_url_key
149+
if index is not unset:
150+
kwargs["index"] = index
151+
if source is not unset:
152+
kwargs["source"] = source
153+
if sourcetype is not unset:
154+
kwargs["sourcetype"] = sourcetype
155+
if tls is not unset:
156+
kwargs["tls"] = tls
157+
if token_key is not unset:
158+
kwargs["token_key"] = token_key
159+
super().__init__(kwargs)
160+
161+
self_.id = id
162+
self_.inputs = inputs
163+
self_.type = type

‎src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination_compression.py‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
7+
from datadog_api_client.model_utils import (
8+
ModelSimple,
9+
cached_property,
10+
)
11+
12+
from typing import ClassVar
13+
14+
15+
class ObservabilityPipelineSplunkHecMetricsDestinationCompression(ModelSimple):
16+
"""
17+
Compression algorithm applied when sending metrics to Splunk HEC.
18+
19+
:param value: If omitted defaults to "none". Must be one of ["none", "gzip"].
20+
:type value: str
21+
"""
22+
23+
allowed_values = {
24+
"none",
25+
"gzip",
26+
}
27+
NONE: ClassVar["ObservabilityPipelineSplunkHecMetricsDestinationCompression"]
28+
GZIP: ClassVar["ObservabilityPipelineSplunkHecMetricsDestinationCompression"]
29+
30+
@cached_property
31+
def openapi_types(_):
32+
return {
33+
"value": (str,),
34+
}
35+
36+
37+
ObservabilityPipelineSplunkHecMetricsDestinationCompression.NONE = (
38+
ObservabilityPipelineSplunkHecMetricsDestinationCompression("none")
39+
)
40+
ObservabilityPipelineSplunkHecMetricsDestinationCompression.GZIP = (
41+
ObservabilityPipelineSplunkHecMetricsDestinationCompression("gzip")
42+
)

0 commit comments

Comments
 (0)