Package com.azure.resourcemanager.monitor.fluent.models

Class ScheduledQueryRuleProperties

java.lang.Object
com.azure.resourcemanager.monitor.fluent.models.ScheduledQueryRuleProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ScheduledQueryRuleProperties>
public final class ScheduledQueryRuleProperties extends Object implements com.azure.json.JsonSerializable<ScheduledQueryRuleProperties>
scheduled query rule Definition.

  • Constructor Details

    • ScheduledQueryRuleProperties

      public ScheduledQueryRuleProperties()
      Creates an instance of ScheduledQueryRuleProperties class.

  • Method Details

    • createdWithApiVersion

      public String createdWithApiVersion()
      Get the createdWithApiVersion property: The api-version used when creating this alert rule.
      Returns:
      the createdWithApiVersion value.

    • isLegacyLogAnalyticsRule

      public Boolean isLegacyLogAnalyticsRule()
      Get the isLegacyLogAnalyticsRule property: True if alert rule is legacy Log Analytic rule.
      Returns:
      the isLegacyLogAnalyticsRule value.

    • description

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

    • withDescription

      public ScheduledQueryRuleProperties withDescription(String description)
      Set the description property: The description of the scheduled query rule.
      Parameters:
      description - the description value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • displayName

      public String displayName()
      Get the displayName property: The display name of the alert rule.
      Returns:
      the displayName value.

    • withDisplayName

      public ScheduledQueryRuleProperties withDisplayName(String displayName)
      Set the displayName property: The display name of the alert rule.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • severity

      public AlertSeverity severity()
      Get the severity property: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
      Returns:
      the severity value.

    • withSeverity

      public ScheduledQueryRuleProperties withSeverity(AlertSeverity severity)
      Set the severity property: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
      Parameters:
      severity - the severity value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • enabled

      public Boolean enabled()
      Get the enabled property: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false.
      Returns:
      the enabled value.

    • withEnabled

      public ScheduledQueryRuleProperties withEnabled(Boolean enabled)
      Set the enabled property: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false.
      Parameters:
      enabled - the enabled value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • scopes

      public List<String> scopes()
      Get the scopes property: The list of resource id's that this scheduled query rule is scoped to.
      Returns:
      the scopes value.

    • withScopes

      public ScheduledQueryRuleProperties withScopes(List<String> scopes)
      Set the scopes property: The list of resource id's that this scheduled query rule is scoped to.
      Parameters:
      scopes - the scopes value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • evaluationFrequency

      public Duration evaluationFrequency()
      Get the evaluationFrequency property: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
      Returns:
      the evaluationFrequency value.

    • withEvaluationFrequency

      public ScheduledQueryRuleProperties withEvaluationFrequency(Duration evaluationFrequency)
      Set the evaluationFrequency property: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
      Parameters:
      evaluationFrequency - the evaluationFrequency value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • windowSize

      public Duration windowSize()
      Get the windowSize property: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.
      Returns:
      the windowSize value.

    • withWindowSize

      public ScheduledQueryRuleProperties withWindowSize(Duration windowSize)
      Set the windowSize property: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.
      Parameters:
      windowSize - the windowSize value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • overrideQueryTimeRange

      public Duration overrideQueryTimeRange()
      Get the overrideQueryTimeRange property: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
      Returns:
      the overrideQueryTimeRange value.

    • withOverrideQueryTimeRange

      public ScheduledQueryRuleProperties withOverrideQueryTimeRange(Duration overrideQueryTimeRange)
      Set the overrideQueryTimeRange property: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
      Parameters:
      overrideQueryTimeRange - the overrideQueryTimeRange value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • targetResourceTypes

      public List<String> targetResourceTypes()
      Get the targetResourceTypes property: List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert.
      Returns:
      the targetResourceTypes value.

    • withTargetResourceTypes

      public ScheduledQueryRuleProperties withTargetResourceTypes(List<String> targetResourceTypes)
      Set the targetResourceTypes property: List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert.
      Parameters:
      targetResourceTypes - the targetResourceTypes value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • criteria

      public ScheduledQueryRuleCriteria criteria()
      Get the criteria property: The rule criteria that defines the conditions of the scheduled query rule.
      Returns:
      the criteria value.

    • withCriteria

      public ScheduledQueryRuleProperties withCriteria(ScheduledQueryRuleCriteria criteria)
      Set the criteria property: The rule criteria that defines the conditions of the scheduled query rule.
      Parameters:
      criteria - the criteria value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • muteActionsDuration

      public Duration muteActionsDuration()
      Get the muteActionsDuration property: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.
      Returns:
      the muteActionsDuration value.

    • withMuteActionsDuration

      public ScheduledQueryRuleProperties withMuteActionsDuration(Duration muteActionsDuration)
      Set the muteActionsDuration property: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.
      Parameters:
      muteActionsDuration - the muteActionsDuration value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • actions

      public Actions actions()
      Get the actions property: Actions to invoke when the alert fires.
      Returns:
      the actions value.

    • withActions

      public ScheduledQueryRuleProperties withActions(Actions actions)
      Set the actions property: Actions to invoke when the alert fires.
      Parameters:
      actions - the actions value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • isWorkspaceAlertsStorageConfigured

      public Boolean isWorkspaceAlertsStorageConfigured()
      Get the isWorkspaceAlertsStorageConfigured property: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
      Returns:
      the isWorkspaceAlertsStorageConfigured value.

    • checkWorkspaceAlertsStorageConfigured

      public Boolean checkWorkspaceAlertsStorageConfigured()
      Get the checkWorkspaceAlertsStorageConfigured property: The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert.
      Returns:
      the checkWorkspaceAlertsStorageConfigured value.

    • withCheckWorkspaceAlertsStorageConfigured

      public ScheduledQueryRuleProperties withCheckWorkspaceAlertsStorageConfigured(Boolean checkWorkspaceAlertsStorageConfigured)
      Set the checkWorkspaceAlertsStorageConfigured property: The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert.
      Parameters:
      checkWorkspaceAlertsStorageConfigured - the checkWorkspaceAlertsStorageConfigured value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • skipQueryValidation

      public Boolean skipQueryValidation()
      Get the skipQueryValidation property: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
      Returns:
      the skipQueryValidation value.

    • withSkipQueryValidation

      public ScheduledQueryRuleProperties withSkipQueryValidation(Boolean skipQueryValidation)
      Set the skipQueryValidation property: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
      Parameters:
      skipQueryValidation - the skipQueryValidation value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • autoMitigate

      public Boolean autoMitigate()
      Get the autoMitigate property: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
      Returns:
      the autoMitigate value.

    • withAutoMitigate

      public ScheduledQueryRuleProperties withAutoMitigate(Boolean autoMitigate)
      Set the autoMitigate property: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
      Parameters:
      autoMitigate - the autoMitigate value to set.
      Returns:
      the ScheduledQueryRuleProperties object itself.

    • validate

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ScheduledQueryRuleProperties>
      Throws:
      IOException

    • fromJson

      public static ScheduledQueryRuleProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ScheduledQueryRuleProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ScheduledQueryRuleProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the ScheduledQueryRuleProperties.