Class ScheduledAlertRuleCommonProperties
- java.lang.Object
-
- com.azure.resourcemanager.securityinsights.models.ScheduledAlertRuleCommonProperties
-
- Direct Known Subclasses:
ScheduledAlertRuleProperties
public class ScheduledAlertRuleCommonProperties extends Object
Scheduled alert rule template property bag.
-
-
Constructor Summary
Constructors Constructor Description ScheduledAlertRuleCommonProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AlertDetailsOverride
alertDetailsOverride()
Get the alertDetailsOverride property: The alert details override settings.Map<String,String>
customDetails()
Get the customDetails property: Dictionary of string key-value pairs of columns to be attached to the alert.List<EntityMapping>
entityMappings()
Get the entityMappings property: Array of the entity mappings of the alert rule.EventGroupingSettings
eventGroupingSettings()
Get the eventGroupingSettings property: The event grouping settings.String
query()
Get the query property: The query that creates alerts for this rule.Duration
queryFrequency()
Get the queryFrequency property: The frequency (in ISO 8601 duration format) for this alert rule to run.Duration
queryPeriod()
Get the queryPeriod property: The period (in ISO 8601 duration format) that this alert rule looks at.AlertSeverity
severity()
Get the severity property: The severity for alerts created by this alert rule.TriggerOperator
triggerOperator()
Get the triggerOperator property: The operation against the threshold that triggers alert rule.Integer
triggerThreshold()
Get the triggerThreshold property: The threshold triggers this alert rule.void
validate()
Validates the instance.ScheduledAlertRuleCommonProperties
withAlertDetailsOverride(AlertDetailsOverride alertDetailsOverride)
Set the alertDetailsOverride property: The alert details override settings.ScheduledAlertRuleCommonProperties
withCustomDetails(Map<String,String> customDetails)
Set the customDetails property: Dictionary of string key-value pairs of columns to be attached to the alert.ScheduledAlertRuleCommonProperties
withEntityMappings(List<EntityMapping> entityMappings)
Set the entityMappings property: Array of the entity mappings of the alert rule.ScheduledAlertRuleCommonProperties
withEventGroupingSettings(EventGroupingSettings eventGroupingSettings)
Set the eventGroupingSettings property: The event grouping settings.ScheduledAlertRuleCommonProperties
withQuery(String query)
Set the query property: The query that creates alerts for this rule.ScheduledAlertRuleCommonProperties
withQueryFrequency(Duration queryFrequency)
Set the queryFrequency property: The frequency (in ISO 8601 duration format) for this alert rule to run.ScheduledAlertRuleCommonProperties
withQueryPeriod(Duration queryPeriod)
Set the queryPeriod property: The period (in ISO 8601 duration format) that this alert rule looks at.ScheduledAlertRuleCommonProperties
withSeverity(AlertSeverity severity)
Set the severity property: The severity for alerts created by this alert rule.ScheduledAlertRuleCommonProperties
withTriggerOperator(TriggerOperator triggerOperator)
Set the triggerOperator property: The operation against the threshold that triggers alert rule.ScheduledAlertRuleCommonProperties
withTriggerThreshold(Integer triggerThreshold)
Set the triggerThreshold property: The threshold triggers this alert rule.
-
-
-
Method Detail
-
query
public String query()
Get the query property: The query that creates alerts for this rule.- Returns:
- the query value.
-
withQuery
public ScheduledAlertRuleCommonProperties withQuery(String query)
Set the query property: The query that creates alerts for this rule.- Parameters:
query
- the query value to set.- Returns:
- the ScheduledAlertRuleCommonProperties object itself.
-
queryFrequency
public Duration queryFrequency()
Get the queryFrequency property: The frequency (in ISO 8601 duration format) for this alert rule to run.- Returns:
- the queryFrequency value.
-
withQueryFrequency
public ScheduledAlertRuleCommonProperties withQueryFrequency(Duration queryFrequency)
Set the queryFrequency property: The frequency (in ISO 8601 duration format) for this alert rule to run.- Parameters:
queryFrequency
- the queryFrequency value to set.- Returns:
- the ScheduledAlertRuleCommonProperties object itself.
-
queryPeriod
public Duration queryPeriod()
Get the queryPeriod property: The period (in ISO 8601 duration format) that this alert rule looks at.- Returns:
- the queryPeriod value.
-
withQueryPeriod
public ScheduledAlertRuleCommonProperties withQueryPeriod(Duration queryPeriod)
Set the queryPeriod property: The period (in ISO 8601 duration format) that this alert rule looks at.- Parameters:
queryPeriod
- the queryPeriod value to set.- Returns:
- the ScheduledAlertRuleCommonProperties object itself.
-
severity
public AlertSeverity severity()
Get the severity property: The severity for alerts created by this alert rule.- Returns:
- the severity value.
-
withSeverity
public ScheduledAlertRuleCommonProperties withSeverity(AlertSeverity severity)
Set the severity property: The severity for alerts created by this alert rule.- Parameters:
severity
- the severity value to set.- Returns:
- the ScheduledAlertRuleCommonProperties object itself.
-
triggerOperator
public TriggerOperator triggerOperator()
Get the triggerOperator property: The operation against the threshold that triggers alert rule.- Returns:
- the triggerOperator value.
-
withTriggerOperator
public ScheduledAlertRuleCommonProperties withTriggerOperator(TriggerOperator triggerOperator)
Set the triggerOperator property: The operation against the threshold that triggers alert rule.- Parameters:
triggerOperator
- the triggerOperator value to set.- Returns:
- the ScheduledAlertRuleCommonProperties object itself.
-
triggerThreshold
public Integer triggerThreshold()
Get the triggerThreshold property: The threshold triggers this alert rule.- Returns:
- the triggerThreshold value.
-
withTriggerThreshold
public ScheduledAlertRuleCommonProperties withTriggerThreshold(Integer triggerThreshold)
Set the triggerThreshold property: The threshold triggers this alert rule.- Parameters:
triggerThreshold
- the triggerThreshold value to set.- Returns:
- the ScheduledAlertRuleCommonProperties object itself.
-
eventGroupingSettings
public EventGroupingSettings eventGroupingSettings()
Get the eventGroupingSettings property: The event grouping settings.- Returns:
- the eventGroupingSettings value.
-
withEventGroupingSettings
public ScheduledAlertRuleCommonProperties withEventGroupingSettings(EventGroupingSettings eventGroupingSettings)
Set the eventGroupingSettings property: The event grouping settings.- Parameters:
eventGroupingSettings
- the eventGroupingSettings value to set.- Returns:
- the ScheduledAlertRuleCommonProperties object itself.
-
customDetails
public Map<String,String> customDetails()
Get the customDetails property: Dictionary of string key-value pairs of columns to be attached to the alert.- Returns:
- the customDetails value.
-
withCustomDetails
public ScheduledAlertRuleCommonProperties withCustomDetails(Map<String,String> customDetails)
Set the customDetails property: Dictionary of string key-value pairs of columns to be attached to the alert.- Parameters:
customDetails
- the customDetails value to set.- Returns:
- the ScheduledAlertRuleCommonProperties object itself.
-
entityMappings
public List<EntityMapping> entityMappings()
Get the entityMappings property: Array of the entity mappings of the alert rule.- Returns:
- the entityMappings value.
-
withEntityMappings
public ScheduledAlertRuleCommonProperties withEntityMappings(List<EntityMapping> entityMappings)
Set the entityMappings property: Array of the entity mappings of the alert rule.- Parameters:
entityMappings
- the entityMappings value to set.- Returns:
- the ScheduledAlertRuleCommonProperties object itself.
-
alertDetailsOverride
public AlertDetailsOverride alertDetailsOverride()
Get the alertDetailsOverride property: The alert details override settings.- Returns:
- the alertDetailsOverride value.
-
withAlertDetailsOverride
public ScheduledAlertRuleCommonProperties withAlertDetailsOverride(AlertDetailsOverride alertDetailsOverride)
Set the alertDetailsOverride property: The alert details override settings.- Parameters:
alertDetailsOverride
- the alertDetailsOverride value to set.- Returns:
- the ScheduledAlertRuleCommonProperties object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-