Package com.azure.resourcemanager.securityinsights.fluent.models

Class NrtAlertRuleProperties

  • public final class NrtAlertRuleProperties
extends Object
    Nrt alert rule base property bag.

    • Constructor Detail

      • NrtAlertRuleProperties

        public NrtAlertRuleProperties()

    • Method Detail

      • 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties object itself.

      • description

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

      • withDescription

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

      • query

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

      • withQuery

        public NrtAlertRuleProperties withQuery​(String query)
        Set the query property: The query that creates alerts for this rule.
        Parameters:
        query - the query value to set.
        Returns:
        the NrtAlertRuleProperties object itself.

      • tactics

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

      • withTactics

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

      • techniques

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

      • withTechniques

        public NrtAlertRuleProperties withTechniques​(List<String> techniques)
        Set the techniques property: The techniques of the alert rule.
        Parameters:
        techniques - the techniques value to set.
        Returns:
        the NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties 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 NrtAlertRuleProperties object itself.

      • alertDetailsOverride

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

      • withAlertDetailsOverride

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

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.