Class RecommendationRuleProperties

java.lang.Object
com.azure.resourcemanager.appservice.fluent.models.RecommendationRuleProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<RecommendationRuleProperties>
public final class RecommendationRuleProperties extends Object implements com.azure.json.JsonSerializable<RecommendationRuleProperties>
RecommendationRule resource specific properties.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    actionName()
    Get the actionName property: Name of action that is recommended by this rule in string.
    String
    bladeName()
    Get the bladeName property: Deep link to a blade on the portal.
    List<String>
    categoryTags()
    Get the categoryTags property: The list of category tags that this recommendation rule belongs to.
    Channels
    channels()
    Get the channels property: List of available channels that this rule applies.
    String
    description()
    Get the description property: Localized detailed description of the rule.
    String
    displayName()
    Get the displayName property: UI friendly name of the rule.
    String
    extensionName()
    Get the extensionName property: Extension name of the portal if exists.
    String
    forwardLink()
    Get the forwardLink property: Forward link to an external document associated with the rule.
    static RecommendationRuleProperties
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RecommendationRuleProperties from the JsonReader.
    Boolean
    isDynamic()
    Get the isDynamic property: True if this is associated with a dynamically added rule.
    NotificationLevel
    level()
    Get the level property: Level of impact indicating how critical this rule is.
    String
    message()
    Get the message property: Localized name of the rule (Good for UI).
    UUID
    recommendationId()
    Get the recommendationId property: Recommendation ID of an associated recommendation object tied to the rule, if exists.
    String
    recommendationName()
    Get the recommendationName property: Unique name of the rule.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Method Details

    • recommendationName

      public String recommendationName()
      Get the recommendationName property: Unique name of the rule.
      Returns:
      the recommendationName value.

    • displayName

      public String displayName()
      Get the displayName property: UI friendly name of the rule.
      Returns:
      the displayName value.

    • message

      public String message()
      Get the message property: Localized name of the rule (Good for UI).
      Returns:
      the message value.

    • recommendationId

      public UUID recommendationId()
      Get the recommendationId property: Recommendation ID of an associated recommendation object tied to the rule, if exists. If such an object doesn't exist, it is set to null.
      Returns:
      the recommendationId value.

    • description

      public String description()
      Get the description property: Localized detailed description of the rule.
      Returns:
      the description value.

    • actionName

      public String actionName()
      Get the actionName property: Name of action that is recommended by this rule in string.
      Returns:
      the actionName value.

    • level

      public NotificationLevel level()
      Get the level property: Level of impact indicating how critical this rule is.
      Returns:
      the level value.

    • channels

      public Channels channels()
      Get the channels property: List of available channels that this rule applies.
      Returns:
      the channels value.

    • categoryTags

      public List<String> categoryTags()
      Get the categoryTags property: The list of category tags that this recommendation rule belongs to.
      Returns:
      the categoryTags value.

    • isDynamic

      public Boolean isDynamic()
      Get the isDynamic property: True if this is associated with a dynamically added rule.
      Returns:
      the isDynamic value.

    • extensionName

      public String extensionName()
      Get the extensionName property: Extension name of the portal if exists. Applicable to dynamic rule only.
      Returns:
      the extensionName value.

    • bladeName

      public String bladeName()
      Get the bladeName property: Deep link to a blade on the portal. Applicable to dynamic rule only.
      Returns:
      the bladeName value.

    • forwardLink

      public String forwardLink()
      Get the forwardLink property: Forward link to an external document associated with the rule. Applicable to dynamic rule only.
      Returns:
      the forwardLink value.

    • 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<RecommendationRuleProperties>
      Throws:
      IOException

    • fromJson

      public static RecommendationRuleProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of RecommendationRuleProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of RecommendationRuleProperties 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 RecommendationRuleProperties.