Skip to content

Commit f0eca9f

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Observability Pipelines - Updating descriptions and making the tags field optional not required (#3533)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 9eb48ca commit f0eca9f

6 files changed

+23
-18
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44218,7 +44218,10 @@ components:
4421844218
action:
4421944219
$ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction"
4422044220
options:
44221-
description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionHash` `options`.
44221+
description: |-
44222+
Optional settings for the hash action. When omitted or empty, matched sensitive data is
44223+
replaced with a deterministic hashed value that preserves structure for analytics while
44224+
protecting the original content. Reserved for future hash configuration (for example, algorithm or salt).
4422244225
type: object
4422344226
required: [action]
4422444227
type: object
@@ -44249,7 +44252,7 @@ components:
4424944252
description: Controls how partial redaction is applied, including character count and direction.
4425044253
properties:
4425144254
characters:
44252-
description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions` `characters`.
44255+
description: Number of characters to leave visible from the start or end of the matched value; the rest are redacted.
4425344256
example: 4
4425444257
format: int64
4425544258
type: integer
@@ -44285,7 +44288,7 @@ components:
4428544288
description: Configuration for fully redacting sensitive data.
4428644289
properties:
4428744290
replace:
44288-
description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions` `replace`.
44291+
description: The string used to replace matched sensitive data (for example, "***" or "[REDACTED]").
4428944292
example: "***"
4429044293
type: string
4429144294
required: [replace]
@@ -44395,7 +44398,6 @@ components:
4439544398
type: array
4439644399
required:
4439744400
- name
44398-
- tags
4439944401
- pattern
4440044402
- scope
4440144403
- on_match
@@ -44456,7 +44458,7 @@ components:
4445644458
description: Fields to which the scope rule applies.
4445744459
properties:
4445844460
fields:
44459-
description: The `ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions` `fields`.
44461+
description: List of log attribute names (field paths) to which the scope applies. Only these fields are included in or excluded from pattern matching.
4446044462
example:
4446144463
- ""
4446244464
items:

src/main/java/com/datadog/api/client/v2/model/ObservabilityPipelineSensitiveDataScannerProcessorActionHash.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,10 @@ public ObservabilityPipelineSensitiveDataScannerProcessorActionHash options(Obje
7474
}
7575

7676
/**
77-
* The <code>ObservabilityPipelineSensitiveDataScannerProcessorActionHash</code> <code>options
78-
* </code>.
77+
* Optional settings for the hash action. When omitted or empty, matched sensitive data is
78+
* replaced with a deterministic hashed value that preserves structure for analytics while
79+
* protecting the original content. Reserved for future hash configuration (for example, algorithm
80+
* or salt).
7981
*
8082
* @return options
8183
*/

src/main/java/com/datadog/api/client/v2/model/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ public ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOpti
5555
}
5656

5757
/**
58-
* The <code>ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions</code>
59-
* <code>characters</code>.
58+
* Number of characters to leave visible from the start or end of the matched value; the rest are
59+
* redacted.
6060
*
6161
* @return characters
6262
*/

src/main/java/com/datadog/api/client/v2/model/ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ public ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions rep
4343
}
4444

4545
/**
46-
* The <code>ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions</code> <code>
47-
* replace</code>.
46+
* The string used to replace matched sensitive data (for example, "***" or "[REDACTED]").
4847
*
4948
* @return replace
5049
*/

src/main/java/com/datadog/api/client/v2/model/ObservabilityPipelineSensitiveDataScannerProcessorRule.java

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public class ObservabilityPipelineSensitiveDataScannerProcessorRule {
5151
private ObservabilityPipelineSensitiveDataScannerProcessorScope scope;
5252

5353
public static final String JSON_PROPERTY_TAGS = "tags";
54-
private List<String> tags = new ArrayList<>();
54+
private List<String> tags = null;
5555

5656
public ObservabilityPipelineSensitiveDataScannerProcessorRule() {}
5757

@@ -63,16 +63,14 @@ public ObservabilityPipelineSensitiveDataScannerProcessorRule(
6363
@JsonProperty(required = true, value = JSON_PROPERTY_PATTERN)
6464
ObservabilityPipelineSensitiveDataScannerProcessorPattern pattern,
6565
@JsonProperty(required = true, value = JSON_PROPERTY_SCOPE)
66-
ObservabilityPipelineSensitiveDataScannerProcessorScope scope,
67-
@JsonProperty(required = true, value = JSON_PROPERTY_TAGS) List<String> tags) {
66+
ObservabilityPipelineSensitiveDataScannerProcessorScope scope) {
6867
this.name = name;
6968
this.onMatch = onMatch;
7069
this.unparsed |= onMatch.unparsed;
7170
this.pattern = pattern;
7271
this.unparsed |= pattern.unparsed;
7372
this.scope = scope;
7473
this.unparsed |= scope.unparsed;
75-
this.tags = tags;
7674
}
7775

7876
public ObservabilityPipelineSensitiveDataScannerProcessorRule keywordOptions(
@@ -192,6 +190,9 @@ public ObservabilityPipelineSensitiveDataScannerProcessorRule tags(List<String>
192190
}
193191

194192
public ObservabilityPipelineSensitiveDataScannerProcessorRule addTagsItem(String tagsItem) {
193+
if (this.tags == null) {
194+
this.tags = new ArrayList<>();
195+
}
195196
this.tags.add(tagsItem);
196197
return this;
197198
}
@@ -201,8 +202,9 @@ public ObservabilityPipelineSensitiveDataScannerProcessorRule addTagsItem(String
201202
*
202203
* @return tags
203204
*/
205+
@jakarta.annotation.Nullable
204206
@JsonProperty(JSON_PROPERTY_TAGS)
205-
@JsonInclude(value = JsonInclude.Include.ALWAYS)
207+
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
206208
public List<String> getTags() {
207209
return tags;
208210
}

src/main/java/com/datadog/api/client/v2/model/ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ public ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions addFieldsI
5151
}
5252

5353
/**
54-
* The <code>ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions</code> <code>fields
55-
* </code>.
54+
* List of log attribute names (field paths) to which the scope applies. Only these fields are
55+
* included in or excluded from pattern matching.
5656
*
5757
* @return fields
5858
*/

0 commit comments

Comments
 (0)