diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 9a80dea5bbb..0fb2ea89432 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -36811,7 +36811,10 @@ components: - name type: object MonitorNotificationRuleCondition: - description: Conditions for `conditional_recipients`. + description: 'A conditional recipient rule composed of a `scope` (the matching + condition) and + + `recipients` (who to notify when it matches).' properties: recipients: $ref: '#/components/schemas/MonitorNotificationRuleRecipients' @@ -36824,8 +36827,13 @@ components: - recipients type: object MonitorNotificationRuleConditionScope: - description: The scope to which the monitor applied. - example: transition_type:alert + description: 'Defines the condition under which the recipients are notified. + Supported formats: + + - Monitor status condition using `transition_type:`, for example `transition_type:is_alert`. + + - A single tag key:value pair, for example `env:prod`.' + example: transition_type:is_alert maxLength: 3000 minLength: 1 type: string @@ -36878,18 +36886,18 @@ components: $ref: '#/components/schemas/MonitorNotificationRuleResourceType' type: object MonitorNotificationRuleFilter: - description: Filter used to associate the notification rule with monitors. + description: Specifies the matching criteria for monitor notifications. oneOf: - $ref: '#/components/schemas/MonitorNotificationRuleFilterTags' - $ref: '#/components/schemas/MonitorNotificationRuleFilterScope' MonitorNotificationRuleFilterScope: additionalProperties: false - description: Filter monitor notifications. A monitor notification must match - the scope. + description: Filters monitor notifications using a scope expression over key:value + pairs with boolean logic (AND, OR, NOT). properties: scope: - description: A scope composed of one or several key:value pairs, which can - be used to filter monitor notifications on monitor and group tags. + description: A scope expression composed by key:value pairs (e.g. `service:foo`) + with boolean operators (AND, OR, NOT) and parentheses for grouping. example: service:(foo OR bar) AND team:test NOT environment:staging maxLength: 3000 minLength: 1 @@ -36899,12 +36907,11 @@ components: type: object MonitorNotificationRuleFilterTags: additionalProperties: false - description: Filter monitor notifications by tags. A monitor notification must - match all tags. + description: Filters monitor notifications by a list of tag key:value pairs. properties: tags: - description: A list of tags (key:value pairs), which can be used to filter - monitor notifications on monitor and group tags. + description: A list of tag key:value pairs (e.g. `team:product`). All tags + must match (AND semantics). example: - team:product - host:abc diff --git a/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleAttributes.java b/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleAttributes.java index 893ac21517d..f641ff588d2 100644 --- a/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleAttributes.java +++ b/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleAttributes.java @@ -78,7 +78,7 @@ public MonitorNotificationRuleAttributes filter(MonitorNotificationRuleFilter fi } /** - * Filter used to associate the notification rule with monitors. + * Specifies the matching criteria for monitor notifications. * * @return filter */ diff --git a/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleCondition.java b/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleCondition.java index 69f3cf3e1a5..460f7f801ec 100644 --- a/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleCondition.java +++ b/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleCondition.java @@ -19,7 +19,10 @@ import java.util.Map; import java.util.Objects; -/** Conditions for conditional_recipients. */ +/** + * A conditional recipient rule composed of a scope (the matching condition) and + * recipients (who to notify when it matches). + */ @JsonPropertyOrder({ MonitorNotificationRuleCondition.JSON_PROPERTY_RECIPIENTS, MonitorNotificationRuleCondition.JSON_PROPERTY_SCOPE @@ -76,7 +79,10 @@ public MonitorNotificationRuleCondition scope(String scope) { } /** - * The scope to which the monitor applied. + * Defines the condition under which the recipients are notified. Supported formats: - Monitor + * status condition using transition_type:<status>, for example + * transition_type:is_alert. - A single tag key:value pair, for example env:prod + * . * * @return scope */ diff --git a/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleFilterScope.java b/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleFilterScope.java index 9fe3fcde15e..996d80bbb70 100644 --- a/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleFilterScope.java +++ b/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleFilterScope.java @@ -13,7 +13,10 @@ import com.fasterxml.jackson.annotation.JsonPropertyOrder; import java.util.Objects; -/** Filter monitor notifications. A monitor notification must match the scope. */ +/** + * Filters monitor notifications using a scope expression over key:value pairs with boolean logic + * (AND, OR, NOT). + */ @JsonPropertyOrder({MonitorNotificationRuleFilterScope.JSON_PROPERTY_SCOPE}) @jakarta.annotation.Generated( value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") @@ -36,8 +39,8 @@ public MonitorNotificationRuleFilterScope scope(String scope) { } /** - * A scope composed of one or several key:value pairs, which can be used to filter monitor - * notifications on monitor and group tags. + * A scope expression composed by key:value pairs (e.g. service:foo) with boolean + * operators (AND, OR, NOT) and parentheses for grouping. * * @return scope */ diff --git a/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleFilterTags.java b/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleFilterTags.java index 80efc271bdb..8ef9cc447e7 100644 --- a/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleFilterTags.java +++ b/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleFilterTags.java @@ -15,7 +15,7 @@ import java.util.List; import java.util.Objects; -/** Filter monitor notifications by tags. A monitor notification must match all tags. */ +/** Filters monitor notifications by a list of tag key:value pairs. */ @JsonPropertyOrder({MonitorNotificationRuleFilterTags.JSON_PROPERTY_TAGS}) @jakarta.annotation.Generated( value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") @@ -43,8 +43,8 @@ public MonitorNotificationRuleFilterTags addTagsItem(String tagsItem) { } /** - * A list of tags (key:value pairs), which can be used to filter monitor notifications on monitor - * and group tags. + * A list of tag key:value pairs (e.g. team:product). All tags must match (AND + * semantics). * * @return tags */ diff --git a/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleResponseAttributes.java b/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleResponseAttributes.java index bf026775ea9..9c19c46b3b2 100644 --- a/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleResponseAttributes.java +++ b/src/main/java/com/datadog/api/client/v2/model/MonitorNotificationRuleResponseAttributes.java @@ -103,7 +103,7 @@ public MonitorNotificationRuleResponseAttributes filter(MonitorNotificationRuleF } /** - * Filter used to associate the notification rule with monitors. + * Specifies the matching criteria for monitor notifications. * * @return filter */