Share via

RecommendationInner Class

  • Reference
Package:
com.azure.resourcemanager.appservice.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-appservice:2.44.0

public final class RecommendationInner
extends ProxyOnlyResource

Represents a recommendation result generated by the recommendation engine.

Constructor Summary

Constructor Description
RecommendationInner()

Creates an instance of RecommendationInner class.

Method Summary

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.
static RecommendationInner fromJson(JsonReader jsonReader)

Reads an instance of RecommendationInner from the JsonReader.
String id()

Get the id property: Fully qualified resource Id for the resource.
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.
String name()

Get the name property: The name of the resource.
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.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
void validate()

Validates the instance.
RecommendationInner withActionName(String actionName)

Set the actionName property: Name of action recommended by this object.
RecommendationInner withBladeName(String bladeName)

Set the bladeName property: Deep link to a blade on the portal.
RecommendationInner withChannels(Channels channels)

Set the channels property: List of channels that this recommendation can apply.
RecommendationInner withCreationTime(OffsetDateTime creationTime)

Set the creationTime property: Timestamp when this instance was created.
RecommendationInner withDisplayName(String displayName)

Set the displayName property: UI friendly name of the rule (may not be unique).
RecommendationInner withEnabled(Integer enabled)

Set the enabled property: True if this recommendation is still valid (i.e.
RecommendationInner withEndTime(OffsetDateTime endTime)

Set the endTime property: The end time in UTC of a range that the recommendation refers to.
RecommendationInner withExtensionName(String extensionName)

Set the extensionName property: Extension name of the portal if exists.
RecommendationInner withForwardLink(String forwardLink)

Set the forwardLink property: Forward link to an external document associated with the rule.
RecommendationInner withIsDynamic(Boolean isDynamic)

Set the isDynamic property: True if this is associated with a dynamically added rule.
RecommendationInner withKind(String kind)

Set the kind property: Kind of resource.
RecommendationInner withLevel(NotificationLevel level)

Set the level property: Level indicating how critical this recommendation can impact.
RecommendationInner withMessage(String message)

Set the message property: Recommendation text.
RecommendationInner withNextNotificationTime(OffsetDateTime nextNotificationTime)

Set the nextNotificationTime property: When to notify this recommendation next in UTC.
RecommendationInner withNotificationExpirationTime(OffsetDateTime notificationExpirationTime)

Set the notificationExpirationTime property: Date and time in UTC when this notification expires.
RecommendationInner withNotifiedTime(OffsetDateTime notifiedTime)

Set the notifiedTime property: Last timestamp in UTC this instance was actually notified.
RecommendationInner withRecommendationId(UUID recommendationId)

Set the recommendationId property: A GUID value that each recommendation object is associated with.
RecommendationInner withResourceId(String resourceId)

Set the resourceId property: Full ARM resource ID string that this recommendation object is associated with.
RecommendationInner withResourceScope(ResourceScopeType resourceScope)

Set the resourceScope property: Name of a resource type this recommendation applies, e.g.
RecommendationInner withRuleName(String ruleName)

Set the ruleName property: Unique name of the rule.
RecommendationInner withScore(Double score)

Set the score property: A metric value measured by the rule.
RecommendationInner withStartTime(OffsetDateTime startTime)

Set the startTime property: The beginning time in UTC of a range that the recommendation refers to.
RecommendationInner withStates(List<String> states)

Set the states property: The list of states of this recommendation.

Methods inherited from ProxyOnlyResource

fromJson id kind name toJson type validate withKind

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RecommendationInner

public RecommendationInner()

Creates an instance of RecommendationInner class.

Method Details

actionName

public String actionName()

Get the actionName property: Name of action recommended by this object.

Returns:

the actionName value.

bladeName

public String bladeName()

Get the bladeName property: Deep link to a blade on the portal.

Returns:

the bladeName value.

categoryTags

public List categoryTags()

Get the categoryTags property: The list of category tags that this recommendation belongs to.

Returns:

the categoryTags value.

channels

public Channels channels()

Get the channels property: List of channels that this recommendation can apply.

Returns:

the channels value.

creationTime

public OffsetDateTime creationTime()

Get the creationTime property: Timestamp when this instance was created.

Returns:

the creationTime value.

displayName

public String displayName()

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

Returns:

the displayName 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.

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.

extensionName

public String extensionName()

Get the extensionName property: Extension name of the portal if exists.

Returns:

the extensionName value.

forwardLink

public String forwardLink()

Get the forwardLink property: Forward link to an external document associated with the rule.

Returns:

the forwardLink value.

fromJson

public static RecommendationInner fromJson(JsonReader jsonReader)

Reads an instance of RecommendationInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RecommendationInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

RecommendationInner.id()

Returns:

the id value.

isDynamic

public Boolean isDynamic()

Get the isDynamic property: True if this is associated with a dynamically added rule.

Returns:

the isDynamic value.

level

public NotificationLevel level()

Get the level property: Level indicating how critical this recommendation can impact.

Returns:

the level value.

message

public String message()

Get the message property: Recommendation text.

Returns:

the message value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

RecommendationInner.name()

Returns:

the name 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.

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.

score

public Double score()

Get the score property: A metric value measured by the rule.

Returns:

the score 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.

states

public List 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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

RecommendationInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

RecommendationInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

RecommendationInner.validate()

withActionName

public RecommendationInner withActionName(String actionName)

Set the actionName property: Name of action recommended by this object.

Parameters:

actionName - the actionName value to set.

Returns:

the RecommendationInner object itself.

withBladeName

public RecommendationInner withBladeName(String bladeName)

Set the bladeName property: Deep link to a blade on the portal.

Parameters:

bladeName - the bladeName value to set.

Returns:

the RecommendationInner object itself.

withChannels

public RecommendationInner withChannels(Channels channels)

Set the channels property: List of channels that this recommendation can apply.

Parameters:

channels - the channels value to set.

Returns:

the RecommendationInner object itself.

withCreationTime

public RecommendationInner withCreationTime(OffsetDateTime creationTime)

Set the creationTime property: Timestamp when this instance was created.

Parameters:

creationTime - the creationTime value to set.

Returns:

the RecommendationInner object itself.

withDisplayName

public RecommendationInner 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 RecommendationInner object itself.

withEnabled

public RecommendationInner 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 RecommendationInner object itself.

withEndTime

public RecommendationInner 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 RecommendationInner object itself.

withExtensionName

public RecommendationInner withExtensionName(String extensionName)

Set the extensionName property: Extension name of the portal if exists.

Parameters:

extensionName - the extensionName value to set.

Returns:

the RecommendationInner object itself.

withForwardLink

public RecommendationInner 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 RecommendationInner object itself.

withIsDynamic

public RecommendationInner 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 RecommendationInner object itself.

withKind

public RecommendationInner withKind(String kind)

Set the kind property: Kind of resource.

Overrides:

RecommendationInner.withKind(String kind)

Parameters:

kind

withLevel

public RecommendationInner withLevel(NotificationLevel level)

Set the level property: Level indicating how critical this recommendation can impact.

Parameters:

level - the level value to set.

Returns:

the RecommendationInner object itself.

withMessage

public RecommendationInner withMessage(String message)

Set the message property: Recommendation text.

Parameters:

message - the message value to set.

Returns:

the RecommendationInner object itself.

withNextNotificationTime

public RecommendationInner 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 RecommendationInner object itself.

withNotificationExpirationTime

public RecommendationInner 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 RecommendationInner object itself.

withNotifiedTime

public RecommendationInner 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 RecommendationInner object itself.

withRecommendationId

public RecommendationInner 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 RecommendationInner object itself.

withResourceId

public RecommendationInner 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 RecommendationInner object itself.

withResourceScope

public RecommendationInner 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 RecommendationInner object itself.

withRuleName

public RecommendationInner withRuleName(String ruleName)

Set the ruleName property: Unique name of the rule.

Parameters:

ruleName - the ruleName value to set.

Returns:

the RecommendationInner object itself.

withScore

public RecommendationInner withScore(Double score)

Set the score property: A metric value measured by the rule.

Parameters:

score - the score value to set.

Returns:

the RecommendationInner object itself.

withStartTime

public RecommendationInner 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 RecommendationInner object itself.

withStates

public RecommendationInner withStates(List 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 RecommendationInner object itself.

Applies to