Add Support for Monitor Assets (#3236)

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

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

.generator/schemas/v1/openapi.yaml

@@ -7255,6 +7255,12 @@ components:
     Monitor:
       description: Object describing a monitor.
       properties:
+        assets:
+          description: The list of monitor assets tied to a monitor, which represents
+            key links for users to take action on monitor alerts (for example, runbooks).
+          items:
+            $ref: '#/components/schemas/MonitorAsset'
+          type: array
         created:
           description: Timestamp of the monitor creation.
           format: date-time
@@ -7338,6 +7344,52 @@ components:
       - type
       - query
       type: object
+    MonitorAsset:
+      description: 'Represents key links tied to a monitor to help users take action
+        on alerts.
+
+        This feature is in Preview and only available to users with the feature enabled.'
+      properties:
+        category:
+          $ref: '#/components/schemas/MonitorAssetCategory'
+        name:
+          description: Name for the monitor asset
+          example: Monitor Runbook
+          type: string
+        resource_key:
+          description: Represents the identifier of the internal Datadog resource
+            that this asset represents. IDs in this field should be passed in as strings.
+          example: '12345'
+          type: string
+        resource_type:
+          $ref: '#/components/schemas/MonitorAssetResourceType'
+        url:
+          description: URL link for the asset. For links with an internal resource
+            type set, this should be the relative path to where the Datadog domain
+            is appended internally. For external links, this should be the full URL
+            path.
+          example: /notebooks/12345
+          type: string
+      required:
+      - name
+      - url
+      - category
+      type: object
+    MonitorAssetCategory:
+      description: Indicates the type of asset this entity represents on a monitor.
+      enum:
+      - runbook
+      example: runbook
+      type: string
+      x-enum-varnames:
+      - RUNBOOK
+    MonitorAssetResourceType:
+      description: Type of internal Datadog resource associated with a monitor asset.
+      enum:
+      - notebook
+      type: string
+      x-enum-varnames:
+      - NOTEBOOK
     MonitorDeviceID:
       description: ID of the device the Synthetics monitor is running on. Same as
         `SyntheticsDeviceID`.
@@ -8452,6 +8504,13 @@ components:
     MonitorUpdateRequest:
       description: Object describing a monitor update request.
       properties:
+        assets:
+          description: The list of monitor assets tied to a monitor, which represents
+            key links for users to take action on monitor alerts (for example, runbooks).
+          items:
+            $ref: '#/components/schemas/MonitorAsset'
+          nullable: true
+          type: array
         created:
           description: Timestamp of the monitor creation.
           format: date-time
@@ -31584,6 +31643,13 @@ paths:
         required: false
         schema:
           type: boolean
+      - description: If this argument is set to `true`, the returned data includes
+          all assets tied to this monitor.
+        in: query
+        name: with_assets
+        required: false
+        schema:
+          type: boolean
       responses:
         '200':
           content:

examples/v1/monitors/CreateMonitor_3541766733.java

@@ -0,0 +1,57 @@
+// Create a monitor with assets returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v1.api.MonitorsApi;
+import com.datadog.api.client.v1.model.Monitor;
+import com.datadog.api.client.v1.model.MonitorAsset;
+import com.datadog.api.client.v1.model.MonitorAssetCategory;
+import com.datadog.api.client.v1.model.MonitorAssetResourceType;
+import com.datadog.api.client.v1.model.MonitorOptions;
+import com.datadog.api.client.v1.model.MonitorOptionsSchedulingOptions;
+import com.datadog.api.client.v1.model.MonitorOptionsSchedulingOptionsEvaluationWindow;
+import com.datadog.api.client.v1.model.MonitorThresholds;
+import com.datadog.api.client.v1.model.MonitorType;
+import java.util.Collections;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    MonitorsApi apiInstance = new MonitorsApi(defaultClient);
+
+    Monitor body =
+        new Monitor()
+            .assets(
+                Collections.singletonList(
+                    new MonitorAsset()
+                        .category(MonitorAssetCategory.RUNBOOK)
+                        .name("Monitor Runbook")
+                        .resourceKey("12345")
+                        .resourceType(MonitorAssetResourceType.NOTEBOOK)
+                        .url("/notebooks/12345")))
+            .name("Example-Monitor")
+            .type(MonitorType.METRIC_ALERT)
+            .query("avg(current_1mo):avg:system.load.5{*} > 0.5")
+            .message("some message Notify: @hipchat-channel")
+            .options(
+                new MonitorOptions()
+                    .thresholds(new MonitorThresholds().critical(0.5))
+                    .schedulingOptions(
+                        new MonitorOptionsSchedulingOptions()
+                            .evaluationWindow(
+                                new MonitorOptionsSchedulingOptionsEvaluationWindow()
+                                    .dayStarts("04:00")
+                                    .monthStarts(1))));
+
+    try {
+      Monitor result = apiInstance.createMonitor(body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling MonitorsApi#createMonitor");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

src/main/java/com/datadog/api/client/v1/api/MonitorsApi.java

@@ -863,6 +863,7 @@ public CompletableFuture<ApiResponse<DeletedMonitor>> deleteMonitorWithHttpInfoA
   public static class GetMonitorOptionalParameters {
     private String groupStates;
     private Boolean withDowntimes;
+    private Boolean withAssets;
 
     /**
      * Set groupStates.
@@ -888,6 +889,18 @@ public GetMonitorOptionalParameters withDowntimes(Boolean withDowntimes) {
       this.withDowntimes = withDowntimes;
       return this;
     }
+
+    /**
+     * Set withAssets.
+     *
+     * @param withAssets If this argument is set to <code>true</code>, the returned data includes
+     *     all assets tied to this monitor. (optional)
+     * @return GetMonitorOptionalParameters
+     */
+    public GetMonitorOptionalParameters withAssets(Boolean withAssets) {
+      this.withAssets = withAssets;
+      return this;
+    }
   }
 
   /**
@@ -981,6 +994,7 @@ public ApiResponse<Monitor> getMonitorWithHttpInfo(
     }
     String groupStates = parameters.groupStates;
     Boolean withDowntimes = parameters.withDowntimes;
+    Boolean withAssets = parameters.withAssets;
     // create path and map variables
     String localVarPath =
         "/api/v1/monitor/{monitor_id}"
@@ -991,6 +1005,7 @@ public ApiResponse<Monitor> getMonitorWithHttpInfo(
 
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "group_states", groupStates));
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "with_downtimes", withDowntimes));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "with_assets", withAssets));
 
     Invocation.Builder builder =
         apiClient.createBuilder(
@@ -1035,6 +1050,7 @@ public CompletableFuture<ApiResponse<Monitor>> getMonitorWithHttpInfoAsync(
     }
     String groupStates = parameters.groupStates;
     Boolean withDowntimes = parameters.withDowntimes;
+    Boolean withAssets = parameters.withAssets;
     // create path and map variables
     String localVarPath =
         "/api/v1/monitor/{monitor_id}"
@@ -1045,6 +1061,7 @@ public CompletableFuture<ApiResponse<Monitor>> getMonitorWithHttpInfoAsync(
 
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "group_states", groupStates));
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "with_downtimes", withDowntimes));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "with_assets", withAssets));
 
     Invocation.Builder builder;
     try {

src/main/java/com/datadog/api/client/v1/model/Monitor.java

@@ -23,6 +23,7 @@
 
 /** Object describing a monitor. */
 @JsonPropertyOrder({
+  Monitor.JSON_PROPERTY_ASSETS,
   Monitor.JSON_PROPERTY_CREATED,
   Monitor.JSON_PROPERTY_CREATOR,
   Monitor.JSON_PROPERTY_DELETED,
@@ -46,6 +47,9 @@
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
 public class Monitor {
   @JsonIgnore public boolean unparsed = false;
+  public static final String JSON_PROPERTY_ASSETS = "assets";
+  private List<MonitorAsset> assets = null;
+
   public static final String JSON_PROPERTY_CREATED = "created";
   private OffsetDateTime created;
 
@@ -111,6 +115,40 @@ public Monitor(
     this.unparsed |= !type.isValid();
   }
 
+  public Monitor assets(List<MonitorAsset> assets) {
+    this.assets = assets;
+    for (MonitorAsset item : assets) {
+      this.unparsed |= item.unparsed;
+    }
+    return this;
+  }
+
+  public Monitor addAssetsItem(MonitorAsset assetsItem) {
+    if (this.assets == null) {
+      this.assets = new ArrayList<>();
+    }
+    this.assets.add(assetsItem);
+    this.unparsed |= assetsItem.unparsed;
+    return this;
+  }
+
+  /**
+   * The list of monitor assets tied to a monitor, which represents key links for users to take
+   * action on monitor alerts (for example, runbooks).
+   *
+   * @return assets
+   */
+  @jakarta.annotation.Nullable
+  @JsonProperty(JSON_PROPERTY_ASSETS)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public List<MonitorAsset> getAssets() {
+    return assets;
+  }
+
+  public void setAssets(List<MonitorAsset> assets) {
+    this.assets = assets;
+  }
+
   /**
    * Timestamp of the monitor creation.
    *
@@ -560,7 +598,8 @@ public boolean equals(Object o) {
       return false;
     }
     Monitor monitor = (Monitor) o;
-    return Objects.equals(this.created, monitor.created)
+    return Objects.equals(this.assets, monitor.assets)
+        && Objects.equals(this.created, monitor.created)
         && Objects.equals(this.creator, monitor.creator)
         && Objects.equals(this.deleted, monitor.deleted)
         && Objects.equals(this.draftStatus, monitor.draftStatus)
@@ -584,6 +623,7 @@ public boolean equals(Object o) {
   @Override
   public int hashCode() {
     return Objects.hash(
+        assets,
         created,
         creator,
         deleted,
@@ -609,6 +649,7 @@ public int hashCode() {
   public String toString() {
     StringBuilder sb = new StringBuilder();
     sb.append("class Monitor {\n");
+    sb.append("    assets: ").append(toIndentedString(assets)).append("\n");
     sb.append("    created: ").append(toIndentedString(created)).append("\n");
     sb.append("    creator: ").append(toIndentedString(creator)).append("\n");
     sb.append("    deleted: ").append(toIndentedString(deleted)).append("\n");