Class RecommendationProperties


  • public final class RecommendationProperties
    extends Object
    Recommendation resource specific properties.
    • Constructor Detail

      • RecommendationProperties

        public RecommendationProperties()
    • Method Detail

      • creationTime

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

        public RecommendationProperties withCreationTime​(OffsetDateTime creationTime)
        Set the creationTime property: Timestamp when this instance was created.
        Parameters:
        creationTime - the creationTime value to set.
        Returns:
        the RecommendationProperties object itself.
      • recommendationId

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

        public RecommendationProperties withRecommendationId​(UUID recommendationId)
        Set the recommendationId property: A GUID value that each recommendation object is associated with.
        Parameters:
        recommendationId - the recommendationId value to set.
        Returns:
        the RecommendationProperties object itself.
      • resourceId

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

        public RecommendationProperties withResourceId​(String resourceId)
        Set the resourceId property: Full ARM resource ID string that this recommendation object is associated with.
        Parameters:
        resourceId - the resourceId value to set.
        Returns:
        the RecommendationProperties object itself.
      • 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.
      • withResourceScope

        public RecommendationProperties withResourceScope​(ResourceScopeType resourceScope)
        Set the resourceScope property: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.
        Parameters:
        resourceScope - the resourceScope value to set.
        Returns:
        the RecommendationProperties object itself.
      • ruleName

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

        public RecommendationProperties withRuleName​(String ruleName)
        Set the ruleName property: Unique name of the rule.
        Parameters:
        ruleName - the ruleName value to set.
        Returns:
        the RecommendationProperties object itself.
      • displayName

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

        public RecommendationProperties withDisplayName​(String displayName)
        Set the displayName property: UI friendly name of the rule (may not be unique).
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the RecommendationProperties object itself.
      • message

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

        public RecommendationProperties withMessage​(String message)
        Set the message property: Recommendation text.
        Parameters:
        message - the message value to set.
        Returns:
        the RecommendationProperties object itself.
      • level

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

        public RecommendationProperties withLevel​(NotificationLevel level)
        Set the level property: Level indicating how critical this recommendation can impact.
        Parameters:
        level - the level value to set.
        Returns:
        the RecommendationProperties object itself.
      • channels

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

        public RecommendationProperties withChannels​(Channels channels)
        Set the channels property: List of channels that this recommendation can apply.
        Parameters:
        channels - the channels value to set.
        Returns:
        the RecommendationProperties object itself.
      • 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.
      • withActionName

        public RecommendationProperties withActionName​(String actionName)
        Set the actionName property: Name of action recommended by this object.
        Parameters:
        actionName - the actionName value to set.
        Returns:
        the RecommendationProperties object itself.
      • 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.
      • withEnabled

        public RecommendationProperties withEnabled​(Integer enabled)
        Set the enabled property: True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.
        Parameters:
        enabled - the enabled value to set.
        Returns:
        the RecommendationProperties object itself.
      • 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.
      • withStates

        public RecommendationProperties withStates​(List<String> states)
        Set the states property: The list of states of this recommendation. If it's null then it should be considered "Active".
        Parameters:
        states - the states value to set.
        Returns:
        the RecommendationProperties object itself.
      • 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.
      • withStartTime

        public RecommendationProperties withStartTime​(OffsetDateTime startTime)
        Set the startTime property: The beginning time in UTC of a range that the recommendation refers to.
        Parameters:
        startTime - the startTime value to set.
        Returns:
        the RecommendationProperties object itself.
      • 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.
      • withEndTime

        public RecommendationProperties withEndTime​(OffsetDateTime endTime)
        Set the endTime property: The end time in UTC of a range that the recommendation refers to.
        Parameters:
        endTime - the endTime value to set.
        Returns:
        the RecommendationProperties object itself.
      • 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.
      • withNextNotificationTime

        public RecommendationProperties withNextNotificationTime​(OffsetDateTime nextNotificationTime)
        Set the nextNotificationTime property: When to notify this recommendation next in UTC. Null means that this will never be notified anymore.
        Parameters:
        nextNotificationTime - the nextNotificationTime value to set.
        Returns:
        the RecommendationProperties object itself.
      • notificationExpirationTime

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

        public RecommendationProperties withNotificationExpirationTime​(OffsetDateTime notificationExpirationTime)
        Set the notificationExpirationTime property: Date and time in UTC when this notification expires.
        Parameters:
        notificationExpirationTime - the notificationExpirationTime value to set.
        Returns:
        the RecommendationProperties object itself.
      • 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.
      • withNotifiedTime

        public RecommendationProperties withNotifiedTime​(OffsetDateTime notifiedTime)
        Set the notifiedTime property: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet.
        Parameters:
        notifiedTime - the notifiedTime value to set.
        Returns:
        the RecommendationProperties object itself.
      • score

        public Double score()
        Get the score property: A metric value measured by the rule.
        Returns:
        the score value.
      • withScore

        public RecommendationProperties withScore​(Double score)
        Set the score property: A metric value measured by the rule.
        Parameters:
        score - the score value to set.
        Returns:
        the RecommendationProperties object itself.
      • isDynamic

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

        public RecommendationProperties 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 RecommendationProperties object itself.
      • extensionName

        public String extensionName()
        Get the extensionName property: Extension name of the portal if exists.
        Returns:
        the extensionName value.
      • withExtensionName

        public RecommendationProperties withExtensionName​(String extensionName)
        Set the extensionName property: Extension name of the portal if exists.
        Parameters:
        extensionName - the extensionName value to set.
        Returns:
        the RecommendationProperties object itself.
      • bladeName

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

        public RecommendationProperties withBladeName​(String bladeName)
        Set the bladeName property: Deep link to a blade on the portal.
        Parameters:
        bladeName - the bladeName value to set.
        Returns:
        the RecommendationProperties object itself.
      • forwardLink

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

        public RecommendationProperties withForwardLink​(String forwardLink)
        Set the forwardLink property: Forward link to an external document associated with the rule.
        Parameters:
        forwardLink - the forwardLink value to set.
        Returns:
        the RecommendationProperties object itself.
      • validate

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