public final class RecommendationProperties extends Object
| Constructor and Description |
|---|
RecommendationProperties() |
| Modifier and Type | Method and 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.
|
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.
|
void |
validate()
Validates the instance.
|
RecommendationProperties |
withActionName(String actionName)
Set the actionName property: Name of action recommended by this object.
|
RecommendationProperties |
withBladeName(String bladeName)
Set the bladeName property: Deep link to a blade on the portal.
|
RecommendationProperties |
withChannels(Channels channels)
Set the channels property: List of channels that this recommendation can apply.
|
RecommendationProperties |
withCreationTime(OffsetDateTime creationTime)
Set the creationTime property: Timestamp when this instance was created.
|
RecommendationProperties |
withDisplayName(String displayName)
Set the displayName property: UI friendly name of the rule (may not be unique).
|
RecommendationProperties |
withEnabled(Integer enabled)
Set the enabled property: True if this recommendation is still valid (i.e.
|
RecommendationProperties |
withEndTime(OffsetDateTime endTime)
Set the endTime property: The end time in UTC of a range that the recommendation refers to.
|
RecommendationProperties |
withExtensionName(String extensionName)
Set the extensionName property: Extension name of the portal if exists.
|
RecommendationProperties |
withForwardLink(String forwardLink)
Set the forwardLink property: Forward link to an external document associated with the rule.
|
RecommendationProperties |
withIsDynamic(Boolean isDynamic)
Set the isDynamic property: True if this is associated with a dynamically added rule.
|
RecommendationProperties |
withLevel(NotificationLevel level)
Set the level property: Level indicating how critical this recommendation can impact.
|
RecommendationProperties |
withMessage(String message)
Set the message property: Recommendation text.
|
RecommendationProperties |
withNextNotificationTime(OffsetDateTime nextNotificationTime)
Set the nextNotificationTime property: When to notify this recommendation next in UTC.
|
RecommendationProperties |
withNotificationExpirationTime(OffsetDateTime notificationExpirationTime)
Set the notificationExpirationTime property: Date and time in UTC when this notification expires.
|
RecommendationProperties |
withNotifiedTime(OffsetDateTime notifiedTime)
Set the notifiedTime property: Last timestamp in UTC this instance was actually notified.
|
RecommendationProperties |
withRecommendationId(UUID recommendationId)
Set the recommendationId property: A GUID value that each recommendation object is associated with.
|
RecommendationProperties |
withResourceId(String resourceId)
Set the resourceId property: Full ARM resource ID string that this recommendation object is associated with.
|
RecommendationProperties |
withResourceScope(ResourceScopeType resourceScope)
Set the resourceScope property: Name of a resource type this recommendation applies, e.g.
|
RecommendationProperties |
withRuleName(String ruleName)
Set the ruleName property: Unique name of the rule.
|
RecommendationProperties |
withScore(Double score)
Set the score property: A metric value measured by the rule.
|
RecommendationProperties |
withStartTime(OffsetDateTime startTime)
Set the startTime property: The beginning time in UTC of a range that the recommendation refers to.
|
RecommendationProperties |
withStates(List<String> states)
Set the states property: The list of states of this recommendation.
|
public OffsetDateTime creationTime()
public RecommendationProperties withCreationTime(OffsetDateTime creationTime)
creationTime - the creationTime value to set.public UUID recommendationId()
public RecommendationProperties withRecommendationId(UUID recommendationId)
recommendationId - the recommendationId value to set.public String resourceId()
public RecommendationProperties withResourceId(String resourceId)
resourceId - the resourceId value to set.public ResourceScopeType resourceScope()
public RecommendationProperties withResourceScope(ResourceScopeType resourceScope)
resourceScope - the resourceScope value to set.public String ruleName()
public RecommendationProperties withRuleName(String ruleName)
ruleName - the ruleName value to set.public String displayName()
public RecommendationProperties withDisplayName(String displayName)
displayName - the displayName value to set.public String message()
public RecommendationProperties withMessage(String message)
message - the message value to set.public NotificationLevel level()
public RecommendationProperties withLevel(NotificationLevel level)
level - the level value to set.public Channels channels()
public RecommendationProperties withChannels(Channels channels)
channels - the channels value to set.public List<String> categoryTags()
public String actionName()
public RecommendationProperties withActionName(String actionName)
actionName - the actionName value to set.public Integer enabled()
public RecommendationProperties withEnabled(Integer enabled)
enabled - the enabled value to set.public List<String> states()
public RecommendationProperties withStates(List<String> states)
states - the states value to set.public OffsetDateTime startTime()
public RecommendationProperties withStartTime(OffsetDateTime startTime)
startTime - the startTime value to set.public OffsetDateTime endTime()
public RecommendationProperties withEndTime(OffsetDateTime endTime)
endTime - the endTime value to set.public OffsetDateTime nextNotificationTime()
public RecommendationProperties withNextNotificationTime(OffsetDateTime nextNotificationTime)
nextNotificationTime - the nextNotificationTime value to set.public OffsetDateTime notificationExpirationTime()
public RecommendationProperties withNotificationExpirationTime(OffsetDateTime notificationExpirationTime)
notificationExpirationTime - the notificationExpirationTime value to set.public OffsetDateTime notifiedTime()
public RecommendationProperties withNotifiedTime(OffsetDateTime notifiedTime)
notifiedTime - the notifiedTime value to set.public Double score()
public RecommendationProperties withScore(Double score)
score - the score value to set.public Boolean isDynamic()
public RecommendationProperties withIsDynamic(Boolean isDynamic)
isDynamic - the isDynamic value to set.public String extensionName()
public RecommendationProperties withExtensionName(String extensionName)
extensionName - the extensionName value to set.public String bladeName()
public RecommendationProperties withBladeName(String bladeName)
bladeName - the bladeName value to set.public String forwardLink()
public RecommendationProperties withForwardLink(String forwardLink)
forwardLink - the forwardLink value to set.public void validate()
IllegalArgumentException - thrown if the instance is not valid.Copyright © 2021 Microsoft Corporation. All rights reserved.