Share via

RecommendationRuleInner Class

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

public final class RecommendationRuleInner
extends ProxyOnlyResource

Represents a recommendation rule that the recommendation engine can perform.

Constructor Summary

Constructor Description
RecommendationRuleInner()

Creates an instance of RecommendationRuleInner class.

Method Summary

Modifier and Type Method and Description
String actionName()

Get the actionName property: Name of action that is recommended by this rule in string.
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 rule belongs to.
Channels channels()

Get the channels property: List of available channels that this rule applies.
String description()

Get the description property: Localized detailed description of the rule.
String displayName()

Get the displayName property: UI friendly name of the rule.
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 RecommendationRuleInner fromJson(JsonReader jsonReader)

Reads an instance of RecommendationRuleInner 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 of impact indicating how critical this rule is.
String message()

Get the message property: Localized name of the rule (Good for UI).
String name()

Get the name property: The name of the resource.
UUID recommendationId()

Get the recommendationId property: Recommendation ID of an associated recommendation object tied to the rule, if exists.
String recommendationName()

Get the recommendationName property: Unique name of the rule.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

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

Validates the instance.
RecommendationRuleInner withActionName(String actionName)

Set the actionName property: Name of action that is recommended by this rule in string.
RecommendationRuleInner withBladeName(String bladeName)

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

Set the channels property: List of available channels that this rule applies.
RecommendationRuleInner withDescription(String description)

Set the description property: Localized detailed description of the rule.
RecommendationRuleInner withDisplayName(String displayName)

Set the displayName property: UI friendly name of the rule.
RecommendationRuleInner withExtensionName(String extensionName)

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

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

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

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

Set the level property: Level of impact indicating how critical this rule is.
RecommendationRuleInner withMessage(String message)

Set the message property: Localized name of the rule (Good for UI).
RecommendationRuleInner withRecommendationId(UUID recommendationId)

Set the recommendationId property: Recommendation ID of an associated recommendation object tied to the rule, if exists.
RecommendationRuleInner withRecommendationName(String recommendationName)

Set the recommendationName property: Unique name of the rule.

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

RecommendationRuleInner

public RecommendationRuleInner()

Creates an instance of RecommendationRuleInner class.

Method Details

actionName

public String actionName()

Get the actionName property: Name of action that is recommended by this rule in string.

Returns:

the actionName value.

bladeName

public String bladeName()

Get the bladeName property: Deep link to a blade on the portal. Applicable to dynamic rule only.

Returns:

the bladeName value.

categoryTags

public List categoryTags()

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

Returns:

the categoryTags value.

channels

public Channels channels()

Get the channels property: List of available channels that this rule applies.

Returns:

the channels value.

description

public String description()

Get the description property: Localized detailed description of the rule.

Returns:

the description value.

displayName

public String displayName()

Get the displayName property: UI friendly name of the rule.

Returns:

the displayName value.

extensionName

public String extensionName()

Get the extensionName property: Extension name of the portal if exists. Applicable to dynamic rule only.

Returns:

the extensionName value.

forwardLink

public String forwardLink()

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

Returns:

the forwardLink value.

fromJson

public static RecommendationRuleInner fromJson(JsonReader jsonReader)

Reads an instance of RecommendationRuleInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RecommendationRuleInner 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:

RecommendationRuleInner.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 of impact indicating how critical this rule is.

Returns:

the level value.

message

public String message()

Get the message property: Localized name of the rule (Good for UI).

Returns:

the message value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

RecommendationRuleInner.name()

Returns:

the name value.

recommendationId

public UUID recommendationId()

Get the recommendationId property: Recommendation ID of an associated recommendation object tied to the rule, if exists. If such an object doesn't exist, it is set to null.

Returns:

the recommendationId value.

recommendationName

public String recommendationName()

Get the recommendationName property: Unique name of the rule.

Returns:

the recommendationName value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

RecommendationRuleInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

RecommendationRuleInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

RecommendationRuleInner.validate()

withActionName

public RecommendationRuleInner withActionName(String actionName)

Set the actionName property: Name of action that is recommended by this rule in string.

Parameters:

actionName - the actionName value to set.

Returns:

the RecommendationRuleInner object itself.

withBladeName

public RecommendationRuleInner withBladeName(String bladeName)

Set the bladeName property: Deep link to a blade on the portal. Applicable to dynamic rule only.

Parameters:

bladeName - the bladeName value to set.

Returns:

the RecommendationRuleInner object itself.

withChannels

public RecommendationRuleInner withChannels(Channels channels)

Set the channels property: List of available channels that this rule applies.

Parameters:

channels - the channels value to set.

Returns:

the RecommendationRuleInner object itself.

withDescription

public RecommendationRuleInner withDescription(String description)

Set the description property: Localized detailed description of the rule.

Parameters:

description - the description value to set.

Returns:

the RecommendationRuleInner object itself.

withDisplayName

public RecommendationRuleInner withDisplayName(String displayName)

Set the displayName property: UI friendly name of the rule.

Parameters:

displayName - the displayName value to set.

Returns:

the RecommendationRuleInner object itself.

withExtensionName

public RecommendationRuleInner withExtensionName(String extensionName)

Set the extensionName property: Extension name of the portal if exists. Applicable to dynamic rule only.

Parameters:

extensionName - the extensionName value to set.

Returns:

the RecommendationRuleInner object itself.

withForwardLink

public RecommendationRuleInner withForwardLink(String forwardLink)

Set the forwardLink property: Forward link to an external document associated with the rule. Applicable to dynamic rule only.

Parameters:

forwardLink - the forwardLink value to set.

Returns:

the RecommendationRuleInner object itself.

withIsDynamic

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

withKind

public RecommendationRuleInner withKind(String kind)

Set the kind property: Kind of resource.

Overrides:

RecommendationRuleInner.withKind(String kind)

Parameters:

kind

withLevel

public RecommendationRuleInner withLevel(NotificationLevel level)

Set the level property: Level of impact indicating how critical this rule is.

Parameters:

level - the level value to set.

Returns:

the RecommendationRuleInner object itself.

withMessage

public RecommendationRuleInner withMessage(String message)

Set the message property: Localized name of the rule (Good for UI).

Parameters:

message - the message value to set.

Returns:

the RecommendationRuleInner object itself.

withRecommendationId

public RecommendationRuleInner withRecommendationId(UUID recommendationId)

Set the recommendationId property: Recommendation ID of an associated recommendation object tied to the rule, if exists. If such an object doesn't exist, it is set to null.

Parameters:

recommendationId - the recommendationId value to set.

Returns:

the RecommendationRuleInner object itself.

withRecommendationName

public RecommendationRuleInner withRecommendationName(String recommendationName)

Set the recommendationName property: Unique name of the rule.

Parameters:

recommendationName - the recommendationName value to set.

Returns:

the RecommendationRuleInner object itself.

Applies to