Add tag exclusion field to metrics configuration API (#1134)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-31 16:58:26.143114",
-            "spec_repo_commit": "781a7cfb"
+            "regenerated": "2023-11-02 14:42:13.569022",
+            "spec_repo_commit": "97ff7561"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-31 16:58:26.164106",
-            "spec_repo_commit": "781a7cfb"
+            "regenerated": "2023-11-02 14:42:13.589318",
+            "spec_repo_commit": "97ff7561"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -9530,6 +9530,15 @@ components:
       properties:
         emails:
           $ref: '#/components/schemas/MetricBulkTagConfigEmailList'
+        exclude_tags_mode:
+          description: 'When set to true, the configuration will exclude the configured
+            tags and include any other submitted tags.
+
+            When set to false, the configuration will include the configured tags
+            and exclude any other submitted tags.
+
+            Defaults to false.'
+          type: boolean
         tags:
           $ref: '#/components/schemas/MetricBulkTagConfigTagNameList'
       type: object
@@ -9610,6 +9619,13 @@ components:
       properties:
         emails:
           $ref: '#/components/schemas/MetricBulkTagConfigEmailList'
+        exclude_tags_mode:
+          description: 'When set to true, the configuration will exclude the configured
+            tags and include any other submitted tags.
+
+            When set to false, the configuration will include the configured tags
+            and exclude any other submitted tags.'
+          type: boolean
         status:
           description: The status of the request.
           example: Accepted
@@ -10074,6 +10090,15 @@ components:
           example: '2020-03-25T09:48:37.463835Z'
           format: date-time
           type: string
+        exclude_tags_mode:
+          description: 'When set to true, the configuration will exclude the configured
+            tags and include any other submitted tags.
+
+            When set to false, the configuration will include the configured tags
+            and exclude any other submitted tags.
+
+            Defaults to false. Requires `tags` property.'
+          type: boolean
         include_percentiles:
           description: 'Toggle to include or exclude percentile aggregations for distribution
             metrics.
@@ -10104,6 +10129,15 @@ components:
       properties:
         aggregations:
           $ref: '#/components/schemas/MetricCustomAggregations'
+        exclude_tags_mode:
+          description: 'When set to true, the configuration will exclude the configured
+            tags and include any other submitted tags.
+
+            When set to false, the configuration will include the configured tags
+            and exclude any other submitted tags.
+
+            Defaults to false. Requires `tags` property.'
+          type: boolean
         include_percentiles:
           description: 'Toggle to include/exclude percentiles for a distribution metric.
 
@@ -23621,7 +23655,11 @@ paths:
         If multiple calls include the same metric, the last configuration applied
         (not by submit order) is used, do not
 
-        expect deterministic ordering of concurrent calls.
+        expect deterministic ordering of concurrent calls. The `exclude_tags_mode`
+        value will set all metrics that match the prefix to
+
+        the same exclusion state, metric tag configurations do not support mixed inclusion
+        and exclusion for tags on the same metric.
 
         Can only be used with application keys of users with the `Manage Tags for
         Metrics` permission.'
@@ -24002,7 +24040,11 @@ paths:
         Optionally, include percentile aggregations on any distribution metric or
         configure custom aggregations
 
-        on any count, rate, or gauge metric.
+        on any count, rate, or gauge metric. By setting `exclude_tags_mode` to true
+        the behavior is changed
+
+        from an allow-list to a deny-list, and tags in the defined list will not be
+        queryable.
 
         Can only be used with application keys of users with the `Manage Tags for
         Metrics` permission.'

packages/datadog-api-client-v2/apis/MetricsApi.ts

@@ -1789,7 +1789,8 @@ export class MetricsApi {
    * Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.
    * Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
    * If multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not
-   * expect deterministic ordering of concurrent calls.
+   * expect deterministic ordering of concurrent calls. The `exclude_tags_mode` value will set all metrics that match the prefix to
+   * the same exclusion state, metric tag configurations do not support mixed inclusion and exclusion for tags on the same metric.
    * Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
    * @param param The request object
    */
@@ -1816,7 +1817,8 @@ export class MetricsApi {
   /**
    * Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
    * Optionally, include percentile aggregations on any distribution metric or configure custom aggregations
-   * on any count, rate, or gauge metric.
+   * on any count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed
+   * from an allow-list to a deny-list, and tags in the defined list will not be queryable.
    * Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
    * @param param The request object
    */

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

@@ -14,6 +14,12 @@ export class MetricBulkTagConfigCreateAttributes {
    * A list of account emails to notify when the configuration is applied.
    */
   "emails"?: Array<string>;
+  /**
+   * When set to true, the configuration will exclude the configured tags and include any other submitted tags.
+   * When set to false, the configuration will include the configured tags and exclude any other submitted tags.
+   * Defaults to false.
+   */
+  "excludeTagsMode"?: boolean;
   /**
    * A list of tag names to apply to the configuration.
    */
@@ -33,6 +39,10 @@ export class MetricBulkTagConfigCreateAttributes {
       type: "Array<string>",
       format: "email",
     },
+    excludeTagsMode: {
+      baseName: "exclude_tags_mode",
+      type: "boolean",
+    },
     tags: {
       baseName: "tags",
       type: "Array<string>",

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

@@ -14,6 +14,11 @@ export class MetricBulkTagConfigStatusAttributes {
    * A list of account emails to notify when the configuration is applied.
    */
   "emails"?: Array<string>;
+  /**
+   * When set to true, the configuration will exclude the configured tags and include any other submitted tags.
+   * When set to false, the configuration will include the configured tags and exclude any other submitted tags.
+   */
+  "excludeTagsMode"?: boolean;
   /**
    * The status of the request.
    */
@@ -37,6 +42,10 @@ export class MetricBulkTagConfigStatusAttributes {
       type: "Array<string>",
       format: "email",
     },
+    excludeTagsMode: {
+      baseName: "exclude_tags_mode",
+      type: "boolean",
+    },
     status: {
       baseName: "status",
       type: "string",

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

@@ -35,6 +35,12 @@ export class MetricTagConfigurationAttributes {
    * Timestamp when the tag configuration was created.
    */
   "createdAt"?: Date;
+  /**
+   * When set to true, the configuration will exclude the configured tags and include any other submitted tags.
+   * When set to false, the configuration will include the configured tags and exclude any other submitted tags.
+   * Defaults to false. Requires `tags` property.
+   */
+  "excludeTagsMode"?: boolean;
   /**
    * Toggle to include or exclude percentile aggregations for distribution metrics.
    * Only present when the `metric_type` is `distribution`.
@@ -71,6 +77,10 @@ export class MetricTagConfigurationAttributes {
       type: "Date",
       format: "date-time",
     },
+    excludeTagsMode: {
+      baseName: "exclude_tags_mode",
+      type: "boolean",
+    },
     includePercentiles: {
       baseName: "include_percentiles",
       type: "boolean",

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

@@ -31,6 +31,12 @@ export class MetricTagConfigurationCreateAttributes {
    * Can only be applied to metrics that have a `metric_type` of `count`, `rate`, or `gauge`.
    */
   "aggregations"?: Array<MetricCustomAggregation>;
+  /**
+   * When set to true, the configuration will exclude the configured tags and include any other submitted tags.
+   * When set to false, the configuration will include the configured tags and exclude any other submitted tags.
+   * Defaults to false. Requires `tags` property.
+   */
+  "excludeTagsMode"?: boolean;
   /**
    * Toggle to include/exclude percentiles for a distribution metric.
    * Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`.
@@ -58,6 +64,10 @@ export class MetricTagConfigurationCreateAttributes {
       baseName: "aggregations",
       type: "Array<MetricCustomAggregation>",
     },
+    excludeTagsMode: {
+      baseName: "exclude_tags_mode",
+      type: "boolean",
+    },
     includePercentiles: {
       baseName: "include_percentiles",
       type: "boolean",