Class: DatadogAPIClient::V2::PatchNotificationRuleParametersDataAttributes

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/patch_notification_rule_parameters_data_attributes.rb

Overview

Attributes of the notification rule patch request. It is required to update the version of the rule when patching it.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



50
51
52
 
# File 'lib/datadog_api_client/v2/models/patch_notification_rule_parameters_data_attributes.rb', line 50

def additional_properties
  @additional_properties
end

#enabled ⇒ Object

Field used to enable or disable the rule.



25
26
27
 
# File 'lib/datadog_api_client/v2/models/patch_notification_rule_parameters_data_attributes.rb', line 25

def enabled
  @enabled
end

#name ⇒ Object

Name of the notification rule.



28
29
30
 
# File 'lib/datadog_api_client/v2/models/patch_notification_rule_parameters_data_attributes.rb', line 28

def name
  @name
end

#selectors ⇒ Object

Selectors are used to filter security issues for which notifications should be generated. Users can specify rule severities, rule types, a query to filter security issues on tags and attributes, and the trigger source. Only the trigger_source field is required.



33
34
35
 
# File 'lib/datadog_api_client/v2/models/patch_notification_rule_parameters_data_attributes.rb', line 33

def selectors
  @selectors
end

#targets ⇒ Object

List of recipients to notify when a notification rule is triggered. Many different target types are supported, such as email addresses, Slack channels, and PagerDuty services. The appropriate integrations need to be properly configured to send notifications to the specified targets.



38
39
40
 
# File 'lib/datadog_api_client/v2/models/patch_notification_rule_parameters_data_attributes.rb', line 38

def targets
  @targets
end

#time_aggregation ⇒ Object

Time aggregation period (in seconds) is used to aggregate the results of the notification rule evaluation. Results are aggregated over a selected time frame using a rolling window, which updates with each new evaluation. Notifications are only sent for new issues discovered during the window. Time aggregation is only available for vulnerability-based notification rules. When omitted or set to 0, no aggregation is done.



45
46
47
 
# File 'lib/datadog_api_client/v2/models/patch_notification_rule_parameters_data_attributes.rb', line 45

def time_aggregation
  @time_aggregation
end

#version ⇒ Object

Version of the notification rule. It is updated when the rule is modified.



48
49
50
 
# File 'lib/datadog_api_client/v2/models/patch_notification_rule_parameters_data_attributes.rb', line 48

def version
  @version
end