Class ScheduledAlertRuleTemplateProperties
- java.lang.Object
-
- com.azure.resourcemanager.securityinsights.fluent.models.ScheduledAlertRuleTemplateProperties
-
public final class ScheduledAlertRuleTemplateProperties extends Object
Scheduled alert rule template properties.
-
-
Constructor Summary
Constructors Constructor Description ScheduledAlertRuleTemplateProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AlertDetailsOverride
alertDetailsOverride()
Get the alertDetailsOverride property: The alert details override settings.Integer
alertRulesCreatedByTemplateCount()
Get the alertRulesCreatedByTemplateCount property: the number of alert rules that were created by this template.OffsetDateTime
createdDateUtc()
Get the createdDateUtc property: The time that this alert rule template has been added.Map<String,String>
customDetails()
Get the customDetails property: Dictionary of string key-value pairs of columns to be attached to the alert.String
description()
Get the description property: The description of the alert rule template.String
displayName()
Get the displayName property: The display name for alert rule template.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.OffsetDateTime
lastUpdatedDateUtc()
Get the lastUpdatedDateUtc property: The time that this alert rule template was last updated.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.List<AlertRuleTemplateDataSource>
requiredDataConnectors()
Get the requiredDataConnectors property: The required data connectors for this template.AlertSeverity
severity()
Get the severity property: The severity for alerts created by this alert rule.TemplateStatus
status()
Get the status property: The alert rule template status.List<AttackTactic>
tactics()
Get the tactics property: The tactics of the alert rule template.List<String>
techniques()
Get the techniques property: The techniques of the 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.String
version()
Get the version property: The version of this template - in format <a.b.c>, where all are numbers.ScheduledAlertRuleTemplateProperties
withAlertDetailsOverride(AlertDetailsOverride alertDetailsOverride)
Set the alertDetailsOverride property: The alert details override settings.ScheduledAlertRuleTemplateProperties
withAlertRulesCreatedByTemplateCount(Integer alertRulesCreatedByTemplateCount)
Set the alertRulesCreatedByTemplateCount property: the number of alert rules that were created by this template.ScheduledAlertRuleTemplateProperties
withCustomDetails(Map<String,String> customDetails)
Set the customDetails property: Dictionary of string key-value pairs of columns to be attached to the alert.ScheduledAlertRuleTemplateProperties
withDescription(String description)
Set the description property: The description of the alert rule template.ScheduledAlertRuleTemplateProperties
withDisplayName(String displayName)
Set the displayName property: The display name for alert rule template.ScheduledAlertRuleTemplateProperties
withEntityMappings(List<EntityMapping> entityMappings)
Set the entityMappings property: Array of the entity mappings of the alert rule.ScheduledAlertRuleTemplateProperties
withEventGroupingSettings(EventGroupingSettings eventGroupingSettings)
Set the eventGroupingSettings property: The event grouping settings.ScheduledAlertRuleTemplateProperties
withQuery(String query)
Set the query property: The query that creates alerts for this rule.ScheduledAlertRuleTemplateProperties
withQueryFrequency(Duration queryFrequency)
Set the queryFrequency property: The frequency (in ISO 8601 duration format) for this alert rule to run.ScheduledAlertRuleTemplateProperties
withQueryPeriod(Duration queryPeriod)
Set the queryPeriod property: The period (in ISO 8601 duration format) that this alert rule looks at.ScheduledAlertRuleTemplateProperties
withRequiredDataConnectors(List<AlertRuleTemplateDataSource> requiredDataConnectors)
Set the requiredDataConnectors property: The required data connectors for this template.ScheduledAlertRuleTemplateProperties
withSeverity(AlertSeverity severity)
Set the severity property: The severity for alerts created by this alert rule.ScheduledAlertRuleTemplateProperties
withStatus(TemplateStatus status)
Set the status property: The alert rule template status.ScheduledAlertRuleTemplateProperties
withTactics(List<AttackTactic> tactics)
Set the tactics property: The tactics of the alert rule template.ScheduledAlertRuleTemplateProperties
withTechniques(List<String> techniques)
Set the techniques property: The techniques of the alert rule.ScheduledAlertRuleTemplateProperties
withTriggerOperator(TriggerOperator triggerOperator)
Set the triggerOperator property: The operation against the threshold that triggers alert rule.ScheduledAlertRuleTemplateProperties
withTriggerThreshold(Integer triggerThreshold)
Set the triggerThreshold property: The threshold triggers this alert rule.ScheduledAlertRuleTemplateProperties
withVersion(String version)
Set the version property: The version of this template - in format <a.b.c>, where all are numbers.
-
-
-
Method Detail
-
alertRulesCreatedByTemplateCount
public Integer alertRulesCreatedByTemplateCount()
Get the alertRulesCreatedByTemplateCount property: the number of alert rules that were created by this template.- Returns:
- the alertRulesCreatedByTemplateCount value.
-
withAlertRulesCreatedByTemplateCount
public ScheduledAlertRuleTemplateProperties withAlertRulesCreatedByTemplateCount(Integer alertRulesCreatedByTemplateCount)
Set the alertRulesCreatedByTemplateCount property: the number of alert rules that were created by this template.- Parameters:
alertRulesCreatedByTemplateCount
- the alertRulesCreatedByTemplateCount value to set.- Returns:
- the ScheduledAlertRuleTemplateProperties object itself.
-
createdDateUtc
public OffsetDateTime createdDateUtc()
Get the createdDateUtc property: The time that this alert rule template has been added.- Returns:
- the createdDateUtc value.
-
lastUpdatedDateUtc
public OffsetDateTime lastUpdatedDateUtc()
Get the lastUpdatedDateUtc property: The time that this alert rule template was last updated.- Returns:
- the lastUpdatedDateUtc value.
-
description
public String description()
Get the description property: The description of the alert rule template.- Returns:
- the description value.
-
withDescription
public ScheduledAlertRuleTemplateProperties withDescription(String description)
Set the description property: The description of the alert rule template.- Parameters:
description
- the description value to set.- Returns:
- the ScheduledAlertRuleTemplateProperties object itself.
-
displayName
public String displayName()
Get the displayName property: The display name for alert rule template.- Returns:
- the displayName value.
-
withDisplayName
public ScheduledAlertRuleTemplateProperties withDisplayName(String displayName)
Set the displayName property: The display name for alert rule template.- Parameters:
displayName
- the displayName value to set.- Returns:
- the ScheduledAlertRuleTemplateProperties object itself.
-
requiredDataConnectors
public List<AlertRuleTemplateDataSource> requiredDataConnectors()
Get the requiredDataConnectors property: The required data connectors for this template.- Returns:
- the requiredDataConnectors value.
-
withRequiredDataConnectors
public ScheduledAlertRuleTemplateProperties withRequiredDataConnectors(List<AlertRuleTemplateDataSource> requiredDataConnectors)
Set the requiredDataConnectors property: The required data connectors for this template.- Parameters:
requiredDataConnectors
- the requiredDataConnectors value to set.- Returns:
- the ScheduledAlertRuleTemplateProperties object itself.
-
status
public TemplateStatus status()
Get the status property: The alert rule template status.- Returns:
- the status value.
-
withStatus
public ScheduledAlertRuleTemplateProperties withStatus(TemplateStatus status)
Set the status property: The alert rule template status.- Parameters:
status
- the status value to set.- Returns:
- the ScheduledAlertRuleTemplateProperties object itself.
-
query
public String query()
Get the query property: The query that creates alerts for this rule.- Returns:
- the query value.
-
withQuery
public ScheduledAlertRuleTemplateProperties withQuery(String query)
Set the query property: The query that creates alerts for this rule.- Parameters:
query
- the query value to set.- Returns:
- the ScheduledAlertRuleTemplateProperties 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 ScheduledAlertRuleTemplateProperties 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 ScheduledAlertRuleTemplateProperties 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 ScheduledAlertRuleTemplateProperties 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 ScheduledAlertRuleTemplateProperties 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 ScheduledAlertRuleTemplateProperties 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 ScheduledAlertRuleTemplateProperties 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 ScheduledAlertRuleTemplateProperties 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 ScheduledAlertRuleTemplateProperties object itself.
-
triggerThreshold
public Integer triggerThreshold()
Get the triggerThreshold property: The threshold triggers this alert rule.- Returns:
- the triggerThreshold value.
-
withTriggerThreshold
public ScheduledAlertRuleTemplateProperties withTriggerThreshold(Integer triggerThreshold)
Set the triggerThreshold property: The threshold triggers this alert rule.- Parameters:
triggerThreshold
- the triggerThreshold value to set.- Returns:
- the ScheduledAlertRuleTemplateProperties object itself.
-
tactics
public List<AttackTactic> tactics()
Get the tactics property: The tactics of the alert rule template.- Returns:
- the tactics value.
-
withTactics
public ScheduledAlertRuleTemplateProperties withTactics(List<AttackTactic> tactics)
Set the tactics property: The tactics of the alert rule template.- Parameters:
tactics
- the tactics value to set.- Returns:
- the ScheduledAlertRuleTemplateProperties object itself.
-
techniques
public List<String> techniques()
Get the techniques property: The techniques of the alert rule.- Returns:
- the techniques value.
-
withTechniques
public ScheduledAlertRuleTemplateProperties withTechniques(List<String> techniques)
Set the techniques property: The techniques of the alert rule.- Parameters:
techniques
- the techniques value to set.- Returns:
- the ScheduledAlertRuleTemplateProperties object itself.
-
version
public String version()
Get the version property: The version of this template - in format <a.b.c>, where all are numbers. For example <1.0.2>.- Returns:
- the version value.
-
withVersion
public ScheduledAlertRuleTemplateProperties withVersion(String version)
Set the version property: The version of this template - in format <a.b.c>, where all are numbers. For example <1.0.2>.- Parameters:
version
- the version value to set.- Returns:
- the ScheduledAlertRuleTemplateProperties object itself.
-
eventGroupingSettings
public EventGroupingSettings eventGroupingSettings()
Get the eventGroupingSettings property: The event grouping settings.- Returns:
- the eventGroupingSettings value.
-
withEventGroupingSettings
public ScheduledAlertRuleTemplateProperties withEventGroupingSettings(EventGroupingSettings eventGroupingSettings)
Set the eventGroupingSettings property: The event grouping settings.- Parameters:
eventGroupingSettings
- the eventGroupingSettings value to set.- Returns:
- the ScheduledAlertRuleTemplateProperties 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 ScheduledAlertRuleTemplateProperties 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 ScheduledAlertRuleTemplateProperties 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 ScheduledAlertRuleTemplateProperties 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 ScheduledAlertRuleTemplateProperties object itself.
-
alertDetailsOverride
public AlertDetailsOverride alertDetailsOverride()
Get the alertDetailsOverride property: The alert details override settings.- Returns:
- the alertDetailsOverride value.
-
withAlertDetailsOverride
public ScheduledAlertRuleTemplateProperties withAlertDetailsOverride(AlertDetailsOverride alertDetailsOverride)
Set the alertDetailsOverride property: The alert details override settings.- Parameters:
alertDetailsOverride
- the alertDetailsOverride value to set.- Returns:
- the ScheduledAlertRuleTemplateProperties object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-