Package com.azure.resourcemanager.securityinsights.models

Class ScheduledAlertRule

  • public final class ScheduledAlertRule
extends AlertRuleInner
    Represents scheduled alert rule.

    • Constructor Detail

      • ScheduledAlertRule

        public ScheduledAlertRule()

    • Method Detail

      • withEtag

        public ScheduledAlertRule withEtag​(String etag)
        Set the etag property: Etag of the azure resource.
        Overrides:
        withEtag in class AlertRuleInner
        Parameters:
        etag - the etag value to set.
        Returns:
        the ResourceWithEtag object itself.

      • alertRuleTemplateName

        public String alertRuleTemplateName()
        Get the alertRuleTemplateName property: The Name of the alert rule template used to create this rule.
        Returns:
        the alertRuleTemplateName value.

      • withAlertRuleTemplateName

        public ScheduledAlertRule withAlertRuleTemplateName​(String alertRuleTemplateName)
        Set the alertRuleTemplateName property: The Name of the alert rule template used to create this rule.
        Parameters:
        alertRuleTemplateName - the alertRuleTemplateName value to set.
        Returns:
        the ScheduledAlertRule object itself.

      • templateVersion

        public String templateVersion()
        Get the templateVersion property: The version of the alert rule template used to create this rule - in format <a.b.c>, where all are numbers, for example 0 <1.0.2>.
        Returns:
        the templateVersion value.

      • withTemplateVersion

        public ScheduledAlertRule withTemplateVersion​(String templateVersion)
        Set the templateVersion property: The version of the alert rule template used to create this rule - in format <a.b.c>, where all are numbers, for example 0 <1.0.2>.
        Parameters:
        templateVersion - the templateVersion value to set.
        Returns:
        the ScheduledAlertRule object itself.

      • description

        public String description()
        Get the description property: The description of the alert rule.
        Returns:
        the description value.

      • withDescription

        public ScheduledAlertRule withDescription​(String description)
        Set the description property: The description of the alert rule.
        Parameters:
        description - the description value to set.
        Returns:
        the ScheduledAlertRule object itself.

      • displayName

        public String displayName()
        Get the displayName property: The display name for alerts created by this alert rule.
        Returns:
        the displayName value.

      • withDisplayName

        public ScheduledAlertRule withDisplayName​(String displayName)
        Set the displayName property: The display name for alerts created by this alert rule.
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the ScheduledAlertRule object itself.

      • enabled

        public Boolean enabled()
        Get the enabled property: Determines whether this alert rule is enabled or disabled.
        Returns:
        the enabled value.

      • withEnabled

        public ScheduledAlertRule withEnabled​(Boolean enabled)
        Set the enabled property: Determines whether this alert rule is enabled or disabled.
        Parameters:
        enabled - the enabled value to set.
        Returns:
        the ScheduledAlertRule object itself.

      • lastModifiedUtc

        public OffsetDateTime lastModifiedUtc()
        Get the lastModifiedUtc property: The last time that this alert rule has been modified.
        Returns:
        the lastModifiedUtc value.

      • suppressionDuration

        public Duration suppressionDuration()
        Get the suppressionDuration property: The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.
        Returns:
        the suppressionDuration value.

      • withSuppressionDuration

        public ScheduledAlertRule withSuppressionDuration​(Duration suppressionDuration)
        Set the suppressionDuration property: The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.
        Parameters:
        suppressionDuration - the suppressionDuration value to set.
        Returns:
        the ScheduledAlertRule object itself.

      • suppressionEnabled

        public Boolean suppressionEnabled()
        Get the suppressionEnabled property: Determines whether the suppression for this alert rule is enabled or disabled.
        Returns:
        the suppressionEnabled value.

      • withSuppressionEnabled

        public ScheduledAlertRule withSuppressionEnabled​(Boolean suppressionEnabled)
        Set the suppressionEnabled property: Determines whether the suppression for this alert rule is enabled or disabled.
        Parameters:
        suppressionEnabled - the suppressionEnabled value to set.
        Returns:
        the ScheduledAlertRule object itself.

      • tactics

        public List<AttackTactic> tactics()
        Get the tactics property: The tactics of the alert rule.
        Returns:
        the tactics value.

      • withTactics

        public ScheduledAlertRule withTactics​(List<AttackTactic> tactics)
        Set the tactics property: The tactics of the alert rule.
        Parameters:
        tactics - the tactics value to set.
        Returns:
        the ScheduledAlertRule object itself.

      • techniques

        public List<String> techniques()
        Get the techniques property: The techniques of the alert rule.
        Returns:
        the techniques value.

      • withTechniques

        public ScheduledAlertRule withTechniques​(List<String> techniques)
        Set the techniques property: The techniques of the alert rule.
        Parameters:
        techniques - the techniques value to set.
        Returns:
        the ScheduledAlertRule object itself.

      • incidentConfiguration

        public IncidentConfiguration incidentConfiguration()
        Get the incidentConfiguration property: The settings of the incidents that created from alerts triggered by this analytics rule.
        Returns:
        the incidentConfiguration value.

      • withIncidentConfiguration

        public ScheduledAlertRule withIncidentConfiguration​(IncidentConfiguration incidentConfiguration)
        Set the incidentConfiguration property: The settings of the incidents that created from alerts triggered by this analytics rule.
        Parameters:
        incidentConfiguration - the incidentConfiguration value to set.
        Returns:
        the ScheduledAlertRule object itself.

      • query

        public String query()
        Get the query property: The query that creates alerts for this rule.
        Returns:
        the query value.

      • withQuery

        public ScheduledAlertRule withQuery​(String query)
        Set the query property: The query that creates alerts for this rule.
        Parameters:
        query - the query value to set.
        Returns:
        the ScheduledAlertRule 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 ScheduledAlertRule 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 ScheduledAlertRule 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 ScheduledAlertRule 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 ScheduledAlertRule 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 ScheduledAlertRule 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 ScheduledAlertRule 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 ScheduledAlertRule 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 ScheduledAlertRule object itself.

      • triggerThreshold

        public Integer triggerThreshold()
        Get the triggerThreshold property: The threshold triggers this alert rule.
        Returns:
        the triggerThreshold value.

      • withTriggerThreshold

        public ScheduledAlertRule withTriggerThreshold​(Integer triggerThreshold)
        Set the triggerThreshold property: The threshold triggers this alert rule.
        Parameters:
        triggerThreshold - the triggerThreshold value to set.
        Returns:
        the ScheduledAlertRule object itself.

      • eventGroupingSettings

        public EventGroupingSettings eventGroupingSettings()
        Get the eventGroupingSettings property: The event grouping settings.
        Returns:
        the eventGroupingSettings value.

      • withEventGroupingSettings

        public ScheduledAlertRule withEventGroupingSettings​(EventGroupingSettings eventGroupingSettings)
        Set the eventGroupingSettings property: The event grouping settings.
        Parameters:
        eventGroupingSettings - the eventGroupingSettings value to set.
        Returns:
        the ScheduledAlertRule 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 ScheduledAlertRule 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 ScheduledAlertRule 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 ScheduledAlertRule 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 ScheduledAlertRule object itself.

      • alertDetailsOverride

        public AlertDetailsOverride alertDetailsOverride()
        Get the alertDetailsOverride property: The alert details override settings.
        Returns:
        the alertDetailsOverride value.

      • withAlertDetailsOverride

        public ScheduledAlertRule withAlertDetailsOverride​(AlertDetailsOverride alertDetailsOverride)
        Set the alertDetailsOverride property: The alert details override settings.
        Parameters:
        alertDetailsOverride - the alertDetailsOverride value to set.
        Returns:
        the ScheduledAlertRule object itself.