Class RecommendationRuleInner

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.appservice.fluent.models.RecommendationRuleInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>

public final class RecommendationRuleInner extends com.azure.core.management.ProxyResource
Represents a recommendation rule that the recommendation engine can perform.
  • Method Summary

    Modifier and Type
    Method
    Description
    Get the actionName property: Name of action that is recommended by this rule in string.
    Get the bladeName property: Deep link to a blade on the portal.
    Get the categoryTags property: The list of category tags that this recommendation rule belongs to.
    Get the channels property: List of available channels that this rule applies.
    Get the description property: Localized detailed description of the rule.
    Get the displayName property: UI friendly name of the rule.
    Get the extensionName property: Extension name of the portal if exists.
    Get the forwardLink property: Forward link to an external document associated with the rule.
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RecommendationRuleInner from the JsonReader.
    id()
    Get the id property: Fully qualified resource Id for the resource.
    Get the isDynamic property: True if this is associated with a dynamically added rule.
    Get the kind property: Kind of resource.
    Get the level property: Level of impact indicating how critical this rule is.
    Get the message property: Localized name of the rule (Good for UI).
    Get the name property: The name of the resource.
    Get the recommendationId property: Recommendation ID of an associated recommendation object tied to the rule, if exists.
    Get the recommendationName property: Unique name of the rule.
    com.azure.core.management.SystemData
    Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    Get the type property: The type of the resource.
    void
    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

    • kind

      public String kind()
      Get the kind property: Kind of resource.
      Returns:
      the kind value.
    • systemData

      public com.azure.core.management.SystemData systemData()
      Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      Returns:
      the systemData value.
    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class com.azure.core.management.ProxyResource
      Returns:
      the type value.
    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class com.azure.core.management.ProxyResource
      Returns:
      the name value.
    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class com.azure.core.management.ProxyResource
      Returns:
      the id value.
    • 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<com.azure.core.management.ProxyResource>
      Overrides:
      toJson in class com.azure.core.management.ProxyResource
      Throws:
      IOException
    • fromJson

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