Skip to content

Commit 432ed64

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add Observability Pipelines Amazon S3 Generic destination (#3609)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 4f6c8e2 commit 432ed64

17 files changed

+2909
-2
lines changed

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

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42075,6 +42075,191 @@ components:
4207542075
type: string
4207642076
x-enum-varnames:
4207742077
- AMAZON_S3
42078+
ObservabilityPipelineAmazonS3GenericBatchSettings:
42079+
description: Event batching settings
42080+
properties:
42081+
batch_size:
42082+
description: Maximum batch size in bytes.
42083+
example: 100000000
42084+
format: int64
42085+
type: integer
42086+
timeout_secs:
42087+
description: Maximum number of seconds to wait before flushing the batch.
42088+
example: 900
42089+
format: int64
42090+
type: integer
42091+
type: object
42092+
ObservabilityPipelineAmazonS3GenericCompression:
42093+
description: Compression algorithm applied to encoded logs.
42094+
oneOf:
42095+
- $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionZstd'
42096+
- $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionGzip'
42097+
- $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionSnappy'
42098+
ObservabilityPipelineAmazonS3GenericCompressionGzip:
42099+
description: Gzip compression.
42100+
properties:
42101+
algorithm:
42102+
$ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionGzipType'
42103+
level:
42104+
description: Gzip compression level.
42105+
example: 6
42106+
format: int64
42107+
type: integer
42108+
required:
42109+
- algorithm
42110+
- level
42111+
type: object
42112+
ObservabilityPipelineAmazonS3GenericCompressionGzipType:
42113+
default: gzip
42114+
description: The compression type. Always `gzip`.
42115+
enum:
42116+
- gzip
42117+
example: gzip
42118+
type: string
42119+
x-enum-varnames:
42120+
- GZIP
42121+
ObservabilityPipelineAmazonS3GenericCompressionSnappy:
42122+
description: Snappy compression.
42123+
properties:
42124+
algorithm:
42125+
$ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionSnappyType'
42126+
required:
42127+
- algorithm
42128+
type: object
42129+
ObservabilityPipelineAmazonS3GenericCompressionSnappyType:
42130+
default: snappy
42131+
description: The compression type. Always `snappy`.
42132+
enum:
42133+
- snappy
42134+
example: snappy
42135+
type: string
42136+
x-enum-varnames:
42137+
- SNAPPY
42138+
ObservabilityPipelineAmazonS3GenericCompressionZstd:
42139+
description: Zstd compression.
42140+
properties:
42141+
algorithm:
42142+
$ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionZstdType'
42143+
level:
42144+
description: Zstd compression level.
42145+
example: 3
42146+
format: int64
42147+
type: integer
42148+
required:
42149+
- algorithm
42150+
- level
42151+
type: object
42152+
ObservabilityPipelineAmazonS3GenericCompressionZstdType:
42153+
default: zstd
42154+
description: The compression type. Always `zstd`.
42155+
enum:
42156+
- zstd
42157+
example: zstd
42158+
type: string
42159+
x-enum-varnames:
42160+
- ZSTD
42161+
ObservabilityPipelineAmazonS3GenericDestination:
42162+
description: 'The `amazon_s3_generic` destination sends your logs to an Amazon
42163+
S3 bucket.
42164+
42165+
42166+
**Supported pipeline types:** logs'
42167+
properties:
42168+
auth:
42169+
$ref: '#/components/schemas/ObservabilityPipelineAwsAuth'
42170+
batch_settings:
42171+
$ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericBatchSettings'
42172+
bucket:
42173+
description: S3 bucket name.
42174+
example: my-bucket
42175+
type: string
42176+
compression:
42177+
$ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompression'
42178+
encoding:
42179+
$ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncoding'
42180+
id:
42181+
description: Unique identifier for the destination component.
42182+
example: generic-s3-destination
42183+
type: string
42184+
inputs:
42185+
description: A list of component IDs whose output is used as the `input`
42186+
for this component.
42187+
example:
42188+
- filter-processor
42189+
items:
42190+
type: string
42191+
type: array
42192+
key_prefix:
42193+
description: Optional prefix for object keys.
42194+
type: string
42195+
region:
42196+
description: AWS region of the S3 bucket.
42197+
example: us-east-1
42198+
type: string
42199+
storage_class:
42200+
$ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationStorageClass'
42201+
type:
42202+
$ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericDestinationType'
42203+
required:
42204+
- id
42205+
- type
42206+
- inputs
42207+
- bucket
42208+
- region
42209+
- storage_class
42210+
- encoding
42211+
- compression
42212+
type: object
42213+
x-pipeline-types:
42214+
- logs
42215+
ObservabilityPipelineAmazonS3GenericDestinationType:
42216+
default: amazon_s3_generic
42217+
description: The destination type. Always `amazon_s3_generic`.
42218+
enum:
42219+
- amazon_s3_generic
42220+
example: amazon_s3_generic
42221+
type: string
42222+
x-enum-varnames:
42223+
- GENERIC_ARCHIVES_S3
42224+
ObservabilityPipelineAmazonS3GenericEncoding:
42225+
description: Encoding format for the destination.
42226+
oneOf:
42227+
- $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingJson'
42228+
- $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingParquet'
42229+
ObservabilityPipelineAmazonS3GenericEncodingJson:
42230+
description: JSON encoding.
42231+
properties:
42232+
type:
42233+
$ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingJsonType'
42234+
required:
42235+
- type
42236+
type: object
42237+
ObservabilityPipelineAmazonS3GenericEncodingJsonType:
42238+
default: json
42239+
description: The encoding type. Always `json`.
42240+
enum:
42241+
- json
42242+
example: json
42243+
type: string
42244+
x-enum-varnames:
42245+
- JSON
42246+
ObservabilityPipelineAmazonS3GenericEncodingParquet:
42247+
description: Parquet encoding.
42248+
properties:
42249+
type:
42250+
$ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingParquetType'
42251+
required:
42252+
- type
42253+
type: object
42254+
ObservabilityPipelineAmazonS3GenericEncodingParquetType:
42255+
default: parquet
42256+
description: The encoding type. Always `parquet`.
42257+
enum:
42258+
- parquet
42259+
example: parquet
42260+
type: string
42261+
x-enum-varnames:
42262+
- PARQUET
4207842263
ObservabilityPipelineAmazonS3Source:
4207942264
description: 'The `amazon_s3` source ingests logs from an Amazon S3 bucket.
4208042265

@@ -42350,6 +42535,7 @@ components:
4235042535
- $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestination'
4235142536
- $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination'
4235242537
- $ref: '#/components/schemas/ObservabilityPipelineAmazonS3Destination'
42538+
- $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericDestination'
4235342539
- $ref: '#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestination'
4235442540
- $ref: '#/components/schemas/AzureStorageDestination'
4235542541
- $ref: '#/components/schemas/ObservabilityPipelineCloudPremDestination'

‎src/main/java/com/datadog/api/client/v2/model/ObservabilityPipelineAmazonS3GenericBatchSettings.java‎

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
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 2019-Present Datadog, Inc.
5+
*/
6+
7+
package com.datadog.api.client.v2.model;
8+
9+
import com.fasterxml.jackson.annotation.JsonAnyGetter;
10+
import com.fasterxml.jackson.annotation.JsonAnySetter;
11+
import com.fasterxml.jackson.annotation.JsonIgnore;
12+
import com.fasterxml.jackson.annotation.JsonInclude;
13+
import com.fasterxml.jackson.annotation.JsonProperty;
14+
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
15+
import java.util.HashMap;
16+
import java.util.Map;
17+
import java.util.Objects;
18+
19+
/** Event batching settings */
20+
@JsonPropertyOrder({
21+
ObservabilityPipelineAmazonS3GenericBatchSettings.JSON_PROPERTY_BATCH_SIZE,
22+
ObservabilityPipelineAmazonS3GenericBatchSettings.JSON_PROPERTY_TIMEOUT_SECS
23+
})
24+
@jakarta.annotation.Generated(
25+
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
26+
public class ObservabilityPipelineAmazonS3GenericBatchSettings {
27+
@JsonIgnore public boolean unparsed = false;
28+
public static final String JSON_PROPERTY_BATCH_SIZE = "batch_size";
29+
private Long batchSize;
30+
31+
public static final String JSON_PROPERTY_TIMEOUT_SECS = "timeout_secs";
32+
private Long timeoutSecs;
33+
34+
public ObservabilityPipelineAmazonS3GenericBatchSettings batchSize(Long batchSize) {
35+
this.batchSize = batchSize;
36+
return this;
37+
}
38+
39+
/**
40+
* Maximum batch size in bytes.
41+
*
42+
* @return batchSize
43+
*/
44+
@jakarta.annotation.Nullable
45+
@JsonProperty(JSON_PROPERTY_BATCH_SIZE)
46+
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
47+
public Long getBatchSize() {
48+
return batchSize;
49+
}
50+
51+
public void setBatchSize(Long batchSize) {
52+
this.batchSize = batchSize;
53+
}
54+
55+
public ObservabilityPipelineAmazonS3GenericBatchSettings timeoutSecs(Long timeoutSecs) {
56+
this.timeoutSecs = timeoutSecs;
57+
return this;
58+
}
59+
60+
/**
61+
* Maximum number of seconds to wait before flushing the batch.
62+
*
63+
* @return timeoutSecs
64+
*/
65+
@jakarta.annotation.Nullable
66+
@JsonProperty(JSON_PROPERTY_TIMEOUT_SECS)
67+
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
68+
public Long getTimeoutSecs() {
69+
return timeoutSecs;
70+
}
71+
72+
public void setTimeoutSecs(Long timeoutSecs) {
73+
this.timeoutSecs = timeoutSecs;
74+
}
75+
76+
/**
77+
* A container for additional, undeclared properties. This is a holder for any undeclared
78+
* properties as specified with the 'additionalProperties' keyword in the OAS document.
79+
*/
80+
private Map<String, Object> additionalProperties;
81+
82+
/**
83+
* Set the additional (undeclared) property with the specified name and value. If the property
84+
* does not already exist, create it otherwise replace it.
85+
*
86+
* @param key The arbitrary key to set
87+
* @param value The associated value
88+
* @return ObservabilityPipelineAmazonS3GenericBatchSettings
89+
*/
90+
@JsonAnySetter
91+
public ObservabilityPipelineAmazonS3GenericBatchSettings putAdditionalProperty(
92+
String key, Object value) {
93+
if (this.additionalProperties == null) {
94+
this.additionalProperties = new HashMap<String, Object>();
95+
}
96+
this.additionalProperties.put(key, value);
97+
return this;
98+
}
99+
100+
/**
101+
* Return the additional (undeclared) property.
102+
*
103+
* @return The additional properties
104+
*/
105+
@JsonAnyGetter
106+
public Map<String, Object> getAdditionalProperties() {
107+
return additionalProperties;
108+
}
109+
110+
/**
111+
* Return the additional (undeclared) property with the specified name.
112+
*
113+
* @param key The arbitrary key to get
114+
* @return The specific additional property for the given key
115+
*/
116+
public Object getAdditionalProperty(String key) {
117+
if (this.additionalProperties == null) {
118+
return null;
119+
}
120+
return this.additionalProperties.get(key);
121+
}
122+
123+
/** Return true if this ObservabilityPipelineAmazonS3GenericBatchSettings object is equal to o. */
124+
@Override
125+
public boolean equals(Object o) {
126+
if (this == o) {
127+
return true;
128+
}
129+
if (o == null || getClass() != o.getClass()) {
130+
return false;
131+
}
132+
ObservabilityPipelineAmazonS3GenericBatchSettings
133+
observabilityPipelineAmazonS3GenericBatchSettings =
134+
(ObservabilityPipelineAmazonS3GenericBatchSettings) o;
135+
return Objects.equals(
136+
this.batchSize, observabilityPipelineAmazonS3GenericBatchSettings.batchSize)
137+
&& Objects.equals(
138+
this.timeoutSecs, observabilityPipelineAmazonS3GenericBatchSettings.timeoutSecs)
139+
&& Objects.equals(
140+
this.additionalProperties,
141+
observabilityPipelineAmazonS3GenericBatchSettings.additionalProperties);
142+
}
143+
144+
@Override
145+
public int hashCode() {
146+
return Objects.hash(batchSize, timeoutSecs, additionalProperties);
147+
}
148+
149+
@Override
150+
public String toString() {
151+
StringBuilder sb = new StringBuilder();
152+
sb.append("class ObservabilityPipelineAmazonS3GenericBatchSettings {\n");
153+
sb.append(" batchSize: ").append(toIndentedString(batchSize)).append("\n");
154+
sb.append(" timeoutSecs: ").append(toIndentedString(timeoutSecs)).append("\n");
155+
sb.append(" additionalProperties: ")
156+
.append(toIndentedString(additionalProperties))
157+
.append("\n");
158+
sb.append('}');
159+
return sb.toString();
160+
}
161+
162+
/**
163+
* Convert the given object to string with each line indented by 4 spaces (except the first line).
164+
*/
165+
private String toIndentedString(Object o) {
166+
if (o == null) {
167+
return "null";
168+
}
169+
return o.toString().replace("\n", "\n ");
170+
}
171+
}

0 commit comments

Comments
 (0)