Skip to content

Commit 365cdc3

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit fc2edb6 of spec repo
1 parent d538076 commit 365cdc3

8 files changed

Lines changed: 218 additions & 16 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 53 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 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,48 @@ components:
4370743722
required:
4370843723
- strategy
4370943724
type: object
43725+
ObservabilityPipelineElasticsearchDestinationCompression:
43726+
description: Compression configuration for the Elasticsearch destination.
43727+
properties:
43728+
algorithm:
43729+
$ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm"
43730+
level:
43731+
description: The compression level. Only applicable for `gzip`, `zlib`, and `zstd` algorithms.
43732+
example: 6
43733+
format: int64
43734+
type: integer
43735+
required:
43736+
- algorithm
43737+
type: object
43738+
ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm:
43739+
description: The compression algorithm applied when sending data to Elasticsearch.
43740+
enum: [none, gzip, zlib, zstd, snappy]
43741+
example: gzip
43742+
type: string
43743+
x-enum-varnames:
43744+
- NONE
43745+
- GZIP
43746+
- ZLIB
43747+
- ZSTD
43748+
- SNAPPY
4371043749
ObservabilityPipelineElasticsearchDestinationDataStream:
4371143750
description: Configuration options for writing to Elasticsearch Data Streams instead of a fixed index.
4371243751
properties:
43752+
auto_routing:
43753+
description: When `true`, automatically routes events to the appropriate data stream based on the event content.
43754+
type: boolean
4371343755
dataset:
43714-
description: The data stream dataset for your logs. This groups logs by their source or application.
43756+
description: The data stream dataset. This groups events by their source or application.
4371543757
type: string
4371643758
dtype:
43717-
description: The data stream type for your logs. This determines how logs are categorized within the data stream.
43759+
description: The data stream type. This determines how events are categorized within the data stream.
4371843760
type: string
4371943761
namespace:
43720-
description: The data stream namespace for your logs. This separates logs into different environments or domains.
43762+
description: The data stream namespace. This separates events into different environments or domains.
4372143763
type: string
43764+
sync_fields:
43765+
description: When `true`, synchronizes data stream fields with the Elasticsearch index mapping.
43766+
type: boolean
4372243767
type: object
4372343768
ObservabilityPipelineElasticsearchDestinationType:
4372443769
default: elasticsearch

packages/datadog-api-client-v2/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4033,6 +4033,8 @@ export { ObservabilityPipelineDiskBufferOptions } from "./models/ObservabilityPi
40334033
export { ObservabilityPipelineElasticsearchDestination } from "./models/ObservabilityPipelineElasticsearchDestination";
40344034
export { ObservabilityPipelineElasticsearchDestinationApiVersion } from "./models/ObservabilityPipelineElasticsearchDestinationApiVersion";
40354035
export { ObservabilityPipelineElasticsearchDestinationAuth } from "./models/ObservabilityPipelineElasticsearchDestinationAuth";
4036+
export { ObservabilityPipelineElasticsearchDestinationCompression } from "./models/ObservabilityPipelineElasticsearchDestinationCompression";
4037+
export { ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm } from "./models/ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm";
40364038
export { ObservabilityPipelineElasticsearchDestinationDataStream } from "./models/ObservabilityPipelineElasticsearchDestinationDataStream";
40374039
export { ObservabilityPipelineElasticsearchDestinationType } from "./models/ObservabilityPipelineElasticsearchDestinationType";
40384040
export { ObservabilityPipelineEnrichmentTableFile } from "./models/ObservabilityPipelineEnrichmentTableFile";

packages/datadog-api-client-v2/models/ObjectSerializer.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2127,6 +2127,7 @@ import { ObservabilityPipelineDedupeProcessorCache } from "./ObservabilityPipeli
21272127
import { ObservabilityPipelineDiskBufferOptions } from "./ObservabilityPipelineDiskBufferOptions";
21282128
import { ObservabilityPipelineElasticsearchDestination } from "./ObservabilityPipelineElasticsearchDestination";
21292129
import { ObservabilityPipelineElasticsearchDestinationAuth } from "./ObservabilityPipelineElasticsearchDestinationAuth";
2130+
import { ObservabilityPipelineElasticsearchDestinationCompression } from "./ObservabilityPipelineElasticsearchDestinationCompression";
21302131
import { ObservabilityPipelineElasticsearchDestinationDataStream } from "./ObservabilityPipelineElasticsearchDestinationDataStream";
21312132
import { ObservabilityPipelineEnrichmentTableFile } from "./ObservabilityPipelineEnrichmentTableFile";
21322133
import { ObservabilityPipelineEnrichmentTableFileEncoding } from "./ObservabilityPipelineEnrichmentTableFileEncoding";
@@ -4658,6 +4659,13 @@ const enumsMap: { [key: string]: any[] } = {
46584659
"v7",
46594660
"v8",
46604661
],
4662+
ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm: [
4663+
"none",
4664+
"gzip",
4665+
"zlib",
4666+
"zstd",
4667+
"snappy",
4668+
],
46614669
ObservabilityPipelineElasticsearchDestinationType: ["elasticsearch"],
46624670
ObservabilityPipelineEnrichmentTableFileEncodingType: ["csv"],
46634671
ObservabilityPipelineEnrichmentTableFileKeyItemsComparison: ["equals"],
@@ -8280,6 +8288,8 @@ const typeMap: { [index: string]: any } = {
82808288
ObservabilityPipelineElasticsearchDestination,
82818289
ObservabilityPipelineElasticsearchDestinationAuth:
82828290
ObservabilityPipelineElasticsearchDestinationAuth,
8291+
ObservabilityPipelineElasticsearchDestinationCompression:
8292+
ObservabilityPipelineElasticsearchDestinationCompression,
82838293
ObservabilityPipelineElasticsearchDestinationDataStream:
82848294
ObservabilityPipelineElasticsearchDestinationDataStream,
82858295
ObservabilityPipelineEnrichmentTableFile:
@@ -10476,6 +10486,7 @@ const oneOfMap: { [index: string]: string[] } = {
1047610486
"ObservabilityPipelineMemoryBufferSizeOptions",
1047710487
],
1047810488
ObservabilityPipelineConfigDestinationItem: [
10489+
"ObservabilityPipelineElasticsearchDestination",
1047910490
"ObservabilityPipelineHttpClientDestination",
1048010491
"ObservabilityPipelineAmazonOpenSearchDestination",
1048110492
"ObservabilityPipelineAmazonS3Destination",
@@ -10485,7 +10496,6 @@ const oneOfMap: { [index: string]: string[] } = {
1048510496
"ObservabilityPipelineCloudPremDestination",
1048610497
"ObservabilityPipelineCrowdStrikeNextGenSiemDestination",
1048710498
"ObservabilityPipelineDatadogLogsDestination",
10488-
"ObservabilityPipelineElasticsearchDestination",
1048910499
"ObservabilityPipelineGoogleChronicleDestination",
1049010500
"ObservabilityPipelineGoogleCloudStorageDestination",
1049110501
"ObservabilityPipelineGooglePubSubDestination",

packages/datadog-api-client-v2/models/ObservabilityPipelineConfigDestinationItem.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ import { UnparsedObject } from "../../datadog-api-client-common/util";
3535
*/
3636

3737
export type ObservabilityPipelineConfigDestinationItem =
38+
| ObservabilityPipelineElasticsearchDestination
3839
| ObservabilityPipelineHttpClientDestination
3940
| ObservabilityPipelineAmazonOpenSearchDestination
4041
| ObservabilityPipelineAmazonS3Destination
@@ -44,7 +45,6 @@ export type ObservabilityPipelineConfigDestinationItem =
4445
| ObservabilityPipelineCloudPremDestination
4546
| ObservabilityPipelineCrowdStrikeNextGenSiemDestination
4647
| ObservabilityPipelineDatadogLogsDestination
47-
| ObservabilityPipelineElasticsearchDestination
4848
| ObservabilityPipelineGoogleChronicleDestination
4949
| ObservabilityPipelineGoogleCloudStorageDestination
5050
| ObservabilityPipelineGooglePubSubDestination

packages/datadog-api-client-v2/models/ObservabilityPipelineElasticsearchDestination.ts

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,17 @@
66
import { ObservabilityPipelineBufferOptions } from "./ObservabilityPipelineBufferOptions";
77
import { ObservabilityPipelineElasticsearchDestinationApiVersion } from "./ObservabilityPipelineElasticsearchDestinationApiVersion";
88
import { ObservabilityPipelineElasticsearchDestinationAuth } from "./ObservabilityPipelineElasticsearchDestinationAuth";
9+
import { ObservabilityPipelineElasticsearchDestinationCompression } from "./ObservabilityPipelineElasticsearchDestinationCompression";
910
import { ObservabilityPipelineElasticsearchDestinationDataStream } from "./ObservabilityPipelineElasticsearchDestinationDataStream";
1011
import { ObservabilityPipelineElasticsearchDestinationType } from "./ObservabilityPipelineElasticsearchDestinationType";
12+
import { ObservabilityPipelineTls } from "./ObservabilityPipelineTls";
1113

1214
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1315

1416
/**
15-
* The `elasticsearch` destination writes logs to an Elasticsearch cluster.
17+
* The `elasticsearch` destination writes logs or metrics to an Elasticsearch cluster.
1618
*
17-
* **Supported pipeline types:** logs
19+
* **Supported pipeline types:** logs, metrics
1820
*/
1921
export class ObservabilityPipelineElasticsearchDestination {
2022
/**
@@ -31,9 +33,13 @@ export class ObservabilityPipelineElasticsearchDestination {
3133
*/
3234
"buffer"?: ObservabilityPipelineBufferOptions;
3335
/**
34-
* The index to write logs to in Elasticsearch.
36+
* The name of the index to write events to in Elasticsearch.
3537
*/
3638
"bulkIndex"?: string;
39+
/**
40+
* Compression configuration for the Elasticsearch destination.
41+
*/
42+
"compression"?: ObservabilityPipelineElasticsearchDestinationCompression;
3743
/**
3844
* Configuration options for writing to Elasticsearch Data Streams instead of a fixed index.
3945
*/
@@ -46,10 +52,26 @@ export class ObservabilityPipelineElasticsearchDestination {
4652
* The unique identifier for this component.
4753
*/
4854
"id": string;
55+
/**
56+
* The name of the field used as the document ID in Elasticsearch.
57+
*/
58+
"idKey"?: string;
4959
/**
5060
* A list of component IDs whose output is used as the `input` for this component.
5161
*/
5262
"inputs": Array<string>;
63+
/**
64+
* The name of an Elasticsearch ingest pipeline to apply to events before indexing.
65+
*/
66+
"pipeline"?: string;
67+
/**
68+
* When `true`, retries failed partial bulk requests when some events in a batch fail while others succeed.
69+
*/
70+
"requestRetryPartial"?: boolean;
71+
/**
72+
* Configuration for enabling TLS encryption between the pipeline component and external services.
73+
*/
74+
"tls"?: ObservabilityPipelineTls;
5375
/**
5476
* The destination type. The value should always be `elasticsearch`.
5577
*/
@@ -87,6 +109,10 @@ export class ObservabilityPipelineElasticsearchDestination {
87109
baseName: "bulk_index",
88110
type: "string",
89111
},
112+
compression: {
113+
baseName: "compression",
114+
type: "ObservabilityPipelineElasticsearchDestinationCompression",
115+
},
90116
dataStream: {
91117
baseName: "data_stream",
92118
type: "ObservabilityPipelineElasticsearchDestinationDataStream",
@@ -100,11 +126,27 @@ export class ObservabilityPipelineElasticsearchDestination {
100126
type: "string",
101127
required: true,
102128
},
129+
idKey: {
130+
baseName: "id_key",
131+
type: "string",
132+
},
103133
inputs: {
104134
baseName: "inputs",
105135
type: "Array<string>",
106136
required: true,
107137
},
138+
pipeline: {
139+
baseName: "pipeline",
140+
type: "string",
141+
},
142+
requestRetryPartial: {
143+
baseName: "request_retry_partial",
144+
type: "boolean",
145+
},
146+
tls: {
147+
baseName: "tls",
148+
type: "ObservabilityPipelineTls",
149+
},
108150
type: {
109151
baseName: "type",
110152
type: "ObservabilityPipelineElasticsearchDestinationType",
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
import { ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm } from "./ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm";
7+
8+
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
9+
10+
/**
11+
* Compression configuration for the Elasticsearch destination.
12+
*/
13+
export class ObservabilityPipelineElasticsearchDestinationCompression {
14+
/**
15+
* The compression algorithm applied when sending data to Elasticsearch.
16+
*/
17+
"algorithm": ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm;
18+
/**
19+
* The compression level. Only applicable for `gzip`, `zlib`, and `zstd` algorithms.
20+
*/
21+
"level"?: number;
22+
23+
/**
24+
* A container for additional, undeclared properties.
25+
* This is a holder for any undeclared properties as specified with
26+
* the 'additionalProperties' keyword in the OAS document.
27+
*/
28+
"additionalProperties"?: { [key: string]: any };
29+
30+
/**
31+
* @ignore
32+
*/
33+
"_unparsed"?: boolean;
34+
35+
/**
36+
* @ignore
37+
*/
38+
static readonly attributeTypeMap: AttributeTypeMap = {
39+
algorithm: {
40+
baseName: "algorithm",
41+
type: "ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm",
42+
required: true,
43+
},
44+
level: {
45+
baseName: "level",
46+
type: "number",
47+
format: "int64",
48+
},
49+
additionalProperties: {
50+
baseName: "additionalProperties",
51+
type: "{ [key: string]: any; }",
52+
},
53+
};
54+
55+
/**
56+
* @ignore
57+
*/
58+
static getAttributeTypeMap(): AttributeTypeMap {
59+
return ObservabilityPipelineElasticsearchDestinationCompression.attributeTypeMap;
60+
}
61+
62+
public constructor() {}
63+
}
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
7+
import { UnparsedObject } from "../../datadog-api-client-common/util";
8+
9+
/**
10+
* The compression algorithm applied when sending data to Elasticsearch.
11+
*/
12+
13+
export type ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm =
14+
| typeof NONE
15+
| typeof GZIP
16+
| typeof ZLIB
17+
| typeof ZSTD
18+
| typeof SNAPPY
19+
| UnparsedObject;
20+
export const NONE = "none";
21+
export const GZIP = "gzip";
22+
export const ZLIB = "zlib";
23+
export const ZSTD = "zstd";
24+
export const SNAPPY = "snappy";

0 commit comments

Comments
 (0)