Class: Azure::Web::Mgmt::V2018_02_01::Models::Recommendation

Inherits:
ProxyOnlyResource show all
Includes:
MsRestAzure
Defined in:
lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb

Overview

Represents a recommendation result generated by the recommendation engine.

Instance Attribute Summary collapse

Attributes inherited from ProxyOnlyResource

#id, #kind, #name, #type

Class Method Summary collapse

Instance Attribute Details

#action_name ⇒ String

Returns Name of action recommended by this object.

Returns:

  • (String) —

    Name of action recommended by this object.



56
57
58
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 56

def action_name
  @action_name
end

#blade_name ⇒ String

Returns Deep link to a blade on the portal.

Returns:

  • (String) —

    Deep link to a blade on the portal.



96
97
98
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 96

def blade_name
  @blade_name
end

#category_tags ⇒ Array<String>

recommendation belongs to.

Returns:

  • (Array<String>) —

    The list of category tags that this



53
54
55
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 53

def category_tags
  @category_tags
end

#channels ⇒ Channels

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

Returns:

  • (Channels) —

    List of channels that this recommendation can apply.



49
50
51
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 49

def channels
  @channels
end

#creation_time ⇒ DateTime

Returns Timestamp when this instance was created.

Returns:

  • (DateTime) —

    Timestamp when this instance was created.



17
18
19
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 17

def creation_time
  @creation_time
end

#display_name ⇒ String

Returns UI friendly name of the rule (may not be unique).

Returns:

  • (String) —

    UI friendly name of the rule (may not be unique).



36
37
38
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 36

def display_name
  @display_name
end

#enabled ⇒ Integer

“actionable”). False if it is invalid.

Returns:

  • (Integer) —

    True if this recommendation is still valid (i.e.



60
61
62
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 60

def enabled
  @enabled
end

#end_time ⇒ DateTime

recommendation refers to.

Returns:

  • (DateTime) —

    The end time in UTC of a range that the



72
73
74
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 72

def end_time
  @end_time
end

#extension_name ⇒ String

Returns Extension name of the portal if exists.

Returns:

  • (String) —

    Extension name of the portal if exists.



93
94
95
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 93

def extension_name
  @extension_name
end

#forward_link ⇒ String

the rule.

Returns:

  • (String) —

    Forward link to an external document associated with



100
101
102
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 100

def forward_link
  @forward_link
end

#is_dynamic ⇒ Boolean

rule

Returns:

  • (Boolean) —

    True if this is associated with a dynamically added



90
91
92
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 90

def is_dynamic
  @is_dynamic
end

#level ⇒ NotificationLevel

recommendation can impact. Possible values include: ‘Critical’, ‘Warning’, ‘Information’, ‘NonUrgentSuggestion’

Returns:



44
45
46
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 44

def level
  @level
end

#message ⇒ String

Returns Recommendation text.

Returns:

  • (String) —

    Recommendation text.



39
40
41
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 39

def message
  @message
end

#next_notification_time ⇒ DateTime

means that this will never be notified anymore.

Returns:

  • (DateTime) —

    When to notify this recommendation next in UTC. Null



76
77
78
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 76

def next_notification_time
  @next_notification_time
end

#notification_expiration_time ⇒ DateTime

Returns Date and time in UTC when this notification expires.

Returns:

  • (DateTime) —

    Date and time in UTC when this notification expires.



79
80
81
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 79

def notification_expiration_time
  @notification_expiration_time
end

#notified_time ⇒ DateTime

notified. Null means that this recommendation hasn’t been notified yet.

Returns:

  • (DateTime) —

    Last timestamp in UTC this instance was actually



83
84
85
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 83

def notified_time
  @notified_time
end

#recommendation_id ⇒ Object

with.

Returns:

  • A GUID value that each recommendation object is associated



21
22
23
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 21

def recommendation_id
  @recommendation_id
end

#resource_id ⇒ String

object is associated with.

Returns:

  • (String) —

    Full ARM resource ID string that this recommendation



25
26
27
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 25

def resource_id
  @resource_id
end

#resource_scope ⇒ ResourceScopeType

applies, e.g. Subscription, ServerFarm, Site. Possible values include: ‘ServerFarm’, ‘Subscription’, ‘WebSite’

Returns:



30
31
32
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 30

def resource_scope
  @resource_scope
end

#rule_name ⇒ String

Returns Unique name of the rule.

Returns:

  • (String) —

    Unique name of the rule.



33
34
35
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 33

def rule_name
  @rule_name
end

#score ⇒ Float

Returns A metric value measured by the rule.

Returns:

  • (Float) —

    A metric value measured by the rule.



86
87
88
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 86

def score
  @score
end

#start_time ⇒ DateTime

recommendation refers to.

Returns:

  • (DateTime) —

    The beginning time in UTC of a range that the



68
69
70
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 68

def start_time
  @start_time
end

#states ⇒ Array<String>

it’s null then it shoud be considered “Active”.

Returns:

  • (Array<String>) —

    The list of states of this recommendation. If



64
65
66
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 64

def states
  @states
end

Class Method Details

.mapper ⇒ Object

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



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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation.rb', line 107

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Recommendation',
    type: {
      name: 'Composite',
      class_name: 'Recommendation',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        creation_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.creationTime',
          type: {
            name: 'DateTime'
          }
        },
        recommendation_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.recommendationId',
          type: {
            name: 'String'
          }
        },
        resource_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.resourceId',
          type: {
            name: 'String'
          }
        },
        resource_scope: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.resourceScope',
          type: {
            name: 'String'
          }
        },
        rule_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.ruleName',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.displayName',
          type: {
            name: 'String'
          }
        },
        message: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.message',
          type: {
            name: 'String'
          }
        },
        level: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.level',
          type: {
            name: 'Enum',
            module: 'NotificationLevel'
          }
        },
        channels: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.channels',
          type: {
            name: 'Enum',
            module: 'Channels'
          }
        },
        category_tags: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.categoryTags',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        action_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.actionName',
          type: {
            name: 'String'
          }
        },
        enabled: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enabled',
          type: {
            name: 'Number'
          }
        },
        states: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.states',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        start_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.startTime',
          type: {
            name: 'DateTime'
          }
        },
        end_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.endTime',
          type: {
            name: 'DateTime'
          }
        },
        next_notification_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.nextNotificationTime',
          type: {
            name: 'DateTime'
          }
        },
        notification_expiration_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.notificationExpirationTime',
          type: {
            name: 'DateTime'
          }
        },
        notified_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.notifiedTime',
          type: {
            name: 'DateTime'
          }
        },
        score: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.score',
          type: {
            name: 'Double'
          }
        },
        is_dynamic: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isDynamic',
          type: {
            name: 'Boolean'
          }
        },
        extension_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.extensionName',
          type: {
            name: 'String'
          }
        },
        blade_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.bladeName',
          type: {
            name: 'String'
          }
        },
        forward_link: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.forwardLink',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end