Skip to content

Commit de14df4

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 642016c of spec repo
1 parent fa788a4 commit de14df4

8 files changed

Lines changed: 338 additions & 0 deletions

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

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54016,6 +54016,7 @@ components:
5401654016
- $ref: "#/components/schemas/ObservabilityPipelineSyslogNgDestination"
5401754017
- $ref: "#/components/schemas/ObservabilityPipelineDatabricksZerobusDestination"
5401854018
- $ref: "#/components/schemas/ObservabilityPipelineDatadogMetricsDestination"
54019+
- $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestination"
5401954020
ObservabilityPipelineConfigPipelineType:
5402054021
default: logs
5402154022
description: The type of data being ingested. Defaults to `logs` if not specified.
@@ -58137,6 +58138,79 @@ components:
5813758138
type: string
5813858139
x-enum-varnames:
5813958140
- SPLUNK_HEC
58141+
ObservabilityPipelineSplunkHecMetricsDestination:
58142+
description: |-
58143+
The `splunk_hec_metrics` destination forwards metrics to Splunk using the HTTP Event Collector (HEC).
58144+
58145+
**Supported pipeline types:** metrics
58146+
properties:
58147+
compression:
58148+
$ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationCompression"
58149+
default_namespace:
58150+
description: Optional default namespace for metrics sent to Splunk HEC.
58151+
example: "custom_namespace"
58152+
type: string
58153+
endpoint_url_key:
58154+
description: Name of the environment variable or secret that holds the Splunk HEC endpoint URL.
58155+
example: SPLUNK_HEC_ENDPOINT_URL
58156+
type: string
58157+
id:
58158+
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).
58159+
example: splunk-hec-metrics-destination
58160+
type: string
58161+
index:
58162+
description: Optional name of the Splunk index where metrics are written.
58163+
example: "metrics"
58164+
type: string
58165+
inputs:
58166+
description: A list of component IDs whose output is used as the `input` for this component.
58167+
example: ["metrics-filter-processor"]
58168+
items:
58169+
description: The ID of a component whose output is used as input for this destination.
58170+
type: string
58171+
type: array
58172+
source:
58173+
description: The Splunk source field value for metric events.
58174+
example: "observability_pipelines"
58175+
type: string
58176+
sourcetype:
58177+
description: The Splunk sourcetype to assign to metric events.
58178+
example: "custom_sourcetype"
58179+
type: string
58180+
tls:
58181+
$ref: "#/components/schemas/ObservabilityPipelineTls"
58182+
token_key:
58183+
description: Name of the environment variable or secret that holds the Splunk HEC token.
58184+
example: SPLUNK_HEC_TOKEN
58185+
type: string
58186+
type:
58187+
$ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationType"
58188+
required:
58189+
- id
58190+
- type
58191+
- inputs
58192+
type: object
58193+
x-pipeline-types: [metrics]
58194+
ObservabilityPipelineSplunkHecMetricsDestinationCompression:
58195+
default: none
58196+
description: Compression algorithm applied when sending metrics to Splunk HEC.
58197+
enum:
58198+
- none
58199+
- gzip
58200+
example: none
58201+
type: string
58202+
x-enum-varnames:
58203+
- NONE
58204+
- GZIP
58205+
ObservabilityPipelineSplunkHecMetricsDestinationType:
58206+
default: splunk_hec_metrics
58207+
description: The destination type. Always `splunk_hec_metrics`.
58208+
enum:
58209+
- splunk_hec_metrics
58210+
example: splunk_hec_metrics
58211+
type: string
58212+
x-enum-varnames:
58213+
- SPLUNK_HEC_METRICS
5814058214
ObservabilityPipelineSplunkHecSource:
5814158215
description: |-
5814258216
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
@@ -24840,6 +24840,27 @@ datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_destination\
2484024840
:members:
2484124841
:show-inheritance:
2484224842

24843+
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination module
24844+
-----------------------------------------------------------------------------------------------
24845+
24846+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination
24847+
:members:
24848+
:show-inheritance:
24849+
24850+
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination\_compression module
24851+
------------------------------------------------------------------------------------------------------------
24852+
24853+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression
24854+
:members:
24855+
:show-inheritance:
24856+
24857+
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination\_type module
24858+
-----------------------------------------------------------------------------------------------------
24859+
24860+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type
24861+
:members:
24862+
:show-inheritance:
24863+
2484324864
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_source module
2484424865
---------------------------------------------------------------------------------
2484524866

‎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: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
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_splunk_hec_metrics_destination_compression import (
18+
ObservabilityPipelineSplunkHecMetricsDestinationCompression,
19+
)
20+
from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
21+
from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type import (
22+
ObservabilityPipelineSplunkHecMetricsDestinationType,
23+
)
24+
25+
26+
class ObservabilityPipelineSplunkHecMetricsDestination(ModelNormal):
27+
@cached_property
28+
def openapi_types(_):
29+
from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression import (
30+
ObservabilityPipelineSplunkHecMetricsDestinationCompression,
31+
)
32+
from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
33+
from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type import (
34+
ObservabilityPipelineSplunkHecMetricsDestinationType,
35+
)
36+
37+
return {
38+
"compression": (ObservabilityPipelineSplunkHecMetricsDestinationCompression,),
39+
"default_namespace": (str,),
40+
"endpoint_url_key": (str,),
41+
"id": (str,),
42+
"index": (str,),
43+
"inputs": ([str],),
44+
"source": (str,),
45+
"sourcetype": (str,),
46+
"tls": (ObservabilityPipelineTls,),
47+
"token_key": (str,),
48+
"type": (ObservabilityPipelineSplunkHecMetricsDestinationType,),
49+
}
50+
51+
attribute_map = {
52+
"compression": "compression",
53+
"default_namespace": "default_namespace",
54+
"endpoint_url_key": "endpoint_url_key",
55+
"id": "id",
56+
"index": "index",
57+
"inputs": "inputs",
58+
"source": "source",
59+
"sourcetype": "sourcetype",
60+
"tls": "tls",
61+
"token_key": "token_key",
62+
"type": "type",
63+
}
64+
65+
def __init__(
66+
self_,
67+
id: str,
68+
inputs: List[str],
69+
type: ObservabilityPipelineSplunkHecMetricsDestinationType,
70+
compression: Union[ObservabilityPipelineSplunkHecMetricsDestinationCompression, UnsetType] = unset,
71+
default_namespace: Union[str, UnsetType] = unset,
72+
endpoint_url_key: Union[str, UnsetType] = unset,
73+
index: Union[str, UnsetType] = unset,
74+
source: Union[str, UnsetType] = unset,
75+
sourcetype: Union[str, UnsetType] = unset,
76+
tls: Union[ObservabilityPipelineTls, UnsetType] = unset,
77+
token_key: Union[str, UnsetType] = unset,
78+
**kwargs,
79+
):
80+
"""
81+
The ``splunk_hec_metrics`` destination forwards metrics to Splunk using the HTTP Event Collector (HEC).
82+
83+
**Supported pipeline types:** metrics
84+
85+
:param compression: Compression algorithm applied when sending metrics to Splunk HEC.
86+
:type compression: ObservabilityPipelineSplunkHecMetricsDestinationCompression, optional
87+
88+
:param default_namespace: Optional default namespace for metrics sent to Splunk HEC.
89+
:type default_namespace: str, optional
90+
91+
:param endpoint_url_key: Name of the environment variable or secret that holds the Splunk HEC endpoint URL.
92+
:type endpoint_url_key: str, optional
93+
94+
: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).
95+
:type id: str
96+
97+
:param index: Optional name of the Splunk index where metrics are written.
98+
:type index: str, optional
99+
100+
:param inputs: A list of component IDs whose output is used as the ``input`` for this component.
101+
:type inputs: [str]
102+
103+
:param source: The Splunk source field value for metric events.
104+
:type source: str, optional
105+
106+
:param sourcetype: The Splunk sourcetype to assign to metric events.
107+
:type sourcetype: str, optional
108+
109+
:param tls: Configuration for enabling TLS encryption between the pipeline component and external services.
110+
:type tls: ObservabilityPipelineTls, optional
111+
112+
:param token_key: Name of the environment variable or secret that holds the Splunk HEC token.
113+
:type token_key: str, optional
114+
115+
:param type: The destination type. Always ``splunk_hec_metrics``.
116+
:type type: ObservabilityPipelineSplunkHecMetricsDestinationType
117+
"""
118+
if compression is not unset:
119+
kwargs["compression"] = compression
120+
if default_namespace is not unset:
121+
kwargs["default_namespace"] = default_namespace
122+
if endpoint_url_key is not unset:
123+
kwargs["endpoint_url_key"] = endpoint_url_key
124+
if index is not unset:
125+
kwargs["index"] = index
126+
if source is not unset:
127+
kwargs["source"] = source
128+
if sourcetype is not unset:
129+
kwargs["sourcetype"] = sourcetype
130+
if tls is not unset:
131+
kwargs["tls"] = tls
132+
if token_key is not unset:
133+
kwargs["token_key"] = token_key
134+
super().__init__(kwargs)
135+
136+
self_.id = id
137+
self_.inputs = inputs
138+
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+
)

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
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 ObservabilityPipelineSplunkHecMetricsDestinationType(ModelSimple):
16+
"""
17+
The destination type. Always `splunk_hec_metrics`.
18+
19+
:param value: If omitted defaults to "splunk_hec_metrics". Must be one of ["splunk_hec_metrics"].
20+
:type value: str
21+
"""
22+
23+
allowed_values = {
24+
"splunk_hec_metrics",
25+
}
26+
SPLUNK_HEC_METRICS: ClassVar["ObservabilityPipelineSplunkHecMetricsDestinationType"]
27+
28+
@cached_property
29+
def openapi_types(_):
30+
return {
31+
"value": (str,),
32+
}
33+
34+
35+
ObservabilityPipelineSplunkHecMetricsDestinationType.SPLUNK_HEC_METRICS = (
36+
ObservabilityPipelineSplunkHecMetricsDestinationType("splunk_hec_metrics")
37+
)

0 commit comments

Comments
 (0)