Skip to content

Commit 8d6de14

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 2e28a6d of spec repo
1 parent 7c06034 commit 8d6de14

8 files changed

+228
-55
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43029,6 +43029,7 @@ components:
4302943029
ObservabilityPipelineConfigDestinationItem:
4303043030
description: "A destination for the pipeline."
4303143031
oneOf:
43032+
- $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestination"
4303243033
- $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestination"
4303343034
- $ref: "#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination"
4303443035
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3Destination"
@@ -43038,7 +43039,6 @@ components:
4303843039
- $ref: "#/components/schemas/ObservabilityPipelineCloudPremDestination"
4303943040
- $ref: "#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestination"
4304043041
- $ref: "#/components/schemas/ObservabilityPipelineDatadogLogsDestination"
43041-
- $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestination"
4304243042
- $ref: "#/components/schemas/ObservabilityPipelineGoogleChronicleDestination"
4304343043
- $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestination"
4304443044
- $ref: "#/components/schemas/ObservabilityPipelineGooglePubSubDestination"
@@ -43640,9 +43640,9 @@ components:
4364043640
type: object
4364143641
ObservabilityPipelineElasticsearchDestination:
4364243642
description: |-
43643-
The `elasticsearch` destination writes logs to an Elasticsearch cluster.
43643+
The `elasticsearch` destination writes logs or metrics to an Elasticsearch cluster.
4364443644

43645-
**Supported pipeline types:** logs
43645+
**Supported pipeline types:** logs, metrics
4364643646
properties:
4364743647
api_version:
4364843648
$ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationApiVersion"
@@ -43651,9 +43651,11 @@ components:
4365143651
buffer:
4365243652
$ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
4365343653
bulk_index:
43654-
description: The index to write logs to in Elasticsearch.
43654+
description: The name of the index to write events to in Elasticsearch.
4365543655
example: logs-index
4365643656
type: string
43657+
compression:
43658+
$ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationCompression"
4365743659
data_stream:
4365843660
$ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationDataStream"
4365943661
endpoint_url_key:
@@ -43664,21 +43666,34 @@ components:
4366443666
description: The unique identifier for this component.
4366543667
example: "elasticsearch-destination"
4366643668
type: string
43669+
id_key:
43670+
description: The name of the field used as the document ID in Elasticsearch.
43671+
example: id
43672+
type: string
4366743673
inputs:
4366843674
description: A list of component IDs whose output is used as the `input` for this component.
4366943675
example: ["filter-processor"]
4367043676
items:
4367143677
description: The ID of a component whose output is used as input for this destination.
4367243678
type: string
4367343679
type: array
43680+
pipeline:
43681+
description: The name of an Elasticsearch ingest pipeline to apply to events before indexing.
43682+
example: my-pipeline
43683+
type: string
43684+
request_retry_partial:
43685+
description: When `true`, retries failed partial bulk requests. This is useful when some events in a batch fail while others succeed.
43686+
type: boolean
43687+
tls:
43688+
$ref: "#/components/schemas/ObservabilityPipelineTls"
4367443689
type:
4367543690
$ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationType"
4367643691
required:
4367743692
- id
4367843693
- type
4367943694
- inputs
4368043695
type: object
43681-
x-pipeline-types: [logs]
43696+
x-pipeline-types: [logs, metrics]
4368243697
ObservabilityPipelineElasticsearchDestinationApiVersion:
4368343698
description: The Elasticsearch API version to use. Set to `auto` to auto-detect.
4368443699
enum: [auto, v6, v7, v8]
@@ -43707,18 +43722,35 @@ components:
4370743722
required:
4370843723
- strategy
4370943724
type: object
43725+
ObservabilityPipelineElasticsearchDestinationCompression:
43726+
description: Compression algorithm applied when sending data to Elasticsearch.
43727+
enum: [none, gzip, zlib, zstd, snappy]
43728+
example: gzip
43729+
type: string
43730+
x-enum-varnames:
43731+
- NONE
43732+
- GZIP
43733+
- ZLIB
43734+
- ZSTD
43735+
- SNAPPY
4371043736
ObservabilityPipelineElasticsearchDestinationDataStream:
4371143737
description: Configuration options for writing to Elasticsearch Data Streams instead of a fixed index.
4371243738
properties:
43739+
auto_routing:
43740+
description: When `true`, automatically routes events to the appropriate data stream based on the event content.
43741+
type: boolean
4371343742
dataset:
43714-
description: The data stream dataset for your logs. This groups logs by their source or application.
43743+
description: The data stream dataset. This groups events by their source or application.
4371543744
type: string
4371643745
dtype:
43717-
description: The data stream type for your logs. This determines how logs are categorized within the data stream.
43746+
description: The data stream type. This determines how events are categorized within the data stream.
4371843747
type: string
4371943748
namespace:
43720-
description: The data stream namespace for your logs. This separates logs into different environments or domains.
43749+
description: The data stream namespace. This separates events into different environments or domains.
4372143750
type: string
43751+
sync_fields:
43752+
description: When `true`, synchronizes data stream fields with the Elasticsearch index mapping.
43753+
type: boolean
4372243754
type: object
4372343755
ObservabilityPipelineElasticsearchDestinationType:
4372443756
default: elasticsearch

docs/datadog_api_client.v2.model.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19443,6 +19443,13 @@ datadog\_api\_client.v2.model.observability\_pipeline\_elasticsearch\_destinatio
1944319443
:members:
1944419444
:show-inheritance:
1944519445

19446+
datadog\_api\_client.v2.model.observability\_pipeline\_elasticsearch\_destination\_compression module
19447+
-----------------------------------------------------------------------------------------------------
19448+
19449+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_elasticsearch_destination_compression
19450+
:members:
19451+
:show-inheritance:
19452+
1944619453
datadog\_api\_client.v2.model.observability\_pipeline\_elasticsearch\_destination\_data\_stream module
1944719454
------------------------------------------------------------------------------------------------------
1944819455

src/datadog_api_client/v2/model/observability_pipeline_config.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@
2626
from datadog_api_client.v2.model.observability_pipeline_config_source_item import (
2727
ObservabilityPipelineConfigSourceItem,
2828
)
29+
from datadog_api_client.v2.model.observability_pipeline_elasticsearch_destination import (
30+
ObservabilityPipelineElasticsearchDestination,
31+
)
2932
from datadog_api_client.v2.model.observability_pipeline_http_client_destination import (
3033
ObservabilityPipelineHttpClientDestination,
3134
)
@@ -51,9 +54,6 @@
5154
from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination import (
5255
ObservabilityPipelineDatadogLogsDestination,
5356
)
54-
from datadog_api_client.v2.model.observability_pipeline_elasticsearch_destination import (
55-
ObservabilityPipelineElasticsearchDestination,
56-
)
5757
from datadog_api_client.v2.model.observability_pipeline_google_chronicle_destination import (
5858
ObservabilityPipelineGoogleChronicleDestination,
5959
)
@@ -172,6 +172,7 @@ def __init__(
172172
destinations: List[
173173
Union[
174174
ObservabilityPipelineConfigDestinationItem,
175+
ObservabilityPipelineElasticsearchDestination,
175176
ObservabilityPipelineHttpClientDestination,
176177
ObservabilityPipelineAmazonOpenSearchDestination,
177178
ObservabilityPipelineAmazonS3Destination,
@@ -181,7 +182,6 @@ def __init__(
181182
ObservabilityPipelineCloudPremDestination,
182183
ObservabilityPipelineCrowdStrikeNextGenSiemDestination,
183184
ObservabilityPipelineDatadogLogsDestination,
184-
ObservabilityPipelineElasticsearchDestination,
185185
ObservabilityPipelineGoogleChronicleDestination,
186186
ObservabilityPipelineGoogleCloudStorageDestination,
187187
ObservabilityPipelineGooglePubSubDestination,

src/datadog_api_client/v2/model/observability_pipeline_config_destination_item.py

Lines changed: 46 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -15,52 +15,70 @@ def __init__(self, **kwargs):
1515
"""
1616
A destination for the pipeline.
1717
18-
:param auth_strategy: HTTP authentication strategy.
19-
:type auth_strategy: ObservabilityPipelineHttpClientDestinationAuthStrategy, optional
18+
:param api_version: The Elasticsearch API version to use. Set to `auto` to auto-detect.
19+
:type api_version: ObservabilityPipelineElasticsearchDestinationApiVersion, optional
2020
21-
:param compression: Compression configuration for HTTP requests.
22-
:type compression: ObservabilityPipelineHttpClientDestinationCompression, optional
21+
:param auth: Authentication settings for the Elasticsearch destination.
22+
When `strategy` is `basic`, use `username_key` and `password_key` to reference credentials stored in environment variables or secrets.
23+
:type auth: ObservabilityPipelineElasticsearchDestinationAuth, optional
2324
24-
:param custom_key: Name of the environment variable or secret that holds a custom header value (used with custom auth strategies).
25-
:type custom_key: str, optional
25+
:param buffer: Configuration for buffer settings on destination components.
26+
:type buffer: ObservabilityPipelineBufferOptions, optional
2627
27-
:param encoding: Encoding format for log events.
28-
:type encoding: ObservabilityPipelineHttpClientDestinationEncoding
28+
:param bulk_index: The name of the index to write events to in Elasticsearch.
29+
:type bulk_index: str, optional
30+
31+
:param compression: Compression algorithm applied when sending data to Elasticsearch.
32+
:type compression: ObservabilityPipelineElasticsearchDestinationCompression, optional
33+
34+
:param data_stream: Configuration options for writing to Elasticsearch Data Streams instead of a fixed index.
35+
:type data_stream: ObservabilityPipelineElasticsearchDestinationDataStream, optional
36+
37+
:param endpoint_url_key: Name of the environment variable or secret that holds the Elasticsearch endpoint URL.
38+
:type endpoint_url_key: str, optional
2939
3040
:param id: The unique identifier for this component.
3141
:type id: str
3242
33-
:param inputs: A list of component IDs whose output is used as the input for this component.
43+
:param id_key: The name of the field used as the document ID in Elasticsearch.
44+
:type id_key: str, optional
45+
46+
:param inputs: A list of component IDs whose output is used as the `input` for this component.
3447
:type inputs: [str]
3548
36-
:param password_key: Name of the environment variable or secret that holds the password (used when `auth_strategy` is `basic`).
37-
:type password_key: str, optional
49+
:param pipeline: The name of an Elasticsearch ingest pipeline to apply to events before indexing.
50+
:type pipeline: str, optional
51+
52+
:param request_retry_partial: When `true`, retries failed partial bulk requests. This is useful when some events in a batch fail while others succeed.
53+
:type request_retry_partial: bool, optional
3854
3955
:param tls: Configuration for enabling TLS encryption between the pipeline component and external services.
4056
:type tls: ObservabilityPipelineTls, optional
4157
58+
:param type: The destination type. The value should always be `elasticsearch`.
59+
:type type: ObservabilityPipelineElasticsearchDestinationType
60+
61+
:param auth_strategy: HTTP authentication strategy.
62+
:type auth_strategy: ObservabilityPipelineHttpClientDestinationAuthStrategy, optional
63+
64+
:param custom_key: Name of the environment variable or secret that holds a custom header value (used with custom auth strategies).
65+
:type custom_key: str, optional
66+
67+
:param encoding: Encoding format for log events.
68+
:type encoding: ObservabilityPipelineHttpClientDestinationEncoding
69+
70+
:param password_key: Name of the environment variable or secret that holds the password (used when `auth_strategy` is `basic`).
71+
:type password_key: str, optional
72+
4273
:param token_key: Name of the environment variable or secret that holds the bearer token (used when `auth_strategy` is `bearer`).
4374
:type token_key: str, optional
4475
45-
:param type: The destination type. The value should always be `http_client`.
46-
:type type: ObservabilityPipelineHttpClientDestinationType
47-
4876
:param uri_key: Name of the environment variable or secret that holds the HTTP endpoint URI.
4977
:type uri_key: str, optional
5078
5179
:param username_key: Name of the environment variable or secret that holds the username (used when `auth_strategy` is `basic`).
5280
:type username_key: str, optional
5381
54-
:param auth: Authentication settings for the Amazon OpenSearch destination.
55-
The `strategy` field determines whether basic or AWS-based authentication is used.
56-
:type auth: ObservabilityPipelineAmazonOpenSearchDestinationAuth
57-
58-
:param buffer: Configuration for buffer settings on destination components.
59-
:type buffer: ObservabilityPipelineBufferOptions, optional
60-
61-
:param bulk_index: The index to write logs to.
62-
:type bulk_index: str, optional
63-
6482
:param bucket: S3 bucket name.
6583
:type bucket: str
6684
@@ -88,18 +106,9 @@ def __init__(self, **kwargs):
88106
:param container_name: The name of the Azure Blob Storage container to store logs in.
89107
:type container_name: str
90108
91-
:param endpoint_url_key: Name of the environment variable or secret that holds the CloudPrem endpoint URL.
92-
:type endpoint_url_key: str, optional
93-
94109
:param routes: A list of routing rules that forward matching logs to Datadog using dedicated API keys.
95110
:type routes: [ObservabilityPipelineDatadogLogsDestinationRoute], optional
96111
97-
:param api_version: The Elasticsearch API version to use. Set to `auto` to auto-detect.
98-
:type api_version: ObservabilityPipelineElasticsearchDestinationApiVersion, optional
99-
100-
:param data_stream: Configuration options for writing to Elasticsearch Data Streams instead of a fixed index.
101-
:type data_stream: ObservabilityPipelineElasticsearchDestinationDataStream, optional
102-
103112
:param customer_id: The Google Chronicle customer ID.
104113
:type customer_id: str
105114
@@ -217,6 +226,9 @@ def _composed_schemas(_):
217226
# code would be run when this module is imported, and these composed
218227
# classes don't exist yet because their module has not finished
219228
# loading
229+
from datadog_api_client.v2.model.observability_pipeline_elasticsearch_destination import (
230+
ObservabilityPipelineElasticsearchDestination,
231+
)
220232
from datadog_api_client.v2.model.observability_pipeline_http_client_destination import (
221233
ObservabilityPipelineHttpClientDestination,
222234
)
@@ -242,9 +254,6 @@ def _composed_schemas(_):
242254
from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination import (
243255
ObservabilityPipelineDatadogLogsDestination,
244256
)
245-
from datadog_api_client.v2.model.observability_pipeline_elasticsearch_destination import (
246-
ObservabilityPipelineElasticsearchDestination,
247-
)
248257
from datadog_api_client.v2.model.observability_pipeline_google_chronicle_destination import (
249258
ObservabilityPipelineGoogleChronicleDestination,
250259
)
@@ -288,6 +297,7 @@ def _composed_schemas(_):
288297

289298
return {
290299
"oneOf": [
300+
ObservabilityPipelineElasticsearchDestination,
291301
ObservabilityPipelineHttpClientDestination,
292302
ObservabilityPipelineAmazonOpenSearchDestination,
293303
ObservabilityPipelineAmazonS3Destination,
@@ -297,7 +307,6 @@ def _composed_schemas(_):
297307
ObservabilityPipelineCloudPremDestination,
298308
ObservabilityPipelineCrowdStrikeNextGenSiemDestination,
299309
ObservabilityPipelineDatadogLogsDestination,
300-
ObservabilityPipelineElasticsearchDestination,
301310
ObservabilityPipelineGoogleChronicleDestination,
302311
ObservabilityPipelineGoogleCloudStorageDestination,
303312
ObservabilityPipelineGooglePubSubDestination,

0 commit comments

Comments
 (0)