Class RecommendationRuleInner

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.appservice.models.ProxyOnlyResource
com.azure.resourcemanager.appservice.fluent.models.RecommendationRuleInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class RecommendationRuleInner extends ProxyOnlyResource
Represents a recommendation rule that the recommendation engine can perform.

  • Constructor Details

    • RecommendationRuleInner

      public RecommendationRuleInner()
      Creates an instance of RecommendationRuleInner class.

  • Method Details

    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class ProxyOnlyResource
      Returns:
      the type value.

    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class ProxyOnlyResource
      Returns:
      the name value.

    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class ProxyOnlyResource
      Returns:
      the id value.

    • withKind

      public RecommendationRuleInner withKind(String kind)
      Set the kind property: Kind of resource.
      Overrides:
      withKind in class ProxyOnlyResource
      Parameters:
      kind - the kind value to set.
      Returns:
      the ProxyOnlyResource object itself.

    • recommendationName

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

    • withRecommendationName

      public RecommendationRuleInner withRecommendationName(String recommendationName)
      Set the recommendationName property: Unique name of the rule.
      Parameters:
      recommendationName - the recommendationName value to set.
      Returns:
      the RecommendationRuleInner object itself.

    • displayName

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

    • withDisplayName

      public RecommendationRuleInner withDisplayName(String displayName)
      Set the displayName property: UI friendly name of the rule.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the RecommendationRuleInner object itself.

    • message

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

    • withMessage

      public RecommendationRuleInner withMessage(String message)
      Set the message property: Localized name of the rule (Good for UI).
      Parameters:
      message - the message value to set.
      Returns:
      the RecommendationRuleInner object itself.

    • 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.

    • withRecommendationId

      public RecommendationRuleInner withRecommendationId(UUID recommendationId)
      Set 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.
      Parameters:
      recommendationId - the recommendationId value to set.
      Returns:
      the RecommendationRuleInner object itself.

    • description

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

    • withDescription

      public RecommendationRuleInner withDescription(String description)
      Set the description property: Localized detailed description of the rule.
      Parameters:
      description - the description value to set.
      Returns:
      the RecommendationRuleInner object itself.

    • actionName

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

    • withActionName

      public RecommendationRuleInner withActionName(String actionName)
      Set the actionName property: Name of action that is recommended by this rule in string.
      Parameters:
      actionName - the actionName value to set.
      Returns:
      the RecommendationRuleInner object itself.

    • level

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

    • withLevel

      public RecommendationRuleInner withLevel(NotificationLevel level)
      Set the level property: Level of impact indicating how critical this rule is.
      Parameters:
      level - the level value to set.
      Returns:
      the RecommendationRuleInner object itself.

    • channels

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

    • withChannels

      public RecommendationRuleInner withChannels(Channels channels)
      Set the channels property: List of available channels that this rule applies.
      Parameters:
      channels - the channels value to set.
      Returns:
      the RecommendationRuleInner object itself.

    • 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.

    • withIsDynamic

      public RecommendationRuleInner withIsDynamic(Boolean isDynamic)
      Set the isDynamic property: True if this is associated with a dynamically added rule.
      Parameters:
      isDynamic - the isDynamic value to set.
      Returns:
      the RecommendationRuleInner object itself.

    • extensionName

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

    • withExtensionName

      public RecommendationRuleInner withExtensionName(String extensionName)
      Set the extensionName property: Extension name of the portal if exists. Applicable to dynamic rule only.
      Parameters:
      extensionName - the extensionName value to set.
      Returns:
      the RecommendationRuleInner object itself.

    • 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.

    • withBladeName

      public RecommendationRuleInner withBladeName(String bladeName)
      Set the bladeName property: Deep link to a blade on the portal. Applicable to dynamic rule only.
      Parameters:
      bladeName - the bladeName value to set.
      Returns:
      the RecommendationRuleInner object itself.

    • 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.

    • withForwardLink

      public RecommendationRuleInner withForwardLink(String forwardLink)
      Set the forwardLink property: Forward link to an external document associated with the rule. Applicable to dynamic rule only.
      Parameters:
      forwardLink - the forwardLink value to set.
      Returns:
      the RecommendationRuleInner object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ProxyOnlyResource
      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 ProxyOnlyResource
      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.