Skip to content

Commit 67edf40

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add monitor draft status field (#2861)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent d0751b7 commit 67edf40

15 files changed

Lines changed: 203 additions & 30 deletions

‎.apigentools-info‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-06-04 12:51:37.536059",
8-
"spec_repo_commit": "35a63137"
7+
"regenerated": "2025-06-04 17:40:39.560452",
8+
"spec_repo_commit": "38b3c05a"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-06-04 12:51:37.554861",
13-
"spec_repo_commit": "35a63137"
12+
"regenerated": "2025-06-04 17:40:39.576433",
13+
"spec_repo_commit": "38b3c05a"
1414
}
1515
}
1616
}

‎.generator/schemas/v1/openapi.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6742,6 +6742,8 @@ components:
67426742
nullable: true
67436743
readOnly: true
67446744
type: string
6745+
draft_status:
6746+
$ref: '#/components/schemas/MonitorDraftStatus'
67456747
id:
67466748
description: ID of this monitor.
67476749
format: int64
@@ -6834,6 +6836,28 @@ components:
68346836
- FIREFOX_LAPTOP_LARGE
68356837
- FIREFOX_TABLET
68366838
- FIREFOX_MOBILE_SMALL
6839+
MonitorDraftStatus:
6840+
default: published
6841+
description: 'Indicates whether the monitor is in a draft or published state.
6842+
6843+
6844+
`draft`: The monitor appears as Draft and does not send notifications.
6845+
6846+
`published`: The monitor is active and evaluates conditions and notify as
6847+
configured.
6848+
6849+
6850+
This field is in preview. The draft value is only available to customers with
6851+
the feature enabled.
6852+
6853+
'
6854+
enum:
6855+
- draft
6856+
- published
6857+
type: string
6858+
x-enum-varnames:
6859+
- DRAFT
6860+
- PUBLISHED
68376861
MonitorFormulaAndFunctionCostAggregator:
68386862
description: Aggregation methods for metric queries.
68396863
enum:
@@ -7917,6 +7941,8 @@ components:
79177941
nullable: true
79187942
readOnly: true
79197943
type: string
7944+
draft_status:
7945+
$ref: '#/components/schemas/MonitorDraftStatus'
79207946
id:
79217947
description: ID of this monitor.
79227948
format: int64

‎examples/v1/monitors/CreateMonitor_1539578087.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import com.datadog.api.client.ApiException;
55
import com.datadog.api.client.v1.api.MonitorsApi;
66
import com.datadog.api.client.v1.model.Monitor;
7+
import com.datadog.api.client.v1.model.MonitorDraftStatus;
78
import com.datadog.api.client.v1.model.MonitorOptions;
89
import com.datadog.api.client.v1.model.MonitorOptionsCustomSchedule;
910
import com.datadog.api.client.v1.model.MonitorOptionsCustomScheduleRecurrence;
@@ -42,7 +43,8 @@ public static void main(String[] args) {
4243
.rrule("FREQ=DAILY;INTERVAL=1")
4344
.timezone("America/Los_Angeles")
4445
.start("2024-10-26T09:13:00"))))))
45-
.type(MonitorType.QUERY_ALERT);
46+
.type(MonitorType.QUERY_ALERT)
47+
.draftStatus(MonitorDraftStatus.PUBLISHED);
4648

4749
try {
4850
Monitor result = apiInstance.createMonitor(body);

‎examples/v1/monitors/CreateMonitor_440013737.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import com.datadog.api.client.ApiException;
55
import com.datadog.api.client.v1.api.MonitorsApi;
66
import com.datadog.api.client.v1.model.Monitor;
7+
import com.datadog.api.client.v1.model.MonitorDraftStatus;
78
import com.datadog.api.client.v1.model.MonitorOptions;
89
import com.datadog.api.client.v1.model.MonitorThresholds;
910
import com.datadog.api.client.v1.model.MonitorType;
@@ -25,7 +26,8 @@ public static void main(String[] args) {
2526
.message("some message")
2627
.tags(Arrays.asList("test:examplemonitor", "env:ci"))
2728
.priority(3L)
28-
.options(new MonitorOptions().thresholds(new MonitorThresholds().critical(1.0)));
29+
.options(new MonitorOptions().thresholds(new MonitorThresholds().critical(1.0)))
30+
.draftStatus(MonitorDraftStatus.DRAFT);
2931

3032
try {
3133
Monitor result = apiInstance.createMonitor(body);

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

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
Monitor.JSON_PROPERTY_CREATED,
2727
Monitor.JSON_PROPERTY_CREATOR,
2828
Monitor.JSON_PROPERTY_DELETED,
29+
Monitor.JSON_PROPERTY_DRAFT_STATUS,
2930
Monitor.JSON_PROPERTY_ID,
3031
Monitor.JSON_PROPERTY_MATCHING_DOWNTIMES,
3132
Monitor.JSON_PROPERTY_MESSAGE,
@@ -54,6 +55,9 @@ public class Monitor {
5455
public static final String JSON_PROPERTY_DELETED = "deleted";
5556
private JsonNullable<OffsetDateTime> deleted = JsonNullable.<OffsetDateTime>undefined();
5657

58+
public static final String JSON_PROPERTY_DRAFT_STATUS = "draft_status";
59+
private MonitorDraftStatus draftStatus = MonitorDraftStatus.PUBLISHED;
60+
5761
public static final String JSON_PROPERTY_ID = "id";
5862
private Long id;
5963

@@ -157,6 +161,37 @@ private void setDeleted_JsonNullable(JsonNullable<OffsetDateTime> deleted) {
157161
this.deleted = deleted;
158162
}
159163

164+
public Monitor draftStatus(MonitorDraftStatus draftStatus) {
165+
this.draftStatus = draftStatus;
166+
this.unparsed |= !draftStatus.isValid();
167+
return this;
168+
}
169+
170+
/**
171+
* Indicates whether the monitor is in a draft or published state.
172+
*
173+
* <p><code>draft</code>: The monitor appears as Draft and does not send notifications. <code>
174+
* published</code>: The monitor is active and evaluates conditions and notify as configured.
175+
*
176+
* <p>This field is in preview. The draft value is only available to customers with the feature
177+
* enabled.
178+
*
179+
* @return draftStatus
180+
*/
181+
@jakarta.annotation.Nullable
182+
@JsonProperty(JSON_PROPERTY_DRAFT_STATUS)
183+
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
184+
public MonitorDraftStatus getDraftStatus() {
185+
return draftStatus;
186+
}
187+
188+
public void setDraftStatus(MonitorDraftStatus draftStatus) {
189+
if (!draftStatus.isValid()) {
190+
this.unparsed = true;
191+
}
192+
this.draftStatus = draftStatus;
193+
}
194+
160195
/**
161196
* ID of this monitor.
162197
*
@@ -528,6 +563,7 @@ public boolean equals(Object o) {
528563
return Objects.equals(this.created, monitor.created)
529564
&& Objects.equals(this.creator, monitor.creator)
530565
&& Objects.equals(this.deleted, monitor.deleted)
566+
&& Objects.equals(this.draftStatus, monitor.draftStatus)
531567
&& Objects.equals(this.id, monitor.id)
532568
&& Objects.equals(this.matchingDowntimes, monitor.matchingDowntimes)
533569
&& Objects.equals(this.message, monitor.message)
@@ -551,6 +587,7 @@ public int hashCode() {
551587
created,
552588
creator,
553589
deleted,
590+
draftStatus,
554591
id,
555592
matchingDowntimes,
556593
message,
@@ -575,6 +612,7 @@ public String toString() {
575612
sb.append(" created: ").append(toIndentedString(created)).append("\n");
576613
sb.append(" creator: ").append(toIndentedString(creator)).append("\n");
577614
sb.append(" deleted: ").append(toIndentedString(deleted)).append("\n");
615+
sb.append(" draftStatus: ").append(toIndentedString(draftStatus)).append("\n");
578616
sb.append(" id: ").append(toIndentedString(id)).append("\n");
579617
sb.append(" matchingDowntimes: ").append(toIndentedString(matchingDowntimes)).append("\n");
580618
sb.append(" message: ").append(toIndentedString(message)).append("\n");

‎src/main/java/com/datadog/api/client/v1/model/MonitorDraftStatus.java‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
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.v1.model;
8+
9+
import com.datadog.api.client.ModelEnum;
10+
import com.fasterxml.jackson.annotation.JsonCreator;
11+
import com.fasterxml.jackson.core.JsonGenerator;
12+
import com.fasterxml.jackson.core.JsonProcessingException;
13+
import com.fasterxml.jackson.databind.SerializerProvider;
14+
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
15+
import com.fasterxml.jackson.databind.ser.std.StdSerializer;
16+
import java.io.IOException;
17+
import java.util.Arrays;
18+
import java.util.HashSet;
19+
import java.util.Set;
20+
21+
/**
22+
* Indicates whether the monitor is in a draft or published state.
23+
*
24+
* <p><code>draft</code>: The monitor appears as Draft and does not send notifications. <code>
25+
* published</code>: The monitor is active and evaluates conditions and notify as configured.
26+
*
27+
* <p>This field is in preview. The draft value is only available to customers with the feature
28+
* enabled.
29+
*/
30+
@JsonSerialize(using = MonitorDraftStatus.MonitorDraftStatusSerializer.class)
31+
public class MonitorDraftStatus extends ModelEnum<String> {
32+
33+
private static final Set<String> allowedValues =
34+
new HashSet<String>(Arrays.asList("draft", "published"));
35+
36+
public static final MonitorDraftStatus DRAFT = new MonitorDraftStatus("draft");
37+
public static final MonitorDraftStatus PUBLISHED = new MonitorDraftStatus("published");
38+
39+
MonitorDraftStatus(String value) {
40+
super(value, allowedValues);
41+
}
42+
43+
public static class MonitorDraftStatusSerializer extends StdSerializer<MonitorDraftStatus> {
44+
public MonitorDraftStatusSerializer(Class<MonitorDraftStatus> t) {
45+
super(t);
46+
}
47+
48+
public MonitorDraftStatusSerializer() {
49+
this(null);
50+
}
51+
52+
@Override
53+
public void serialize(MonitorDraftStatus value, JsonGenerator jgen, SerializerProvider provider)
54+
throws IOException, JsonProcessingException {
55+
jgen.writeObject(value.value);
56+
}
57+
}
58+
59+
@JsonCreator
60+
public static MonitorDraftStatus fromValue(String value) {
61+
return new MonitorDraftStatus(value);
62+
}
63+
}

‎src/main/java/com/datadog/api/client/v1/model/MonitorUpdateRequest.java‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
MonitorUpdateRequest.JSON_PROPERTY_CREATED,
2626
MonitorUpdateRequest.JSON_PROPERTY_CREATOR,
2727
MonitorUpdateRequest.JSON_PROPERTY_DELETED,
28+
MonitorUpdateRequest.JSON_PROPERTY_DRAFT_STATUS,
2829
MonitorUpdateRequest.JSON_PROPERTY_ID,
2930
MonitorUpdateRequest.JSON_PROPERTY_MESSAGE,
3031
MonitorUpdateRequest.JSON_PROPERTY_MODIFIED,
@@ -52,6 +53,9 @@ public class MonitorUpdateRequest {
5253
public static final String JSON_PROPERTY_DELETED = "deleted";
5354
private JsonNullable<OffsetDateTime> deleted = JsonNullable.<OffsetDateTime>undefined();
5455

56+
public static final String JSON_PROPERTY_DRAFT_STATUS = "draft_status";
57+
private MonitorDraftStatus draftStatus = MonitorDraftStatus.PUBLISHED;
58+
5559
public static final String JSON_PROPERTY_ID = "id";
5660
private Long id;
5761

@@ -141,6 +145,37 @@ private void setDeleted_JsonNullable(JsonNullable<OffsetDateTime> deleted) {
141145
this.deleted = deleted;
142146
}
143147

148+
public MonitorUpdateRequest draftStatus(MonitorDraftStatus draftStatus) {
149+
this.draftStatus = draftStatus;
150+
this.unparsed |= !draftStatus.isValid();
151+
return this;
152+
}
153+
154+
/**
155+
* Indicates whether the monitor is in a draft or published state.
156+
*
157+
* <p><code>draft</code>: The monitor appears as Draft and does not send notifications. <code>
158+
* published</code>: The monitor is active and evaluates conditions and notify as configured.
159+
*
160+
* <p>This field is in preview. The draft value is only available to customers with the feature
161+
* enabled.
162+
*
163+
* @return draftStatus
164+
*/
165+
@jakarta.annotation.Nullable
166+
@JsonProperty(JSON_PROPERTY_DRAFT_STATUS)
167+
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
168+
public MonitorDraftStatus getDraftStatus() {
169+
return draftStatus;
170+
}
171+
172+
public void setDraftStatus(MonitorDraftStatus draftStatus) {
173+
if (!draftStatus.isValid()) {
174+
this.unparsed = true;
175+
}
176+
this.draftStatus = draftStatus;
177+
}
178+
144179
/**
145180
* ID of this monitor.
146181
*
@@ -481,6 +516,7 @@ public boolean equals(Object o) {
481516
return Objects.equals(this.created, monitorUpdateRequest.created)
482517
&& Objects.equals(this.creator, monitorUpdateRequest.creator)
483518
&& Objects.equals(this.deleted, monitorUpdateRequest.deleted)
519+
&& Objects.equals(this.draftStatus, monitorUpdateRequest.draftStatus)
484520
&& Objects.equals(this.id, monitorUpdateRequest.id)
485521
&& Objects.equals(this.message, monitorUpdateRequest.message)
486522
&& Objects.equals(this.modified, monitorUpdateRequest.modified)
@@ -503,6 +539,7 @@ public int hashCode() {
503539
created,
504540
creator,
505541
deleted,
542+
draftStatus,
506543
id,
507544
message,
508545
modified,
@@ -526,6 +563,7 @@ public String toString() {
526563
sb.append(" created: ").append(toIndentedString(created)).append("\n");
527564
sb.append(" creator: ").append(toIndentedString(creator)).append("\n");
528565
sb.append(" deleted: ").append(toIndentedString(deleted)).append("\n");
566+
sb.append(" draftStatus: ").append(toIndentedString(draftStatus)).append("\n");
529567
sb.append(" id: ").append(toIndentedString(id)).append("\n");
530568
sb.append(" message: ").append(toIndentedString(message)).append("\n");
531569
sb.append(" modified: ").append(toIndentedString(modified)).append("\n");

‎src/test/resources/cassettes/features/v1/Create_a_RUM_formula_and_functions_monitor_returns_OK_response.freeze‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2022-02-02T21:04:10.597Z
1+
2025-05-14T22:27:13.829Z

‎src/test/resources/cassettes/features/v1/Create_a_RUM_formula_and_functions_monitor_returns_OK_response.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"httpRequest": {
44
"body": {
55
"type": "JSON",
6-
"json": "{\"message\": \"some message Notify: @hipchat-channel\", \"name\": \"Test-Create_a_RUM_formula_and_functions_monitor_returns_OK_response-1643835850\", \"options\": {\"thresholds\": {\"critical\": 0.8}, \"variables\": [{\"compute\": {\"aggregation\": \"count\"}, \"data_source\": \"rum\", \"group_by\": [], \"indexes\": [\"*\"], \"name\": \"query2\", \"search\": {\"query\": \"\"}}, {\"compute\": {\"aggregation\": \"count\"}, \"data_source\": \"rum\", \"group_by\": [], \"indexes\": [\"*\"], \"name\": \"query1\", \"search\": {\"query\": \"status:error\"}}]}, \"priority\": 3, \"query\": \"formula(\\\"query2 / query1 * 100\\\").last(\\\"15m\\\") >= 0.8\", \"tags\": [\"test:testcreatearumformulaandfunctionsmonitorreturnsokresponse1643835850\", \"env:ci\"], \"type\": \"rum alert\"}"
6+
"json": "{\"message\": \"some message Notify: @hipchat-channel\", \"name\": \"Test-Create_a_RUM_formula_and_functions_monitor_returns_OK_response-1747261633\", \"options\": {\"thresholds\": {\"critical\": 0.8}, \"variables\": [{\"compute\": {\"aggregation\": \"count\"}, \"data_source\": \"rum\", \"group_by\": [], \"indexes\": [\"*\"], \"name\": \"query2\", \"search\": {\"query\": \"\"}}, {\"compute\": {\"aggregation\": \"count\"}, \"data_source\": \"rum\", \"group_by\": [], \"indexes\": [\"*\"], \"name\": \"query1\", \"search\": {\"query\": \"status:error\"}}]}, \"priority\": 3, \"query\": \"formula(\\\"query2 / query1 * 100\\\").last(\\\"15m\\\") >= 0.8\", \"tags\": [\"test:testcreatearumformulaandfunctionsmonitorreturnsokresponse1747261633\", \"env:ci\"], \"type\": \"rum alert\"}"
77
},
88
"headers": {},
99
"method": "POST",
@@ -12,7 +12,7 @@
1212
"secure": true
1313
},
1414
"httpResponse": {
15-
"body": "{\"restricted_roles\":null,\"tags\":[\"test:testcreatearumformulaandfunctionsmonitorreturnsokresponse1643835850\",\"env:ci\"],\"deleted\":null,\"query\":\"formula(\\\"query2 / query1 * 100\\\").last(\\\"15m\\\") >= 0.8\",\"message\":\"some message Notify: @hipchat-channel\",\"id\":62683819,\"multi\":false,\"name\":\"Test-Create_a_RUM_formula_and_functions_monitor_returns_OK_response-1643835850\",\"created\":\"2022-02-02T21:04:10.947341+00:00\",\"created_at\":1643835850000,\"creator\":{\"id\":1445416,\"handle\":\"frog@datadoghq.com\",\"name\":null,\"email\":\"frog@datadoghq.com\"},\"org_id\":321813,\"modified\":\"2022-02-02T21:04:10.947341+00:00\",\"priority\":3,\"overall_state_modified\":null,\"overall_state\":\"No Data\",\"type\":\"rum alert\",\"options\":{\"notify_audit\":false,\"locked\":false,\"silenced\":{},\"include_tags\":true,\"thresholds\":{\"critical\":0.8},\"new_host_delay\":300,\"notify_no_data\":false,\"groupby_simple_monitor\":false,\"variables\":[{\"search\":{\"query\":\"\"},\"data_source\":\"rum\",\"compute\":{\"aggregation\":\"count\"},\"name\":\"query2\",\"indexes\":[\"*\"],\"group_by\":[]},{\"search\":{\"query\":\"status:error\"},\"data_source\":\"rum\",\"compute\":{\"aggregation\":\"count\"},\"name\":\"query1\",\"indexes\":[\"*\"],\"group_by\":[]}]}}",
15+
"body": "{\"id\":172140181,\"org_id\":2,\"type\":\"rum alert\",\"name\":\"Test-Create_a_RUM_formula_and_functions_monitor_returns_OK_response-1747261633\",\"message\":\"some message Notify: @hipchat-channel\",\"tags\":[\"test:testcreatearumformulaandfunctionsmonitorreturnsokresponse1747261633\",\"env:ci\"],\"query\":\"formula(\\\"query2 / query1 * 100\\\").last(\\\"15m\\\") >= 0.8\",\"options\":{\"thresholds\":{\"critical\":0.8},\"variables\":[{\"compute\":{\"aggregation\":\"count\"},\"data_source\":\"rum\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query2\",\"search\":{\"query\":\"\"}},{\"compute\":{\"aggregation\":\"count\"},\"data_source\":\"rum\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"status:error\"}}],\"notify_no_data\":false,\"notify_audit\":false,\"new_host_delay\":300,\"include_tags\":true,\"groupby_simple_monitor\":false,\"silenced\":{},\"avalanche_window\":20},\"multi\":false,\"created_at\":1747261634000,\"created\":\"2025-05-14T22:27:14.329045+00:00\",\"modified\":\"2025-05-14T22:27:14.329045+00:00\",\"deleted\":null,\"priority\":3,\"draft_status\":\"published\",\"restricted_roles\":null,\"restriction_policy\":null,\"overall_state_modified\":null,\"overall_state\":\"No Data\",\"creator\":{\"name\":\"Carl Martensen\",\"handle\":\"carl.martensen@datadoghq.com\",\"email\":\"carl.martensen@datadoghq.com\",\"id\":638339},\"run_as\":null,\"restricted\":true}\n",
1616
"headers": {
1717
"Content-Type": [
1818
"application/json"
@@ -27,18 +27,18 @@
2727
"timeToLive": {
2828
"unlimited": true
2929
},
30-
"id": "7a58052f-14ee-83a6-2dfc-2809be4dc559"
30+
"id": "eef12d43-f020-a800-f373-e9557add2e5e"
3131
},
3232
{
3333
"httpRequest": {
3434
"headers": {},
3535
"method": "DELETE",
36-
"path": "/api/v1/monitor/62683819",
36+
"path": "/api/v1/monitor/172140181",
3737
"keepAlive": false,
3838
"secure": true
3939
},
4040
"httpResponse": {
41-
"body": "{\"deleted_monitor_id\":62683819}",
41+
"body": "{\"deleted_monitor_id\":172140181}\n",
4242
"headers": {
4343
"Content-Type": [
4444
"application/json"
@@ -53,6 +53,6 @@
5353
"timeToLive": {
5454
"unlimited": true
5555
},
56-
"id": "2c04155e-cb9e-82a5-da2f-b42d5676fc54"
56+
"id": "f63b2a6e-7ed4-4642-d421-e39aa05e50b5"
5757
}
5858
]

‎src/test/resources/cassettes/features/v1/Create_a_metric_monitor_with_a_custom_schedule_returns_OK_response.freeze‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2023-11-09T17:58:50.774Z
1+
2025-05-14T22:28:29.992Z

0 commit comments

Comments
 (0)