Support an optional description field on SDS rule patterns

.generator/schemas/v2/openapi.yaml

@@ -37907,6 +37907,11 @@ components:
     ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions:
       description: Options for defining a custom regex pattern.
       properties:
+        description:
+          description: Human-readable description providing context about a sensitive
+            data scanner rule
+          example: "Custom regex for internal API\u202Fkeys"
+          type: string
         rule:
           description: A regular expression used to detect sensitive values. Must
             be a valid regex.
@@ -37962,6 +37967,11 @@ components:
       description: Options for selecting a predefined library pattern and enabling
         keyword support.
       properties:
+        description:
+          description: Human-readable description providing context about a sensitive
+            data scanner rule
+          example: Credit card pattern
+          type: string
         id:
           description: Identifier for a predefined pattern from the sensitive data
             scanner pattern library.

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

@@ -19,12 +19,16 @@
 
 /** Options for defining a custom regex pattern. */
 @JsonPropertyOrder({
+  ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions.JSON_PROPERTY_DESCRIPTION,
   ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions.JSON_PROPERTY_RULE
 })
 @jakarta.annotation.Generated(
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
 public class ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions {
   @JsonIgnore public boolean unparsed = false;
+  public static final String JSON_PROPERTY_DESCRIPTION = "description";
+  private String description;
+
   public static final String JSON_PROPERTY_RULE = "rule";
   private String rule;
 
@@ -36,6 +40,28 @@ public ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions(
     this.rule = rule;
   }
 
+  public ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions description(
+      String description) {
+    this.description = description;
+    return this;
+  }
+
+  /**
+   * Human-readable description providing context about a sensitive data scanner rule
+   *
+   * @return description
+   */
+  @jakarta.annotation.Nullable
+  @JsonProperty(JSON_PROPERTY_DESCRIPTION)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public String getDescription() {
+    return description;
+  }
+
+  public void setDescription(String description) {
+    this.description = description;
+  }
+
   public ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions rule(String rule) {
     this.rule = rule;
     return this;
@@ -119,6 +145,9 @@ public boolean equals(Object o) {
         observabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions =
             (ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions) o;
     return Objects.equals(
+            this.description,
+            observabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions.description)
+        && Objects.equals(
             this.rule, observabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions.rule)
         && Objects.equals(
             this.additionalProperties,
@@ -128,13 +157,14 @@ public boolean equals(Object o) {
 
   @Override
   public int hashCode() {
-    return Objects.hash(rule, additionalProperties);
+    return Objects.hash(description, rule, additionalProperties);
   }
 
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
     sb.append("class ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions {\n");
+    sb.append("    description: ").append(toIndentedString(description)).append("\n");
     sb.append("    rule: ").append(toIndentedString(rule)).append("\n");
     sb.append("    additionalProperties: ")
         .append(toIndentedString(additionalProperties))

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

@@ -19,6 +19,7 @@
 
 /** Options for selecting a predefined library pattern and enabling keyword support. */
 @JsonPropertyOrder({
+  ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions.JSON_PROPERTY_DESCRIPTION,
   ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions.JSON_PROPERTY_ID,
   ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions
       .JSON_PROPERTY_USE_RECOMMENDED_KEYWORDS
@@ -27,6 +28,9 @@
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
 public class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions {
   @JsonIgnore public boolean unparsed = false;
+  public static final String JSON_PROPERTY_DESCRIPTION = "description";
+  private String description;
+
   public static final String JSON_PROPERTY_ID = "id";
   private String id;
 
@@ -41,6 +45,28 @@ public ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions(
     this.id = id;
   }
 
+  public ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions description(
+      String description) {
+    this.description = description;
+    return this;
+  }
+
+  /**
+   * Human-readable description providing context about a sensitive data scanner rule
+   *
+   * @return description
+   */
+  @jakarta.annotation.Nullable
+  @JsonProperty(JSON_PROPERTY_DESCRIPTION)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public String getDescription() {
+    return description;
+  }
+
+  public void setDescription(String description) {
+    this.description = description;
+  }
+
   public ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions id(String id) {
     this.id = id;
     return this;
@@ -146,6 +172,9 @@ public boolean equals(Object o) {
         observabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions =
             (ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions) o;
     return Objects.equals(
+            this.description,
+            observabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions.description)
+        && Objects.equals(
             this.id, observabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions.id)
         && Objects.equals(
             this.useRecommendedKeywords,
@@ -159,13 +188,14 @@ public boolean equals(Object o) {
 
   @Override
   public int hashCode() {
-    return Objects.hash(id, useRecommendedKeywords, additionalProperties);
+    return Objects.hash(description, id, useRecommendedKeywords, additionalProperties);
   }
 
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
     sb.append("class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions {\n");
+    sb.append("    description: ").append(toIndentedString(description)).append("\n");
     sb.append("    id: ").append(toIndentedString(id)).append("\n");
     sb.append("    useRecommendedKeywords: ")
         .append(toIndentedString(useRecommendedKeywords))

src/test/resources/cassettes/features/v2/Create_a_new_pipeline_returns_Bad_Request_response.freeze

@@ -1 +1 @@
-2025-12-18T16:15:15.575Z
+2025-12-23T13:57:28.936Z

src/test/resources/cassettes/features/v2/Create_a_new_pipeline_returns_Bad_Request_response.json

@@ -7,7 +7,7 @@
       },
       "headers": {},
       "method": "POST",
-      "path": "/api/v2/remote_config/products/obs_pipelines/pipelines",
+      "path": "/api/v2/obs-pipelines/pipelines",
       "keepAlive": false,
       "secure": true
     },
@@ -27,6 +27,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "95a57011-26df-3343-b440-f0295430ff3b"
+    "id": "f570a090-dc8d-8dc9-a94c-5375590acb1d"
   }
 ]

src/test/resources/cassettes/features/v2/Create_a_new_pipeline_returns_OK_response.freeze

@@ -1 +1 @@
-2025-12-18T16:15:16.062Z
+2025-12-23T13:57:29.402Z

src/test/resources/cassettes/features/v2/Create_a_new_pipeline_returns_OK_response.json

@@ -7,12 +7,12 @@
       },
       "headers": {},
       "method": "POST",
-      "path": "/api/v2/remote_config/products/obs_pipelines/pipelines",
+      "path": "/api/v2/obs-pipelines/pipelines",
       "keepAlive": false,
       "secure": true
     },
     "httpResponse": {
-      "body": "{\"data\":{\"id\":\"bd8d693c-dc2c-11f0-bf69-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"my-processor-group\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"enabled\":true,\"id\":\"my-processor-group\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
+      "body": "{\"data\":{\"id\":\"524b89d6-e007-11f0-8e9d-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"my-processor-group\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"enabled\":true,\"id\":\"my-processor-group\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
       "headers": {
         "Content-Type": [
           "application/vnd.api+json"
@@ -27,13 +27,13 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "2cc7f51a-ea1a-7fda-97ed-d909fad481a4"
+    "id": "060acb65-7a12-b2a9-8635-609549001241"
   },
   {
     "httpRequest": {
       "headers": {},
       "method": "DELETE",
-      "path": "/api/v2/remote_config/products/obs_pipelines/pipelines/bd8d693c-dc2c-11f0-bf69-da7ad0900002",
+      "path": "/api/v2/obs-pipelines/pipelines/524b89d6-e007-11f0-8e9d-da7ad0900002",
       "keepAlive": false,
       "secure": true
     },
@@ -52,6 +52,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "9d38f9f7-007b-c09a-6053-3acbf9ac24b4"
+    "id": "8a98ca6d-c296-f594-a26c-4ce6460ba67e"
   }
 ]

src/test/resources/cassettes/features/v2/Delete_a_pipeline_returns_Not_Found_response.freeze

@@ -1 +1 @@
-2025-12-18T16:15:17.165Z
+2025-12-23T13:57:30.502Z

src/test/resources/cassettes/features/v2/Delete_a_pipeline_returns_Not_Found_response.json

@@ -3,7 +3,7 @@
     "httpRequest": {
       "headers": {},
       "method": "DELETE",
-      "path": "/api/v2/remote_config/products/obs_pipelines/pipelines/3fa85f64-5717-4562-b3fc-2c963f66afa6",
+      "path": "/api/v2/obs-pipelines/pipelines/3fa85f64-5717-4562-b3fc-2c963f66afa6",
       "keepAlive": false,
       "secure": true
     },
@@ -23,6 +23,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "d504871e-95a9-3921-d8b6-426d67fce395"
+    "id": "5d00cc15-9785-8838-1fbb-b4a1545c67cc"
   }
 ]

src/test/resources/cassettes/features/v2/Delete_a_pipeline_returns_OK_response.freeze

@@ -1 +1 @@
-2025-12-18T16:15:17.716Z
+2025-12-23T13:57:31.004Z

src/test/resources/cassettes/features/v2/Delete_a_pipeline_returns_OK_response.json

@@ -7,12 +7,12 @@
       },
       "headers": {},
       "method": "POST",
-      "path": "/api/v2/remote_config/products/obs_pipelines/pipelines",
+      "path": "/api/v2/obs-pipelines/pipelines",
       "keepAlive": false,
       "secure": true
     },
     "httpResponse": {
-      "body": "{\"data\":{\"id\":\"be89fea4-dc2c-11f0-bdea-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
+      "body": "{\"data\":{\"id\":\"533d1e9a-e007-11f0-a813-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
       "headers": {
         "Content-Type": [
           "application/vnd.api+json"
@@ -27,13 +27,13 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "d6a6f7a2-f347-564f-cbfb-e972ad921c9a"
+    "id": "9ecc9b2e-1386-d424-2d27-09de086642de"
   },
   {
     "httpRequest": {
       "headers": {},
       "method": "DELETE",
-      "path": "/api/v2/remote_config/products/obs_pipelines/pipelines/be89fea4-dc2c-11f0-bdea-da7ad0900002",
+      "path": "/api/v2/obs-pipelines/pipelines/533d1e9a-e007-11f0-a813-da7ad0900002",
       "keepAlive": false,
       "secure": true
     },
@@ -52,13 +52,13 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "2f02fb97-f9e3-4f3a-313a-6d3e4dc210d9"
+    "id": "7b3a9bbd-3bb8-5cd4-1d3d-d46ade663410"
   },
   {
     "httpRequest": {
       "headers": {},
       "method": "DELETE",
-      "path": "/api/v2/remote_config/products/obs_pipelines/pipelines/be89fea4-dc2c-11f0-bdea-da7ad0900002",
+      "path": "/api/v2/obs-pipelines/pipelines/533d1e9a-e007-11f0-a813-da7ad0900002",
       "keepAlive": false,
       "secure": true
     },
@@ -78,6 +78,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "2f02fb97-f9e3-4f3a-313a-6d3e4dc210da"
+    "id": "7b3a9bbd-3bb8-5cd4-1d3d-d46ade663411"
   }
 ]

src/test/resources/cassettes/features/v2/Get_a_specific_pipeline_returns_OK_response.freeze

@@ -1 +1 @@
-2025-12-18T16:15:20.018Z
+2025-12-23T13:57:33.162Z

src/test/resources/cassettes/features/v2/Get_a_specific_pipeline_returns_OK_response.json

@@ -7,12 +7,12 @@
       },
       "headers": {},
       "method": "POST",
-      "path": "/api/v2/remote_config/products/obs_pipelines/pipelines",
+      "path": "/api/v2/obs-pipelines/pipelines",
       "keepAlive": false,
       "secure": true
     },
     "httpResponse": {
-      "body": "{\"data\":{\"id\":\"bfe664a4-dc2c-11f0-bdec-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
+      "body": "{\"data\":{\"id\":\"548721ec-e007-11f0-9055-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
       "headers": {
         "Content-Type": [
           "application/vnd.api+json"
@@ -27,18 +27,18 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "d6a6f7a2-f347-564f-cbfb-e972ad921c98"
+    "id": "9ecc9b2e-1386-d424-2d27-09de086642dc"
   },
   {
     "httpRequest": {
       "headers": {},
       "method": "GET",
-      "path": "/api/v2/remote_config/products/obs_pipelines/pipelines/bfe664a4-dc2c-11f0-bdec-da7ad0900002",
+      "path": "/api/v2/obs-pipelines/pipelines/548721ec-e007-11f0-9055-da7ad0900002",
       "keepAlive": false,
       "secure": true
     },
     "httpResponse": {
-      "body": "{\"data\":{\"id\":\"bfe664a4-dc2c-11f0-bdec-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
+      "body": "{\"data\":{\"id\":\"548721ec-e007-11f0-9055-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
       "headers": {
         "Content-Type": [
           "application/vnd.api+json"
@@ -53,13 +53,13 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "21f7e5ab-ea39-6e8e-5605-c43a9e3acdd0"
+    "id": "0f64f0b3-245a-fdf7-aed2-93b8f747da64"
   },
   {
     "httpRequest": {
       "headers": {},
       "method": "DELETE",
-      "path": "/api/v2/remote_config/products/obs_pipelines/pipelines/bfe664a4-dc2c-11f0-bdec-da7ad0900002",
+      "path": "/api/v2/obs-pipelines/pipelines/548721ec-e007-11f0-9055-da7ad0900002",
       "keepAlive": false,
       "secure": true
     },
@@ -78,6 +78,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "83781d2a-55f3-79d9-1709-474817512e21"
+    "id": "fd58517c-60e2-a86c-bdc3-b86f5d89ac1e"
   }
 ]

src/test/resources/cassettes/features/v2/List_pipelines_returns_Bad_Request_response.freeze

@@ -1 +1 @@
-2025-12-18T16:15:22.038Z
+2025-12-23T13:57:35.329Z