Class: Azure::ARM::Web::Models::RecommendationRule

Inherits:
Object
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/generated/azure_mgmt_web/models/recommendation_rule.rb

Overview

Represents a recommendation rule that the recommendation engine can perform.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#action_name ⇒ String

string.

Returns:

  • (String) —

    Name of action that is recommended by this rule in



36
37
38
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 36

def action_name
  @action_name
end

#blade_name ⇒ String

dynamic rule only.

Returns:

  • (String) —

    Deep link to a blade on the portal. Applicable to



62
63
64
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 62

def blade_name
  @blade_name
end

#channels ⇒ Channels

Possible values include: ‘Notification’, ‘Api’, ‘Email’, ‘Webhook’, ‘All’

Returns:

  • (Channels) —

    List of available channels that this rule applies.



46
47
48
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 46

def channels
  @channels
end

#description ⇒ String

Returns Localized detailed description of the rule.

Returns:

  • (String) —

    Localized detailed description of the rule.



32
33
34
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 32

def description
  @description
end

#display_name ⇒ String

Returns UI friendly name of the rule.

Returns:

  • (String) —

    UI friendly name of the rule.



21
22
23
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 21

def display_name
  @display_name
end

#extension_name ⇒ String

dynamic rule only.

Returns:

  • (String) —

    Extension name of the portal if exists. Applicable to



58
59
60
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 58

def extension_name
  @extension_name
end

#forward_link ⇒ String

the rule. Applicable to dynamic rule only.

Returns:

  • (String) —

    Forward link to an external document associated with



66
67
68
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 66

def forward_link
  @forward_link
end

#is_dynamic ⇒ Boolean

rule

Returns:

  • (Boolean) —

    True if this is associated with a dynamically added



54
55
56
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 54

def is_dynamic
  @is_dynamic
end

#level ⇒ NotificationLevel

this rule is. Possible values include: ‘Critical’, ‘Warning’, ‘Information’, ‘NonUrgentSuggestion’

Returns:



41
42
43
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 41

def level
  @level
end

#message ⇒ String

Returns Localized name of the rule (Good for UI).

Returns:

  • (String) —

    Localized name of the rule (Good for UI).



24
25
26
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 24

def message
  @message
end

#name ⇒ String

Returns Unique name of the rule.

Returns:

  • (String) —

    Unique name of the rule.



18
19
20
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 18

def name
  @name
end

#recommendation_id ⇒ Object

to the rule, if exists. If such an object doesn’t exist, it is set to null.

Returns:

  • Recommendation ID of an associated recommendation object tied



29
30
31
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 29

def recommendation_id
  @recommendation_id
end

#tags ⇒ Array<String>

contains.

Returns:

  • (Array<String>) —

    An array of category tags that the rule



50
51
52
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 50

def tags
  @tags
end

Class Method Details

.mapper ⇒ Object

Mapper for RecommendationRule class as Ruby Hash. This will be used for serialization/deserialization.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 73

def self.mapper()
  {
    required: false,
    serialized_name: 'RecommendationRule',
    type: {
      name: 'Composite',
      class_name: 'RecommendationRule',
      model_properties: {
        name: {
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        display_name: {
          required: false,
          serialized_name: 'displayName',
          type: {
            name: 'String'
          }
        },
        message: {
          required: false,
          serialized_name: 'message',
          type: {
            name: 'String'
          }
        },
        recommendation_id: {
          required: false,
          serialized_name: 'recommendationId',
          type: {
            name: 'String'
          }
        },
        description: {
          required: false,
          serialized_name: 'description',
          type: {
            name: 'String'
          }
        },
        action_name: {
          required: false,
          serialized_name: 'actionName',
          type: {
            name: 'String'
          }
        },
        level: {
          required: false,
          serialized_name: 'level',
          type: {
            name: 'Enum',
            module: 'NotificationLevel'
          }
        },
        channels: {
          required: false,
          serialized_name: 'channels',
          type: {
            name: 'Enum',
            module: 'Channels'
          }
        },
        tags: {
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        is_dynamic: {
          required: false,
          serialized_name: 'isDynamic',
          type: {
            name: 'Boolean'
          }
        },
        extension_name: {
          required: false,
          serialized_name: 'extensionName',
          type: {
            name: 'String'
          }
        },
        blade_name: {
          required: false,
          serialized_name: 'bladeName',
          type: {
            name: 'String'
          }
        },
        forward_link: {
          required: false,
          serialized_name: 'forwardLink',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end