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.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of RecommendationProperties class. -
Method Summary
Modifier and TypeMethodDescriptionGet the actionName property: Name of action recommended by this object.Get the bladeName property: Deep link to a blade on the portal.Get the categoryTags property: The list of category tags that this recommendation belongs to.channels()
Get the channels property: List of channels that this recommendation can apply.Get the creationTime property: Timestamp when this instance was created.Get the displayName property: UI friendly name of the rule (may not be unique).enabled()
Get the enabled property: True if this recommendation is still valid (i.e.endTime()
Get the endTime property: The end time in UTC of a range that the recommendation refers to.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.static RecommendationProperties
fromJson
(com.azure.json.JsonReader jsonReader) Reads an instance of RecommendationProperties from the JsonReader.Get the isDynamic property: True if this is associated with a dynamically added rule.level()
Get the level property: Level indicating how critical this recommendation can impact.message()
Get the message property: Recommendation text.Get the nextNotificationTime property: When to notify this recommendation next in UTC.Get the notificationExpirationTime property: Date and time in UTC when this notification expires.Get the notifiedTime property: Last timestamp in UTC this instance was actually notified.Get the recommendationId property: A GUID value that each recommendation object is associated with.Get the resourceId property: Full ARM resource ID string that this recommendation object is associated with.Get the resourceScope property: Name of a resource type this recommendation applies, e.g.ruleName()
Get the ruleName property: Unique name of the rule.score()
Get the score property: A metric value measured by the rule.Get the startTime property: The beginning time in UTC of a range that the recommendation refers to.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.withActionName
(String actionName) Set the actionName property: Name of action recommended by this object.withBladeName
(String bladeName) Set the bladeName property: Deep link to a blade on the portal.withChannels
(Channels channels) Set the channels property: List of channels that this recommendation can apply.withCreationTime
(OffsetDateTime creationTime) Set the creationTime property: Timestamp when this instance was created.withDisplayName
(String displayName) Set the displayName property: UI friendly name of the rule (may not be unique).withEnabled
(Integer enabled) Set the enabled property: True if this recommendation is still valid (i.e.withEndTime
(OffsetDateTime endTime) Set the endTime property: The end time in UTC of a range that the recommendation refers to.withExtensionName
(String extensionName) Set the extensionName property: Extension name of the portal if exists.withForwardLink
(String forwardLink) Set the forwardLink property: Forward link to an external document associated with the rule.withIsDynamic
(Boolean isDynamic) Set the isDynamic property: True if this is associated with a dynamically added rule.withLevel
(NotificationLevel level) Set the level property: Level indicating how critical this recommendation can impact.withMessage
(String message) Set the message property: Recommendation text.withNextNotificationTime
(OffsetDateTime nextNotificationTime) Set the nextNotificationTime property: When to notify this recommendation next in UTC.withNotificationExpirationTime
(OffsetDateTime notificationExpirationTime) Set the notificationExpirationTime property: Date and time in UTC when this notification expires.withNotifiedTime
(OffsetDateTime notifiedTime) Set the notifiedTime property: Last timestamp in UTC this instance was actually notified.withRecommendationId
(UUID recommendationId) Set the recommendationId property: A GUID value that each recommendation object is associated with.withResourceId
(String resourceId) Set the resourceId property: Full ARM resource ID string that this recommendation object is associated with.withResourceScope
(ResourceScopeType resourceScope) Set the resourceScope property: Name of a resource type this recommendation applies, e.g.withRuleName
(String ruleName) Set the ruleName property: Unique name of the rule.Set the score property: A metric value measured by the rule.withStartTime
(OffsetDateTime startTime) Set the startTime property: The beginning time in UTC of a range that the recommendation refers to.withStates
(List<String> states) Set the states property: The list of states of this recommendation.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
RecommendationProperties
public RecommendationProperties()Creates an instance of RecommendationProperties class.
-
-
Method Details
-
creationTime
Get the creationTime property: Timestamp when this instance was created.- Returns:
- the creationTime value.
-
withCreationTime
Set the creationTime property: Timestamp when this instance was created.- Parameters:
creationTime
- the creationTime value to set.- Returns:
- the RecommendationProperties object itself.
-
recommendationId
Get the recommendationId property: A GUID value that each recommendation object is associated with.- Returns:
- the recommendationId value.
-
withRecommendationId
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
Get the resourceId property: Full ARM resource ID string that this recommendation object is associated with.- Returns:
- the resourceId value.
-
withResourceId
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
Get the resourceScope property: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.- Returns:
- the resourceScope value.
-
withResourceScope
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
Get the ruleName property: Unique name of the rule.- Returns:
- the ruleName value.
-
withRuleName
Set the ruleName property: Unique name of the rule.- Parameters:
ruleName
- the ruleName value to set.- Returns:
- the RecommendationProperties object itself.
-
displayName
Get the displayName property: UI friendly name of the rule (may not be unique).- Returns:
- the displayName value.
-
withDisplayName
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
Get the message property: Recommendation text.- Returns:
- the message value.
-
withMessage
Set the message property: Recommendation text.- Parameters:
message
- the message value to set.- Returns:
- the RecommendationProperties object itself.
-
level
Get the level property: Level indicating how critical this recommendation can impact.- Returns:
- the level value.
-
withLevel
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
Get the channels property: List of channels that this recommendation can apply.- Returns:
- the channels value.
-
withChannels
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
Get the categoryTags property: The list of category tags that this recommendation belongs to.- Returns:
- the categoryTags value.
-
actionName
Get the actionName property: Name of action recommended by this object.- Returns:
- the actionName value.
-
withActionName
Set the actionName property: Name of action recommended by this object.- Parameters:
actionName
- the actionName value to set.- Returns:
- the RecommendationProperties object itself.
-
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
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
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
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
Get the startTime property: The beginning time in UTC of a range that the recommendation refers to.- Returns:
- the startTime value.
-
withStartTime
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
Get the endTime property: The end time in UTC of a range that the recommendation refers to.- Returns:
- the endTime value.
-
withEndTime
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
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
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
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
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
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
Get the score property: A metric value measured by the rule.- Returns:
- the score value.
-
withScore
Set the score property: A metric value measured by the rule.- Parameters:
score
- the score value to set.- Returns:
- the RecommendationProperties object itself.
-
isDynamic
Get the isDynamic property: True if this is associated with a dynamically added rule.- Returns:
- the isDynamic value.
-
withIsDynamic
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
Get the extensionName property: Extension name of the portal if exists.- Returns:
- the extensionName value.
-
withExtensionName
Set the extensionName property: Extension name of the portal if exists.- Parameters:
extensionName
- the extensionName value to set.- Returns:
- the RecommendationProperties object itself.
-
bladeName
Get the bladeName property: Deep link to a blade on the portal.- Returns:
- the bladeName value.
-
withBladeName
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
Get the forwardLink property: Forward link to an external document associated with the rule.- Returns:
- the forwardLink value.
-
withForwardLink
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.
-
toJson
- Specified by:
toJson
in interfacecom.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.
-