Class RecommendationProperties

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    actionName()
    Get the actionName property: Name of action recommended by this object.
    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 belongs to.
    Channels
    channels()
    Get the channels property: List of channels that this recommendation can apply.
    OffsetDateTime
    creationTime()
    Get the creationTime property: Timestamp when this instance was created.
    String
    displayName()
    Get the displayName property: UI friendly name of the rule (may not be unique).
    Integer
    enabled()
    Get the enabled property: True if this recommendation is still valid (i.e.
    OffsetDateTime
    endTime()
    Get the endTime property: The end time in UTC of a range that the recommendation refers to.
    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 RecommendationProperties
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RecommendationProperties 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 indicating how critical this recommendation can impact.
    String
    message()
    Get the message property: Recommendation text.
    OffsetDateTime
    nextNotificationTime()
    Get the nextNotificationTime property: When to notify this recommendation next in UTC.
    OffsetDateTime
    notificationExpirationTime()
    Get the notificationExpirationTime property: Date and time in UTC when this notification expires.
    OffsetDateTime
    notifiedTime()
    Get the notifiedTime property: Last timestamp in UTC this instance was actually notified.
    UUID
    recommendationId()
    Get the recommendationId property: A GUID value that each recommendation object is associated with.
    String
    resourceId()
    Get the resourceId property: Full ARM resource ID string that this recommendation object is associated with.
    ResourceScopeType
    resourceScope()
    Get the resourceScope property: Name of a resource type this recommendation applies, e.g.
    String
    ruleName()
    Get the ruleName property: Unique name of the rule.
    Double
    score()
    Get the score property: A metric value measured by the rule.
    OffsetDateTime
    startTime()
    Get the startTime property: The beginning time in UTC of a range that the recommendation refers to.
    List<String>
    states()
    Get the states property: The list of states of this recommendation.
    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

    • creationTime

      public OffsetDateTime creationTime()
      Get the creationTime property: Timestamp when this instance was created.
      Returns:
      the creationTime value.

    • recommendationId

      public UUID recommendationId()
      Get the recommendationId property: A GUID value that each recommendation object is associated with.
      Returns:
      the recommendationId value.

    • resourceId

      public String resourceId()
      Get the resourceId property: Full ARM resource ID string that this recommendation object is associated with.
      Returns:
      the resourceId value.

    • resourceScope

      public ResourceScopeType resourceScope()
      Get the resourceScope property: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.
      Returns:
      the resourceScope value.

    • ruleName

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

    • displayName

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

    • message

      public String message()
      Get the message property: Recommendation text.
      Returns:
      the message value.

    • level

      public NotificationLevel level()
      Get the level property: Level indicating how critical this recommendation can impact.
      Returns:
      the level value.

    • channels

      public Channels channels()
      Get the channels property: List of channels that this recommendation can apply.
      Returns:
      the channels value.

    • categoryTags

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

    • actionName

      public String actionName()
      Get the actionName property: Name of action recommended by this object.
      Returns:
      the actionName value.

    • enabled

      public Integer enabled()
      Get the enabled property: True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.
      Returns:
      the enabled value.

    • states

      public List<String> states()
      Get the states property: The list of states of this recommendation. If it's null then it should be considered "Active".
      Returns:
      the states value.

    • startTime

      public OffsetDateTime startTime()
      Get the startTime property: The beginning time in UTC of a range that the recommendation refers to.
      Returns:
      the startTime value.

    • endTime

      public OffsetDateTime endTime()
      Get the endTime property: The end time in UTC of a range that the recommendation refers to.
      Returns:
      the endTime value.

    • nextNotificationTime

      public OffsetDateTime nextNotificationTime()
      Get the nextNotificationTime property: When to notify this recommendation next in UTC. Null means that this will never be notified anymore.
      Returns:
      the nextNotificationTime value.

    • notificationExpirationTime

      public OffsetDateTime notificationExpirationTime()
      Get the notificationExpirationTime property: Date and time in UTC when this notification expires.
      Returns:
      the notificationExpirationTime value.

    • notifiedTime

      public OffsetDateTime notifiedTime()
      Get the notifiedTime property: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet.
      Returns:
      the notifiedTime value.

    • score

      public Double score()
      Get the score property: A metric value measured by the rule.
      Returns:
      the score 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.
      Returns:
      the extensionName value.

    • bladeName

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

    • forwardLink

      public String forwardLink()
      Get the forwardLink property: Forward link to an external document associated with the rule.
      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<RecommendationProperties>
      Throws:
      IOException

    • fromJson

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