Class ScheduledAlertRuleTemplate


  • public final class ScheduledAlertRuleTemplate
    extends AlertRuleTemplateInner
    Represents scheduled alert rule template.
    • Constructor Detail

      • ScheduledAlertRuleTemplate

        public ScheduledAlertRuleTemplate()
    • 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 ScheduledAlertRuleTemplate 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 ScheduledAlertRuleTemplate 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 ScheduledAlertRuleTemplate withDescription​(String description)
        Set the description property: The description of the alert rule template.
        Parameters:
        description - the description value to set.
        Returns:
        the ScheduledAlertRuleTemplate object itself.
      • displayName

        public String displayName()
        Get the displayName property: The display name for alert rule template.
        Returns:
        the displayName value.
      • withDisplayName

        public ScheduledAlertRuleTemplate withDisplayName​(String displayName)
        Set the displayName property: The display name for alert rule template.
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the ScheduledAlertRuleTemplate object itself.
      • requiredDataConnectors

        public List<AlertRuleTemplateDataSource> requiredDataConnectors()
        Get the requiredDataConnectors property: The required data connectors for this template.
        Returns:
        the requiredDataConnectors value.
      • withRequiredDataConnectors

        public ScheduledAlertRuleTemplate withRequiredDataConnectors​(List<AlertRuleTemplateDataSource> requiredDataConnectors)
        Set the requiredDataConnectors property: The required data connectors for this template.
        Parameters:
        requiredDataConnectors - the requiredDataConnectors value to set.
        Returns:
        the ScheduledAlertRuleTemplate object itself.
      • status

        public TemplateStatus status()
        Get the status property: The alert rule template status.
        Returns:
        the status value.
      • withStatus

        public ScheduledAlertRuleTemplate withStatus​(TemplateStatus status)
        Set the status property: The alert rule template status.
        Parameters:
        status - the status value to set.
        Returns:
        the ScheduledAlertRuleTemplate object itself.
      • query

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

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

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

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

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

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

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

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

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

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

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

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