Class NrtAlertRuleTemplateProperties


public final class NrtAlertRuleTemplateProperties extends AlertRuleTemplateWithMitreProperties
NRT alert rule template properties.
  • Constructor Details

    • NrtAlertRuleTemplateProperties

      public NrtAlertRuleTemplateProperties()
  • Method Details

    • query

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

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

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

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

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

      public NrtAlertRuleTemplateProperties withEventGroupingSettings(EventGroupingSettings eventGroupingSettings)
      Set the eventGroupingSettings property: The event grouping settings.
      Parameters:
      eventGroupingSettings - the eventGroupingSettings value to set.
      Returns:
      the NrtAlertRuleTemplateProperties object itself.
    • withTactics

      public NrtAlertRuleTemplateProperties withTactics(List<AttackTactic> tactics)
      Set the tactics property: The tactics of the alert rule.
      Overrides:
      withTactics in class AlertRuleTemplateWithMitreProperties
      Parameters:
      tactics - the tactics value to set.
      Returns:
      the AlertRuleTemplateWithMitreProperties object itself.
    • withTechniques

      public NrtAlertRuleTemplateProperties withTechniques(List<String> techniques)
      Set the techniques property: The techniques of the alert rule.
      Overrides:
      withTechniques in class AlertRuleTemplateWithMitreProperties
      Parameters:
      techniques - the techniques value to set.
      Returns:
      the AlertRuleTemplateWithMitreProperties object itself.
    • withAlertRulesCreatedByTemplateCount

      public NrtAlertRuleTemplateProperties withAlertRulesCreatedByTemplateCount(Integer alertRulesCreatedByTemplateCount)
      Set the alertRulesCreatedByTemplateCount property: the number of alert rules that were created by this template.
      Overrides:
      withAlertRulesCreatedByTemplateCount in class AlertRuleTemplateWithMitreProperties
      Parameters:
      alertRulesCreatedByTemplateCount - the alertRulesCreatedByTemplateCount value to set.
      Returns:
      the AlertRuleTemplatePropertiesBase object itself.
    • withDescription

      public NrtAlertRuleTemplateProperties withDescription(String description)
      Set the description property: The description of the alert rule template.
      Overrides:
      withDescription in class AlertRuleTemplateWithMitreProperties
      Parameters:
      description - the description value to set.
      Returns:
      the AlertRuleTemplatePropertiesBase object itself.
    • withDisplayName

      public NrtAlertRuleTemplateProperties withDisplayName(String displayName)
      Set the displayName property: The display name for alert rule template.
      Overrides:
      withDisplayName in class AlertRuleTemplateWithMitreProperties
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the AlertRuleTemplatePropertiesBase object itself.
    • withRequiredDataConnectors

      public NrtAlertRuleTemplateProperties withRequiredDataConnectors(List<AlertRuleTemplateDataSource> requiredDataConnectors)
      Set the requiredDataConnectors property: The required data sources for this template.
      Overrides:
      withRequiredDataConnectors in class AlertRuleTemplateWithMitreProperties
      Parameters:
      requiredDataConnectors - the requiredDataConnectors value to set.
      Returns:
      the AlertRuleTemplatePropertiesBase object itself.
    • withStatus

      public NrtAlertRuleTemplateProperties withStatus(TemplateStatus status)
      Set the status property: The alert rule template status.
      Overrides:
      withStatus in class AlertRuleTemplateWithMitreProperties
      Parameters:
      status - the status value to set.
      Returns:
      the AlertRuleTemplatePropertiesBase object itself.
    • validate

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