Class: Azure::ARM::Web::Models::Recommendation

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

Overview

Represents a recommendation result generated by the recommendation engine.

Instance Attribute Summary collapse

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.



57
58
59
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 57

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.



89
90
91
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 89

def blade_name
  @blade_name
end

#channels ⇒ Channels

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

Returns:

  • (Channels) —

    List of channels that this recommendation can apply.



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

def channels
  @channels
end

#creation_time ⇒ DateTime

Returns Timestamp when this instance was created.

Returns:

  • (DateTime) —

    Timestamp when this instance was created.



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

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).



37
38
39
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 37

def display_name
  @display_name
end

#end_time ⇒ DateTime

recommendation refers to.

Returns:

  • (DateTime) —

    The end time in UTC of a range that the



65
66
67
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 65

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.



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

def extension_name
  @extension_name
end

#forward_link ⇒ String

the rule.

Returns:

  • (String) —

    Forward link to an external document associated with



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

def forward_link
  @forward_link
end

#is_dynamic ⇒ Boolean

rule

Returns:

  • (Boolean) —

    True if this is associated with a dynamically added



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

def is_dynamic
  @is_dynamic
end

#level ⇒ NotificationLevel

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

Returns:



45
46
47
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 45

def level
  @level
end

#message ⇒ String

Returns Recommendation text.

Returns:

  • (String) —

    Recommendation text.



40
41
42
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 40

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



69
70
71
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 69

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.



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

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



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

def notified_time
  @notified_time
end

#recommendation_id ⇒ String

associated with.

Returns:

  • (String) —

    A GUID value that each recommendation object is



22
23
24
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 22

def recommendation_id
  @recommendation_id
end

#resource_id ⇒ String

object is associated with.

Returns:

  • (String) —

    Full ARM resource ID string that this recommendation



26
27
28
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 26

def resource_id
  @resource_id
end

#resource_scope ⇒ ResourceScopeType

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

Returns:



31
32
33
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 31

def resource_scope
  @resource_scope
end

#rule_name ⇒ String

Returns Unique name of the rule.

Returns:

  • (String) —

    Unique name of the rule.



34
35
36
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 34

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.



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

def score
  @score
end

#start_time ⇒ DateTime

recommendation refers to.

Returns:

  • (DateTime) —

    The beginning time in UTC of a range that the



61
62
63
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 61

def start_time
  @start_time
end

#tags ⇒ Array<String>

recommendation belongs to.

Returns:

  • (Array<String>) —

    The list of category tags that this



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

def tags
  @tags
end

Class Method Details

.mapper ⇒ Object

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



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
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
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 100

def self.mapper()
  {
    required: false,
    serialized_name: 'Recommendation',
    type: {
      name: 'Composite',
      class_name: 'Recommendation',
      model_properties: {
        creation_time: {
          required: false,
          serialized_name: 'creationTime',
          type: {
            name: 'DateTime'
          }
        },
        recommendation_id: {
          required: false,
          serialized_name: 'recommendationId',
          type: {
            name: 'String'
          }
        },
        resource_id: {
          required: false,
          serialized_name: 'resourceId',
          type: {
            name: 'String'
          }
        },
        resource_scope: {
          required: false,
          serialized_name: 'resourceScope',
          type: {
            name: 'String'
          }
        },
        rule_name: {
          required: false,
          serialized_name: 'ruleName',
          type: {
            name: 'String'
          }
        },
        display_name: {
          required: false,
          serialized_name: 'displayName',
          type: {
            name: 'String'
          }
        },
        message: {
          required: false,
          serialized_name: 'message',
          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'
                }
            }
          }
        },
        action_name: {
          required: false,
          serialized_name: 'actionName',
          type: {
            name: 'String'
          }
        },
        start_time: {
          required: false,
          serialized_name: 'startTime',
          type: {
            name: 'DateTime'
          }
        },
        end_time: {
          required: false,
          serialized_name: 'endTime',
          type: {
            name: 'DateTime'
          }
        },
        next_notification_time: {
          required: false,
          serialized_name: 'nextNotificationTime',
          type: {
            name: 'DateTime'
          }
        },
        notification_expiration_time: {
          required: false,
          serialized_name: 'notificationExpirationTime',
          type: {
            name: 'DateTime'
          }
        },
        notified_time: {
          required: false,
          serialized_name: 'notifiedTime',
          type: {
            name: 'DateTime'
          }
        },
        score: {
          required: false,
          serialized_name: 'score',
          type: {
            name: 'Double'
          }
        },
        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