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

Inherits:
Object
  • Object
show all
Includes:
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.



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

def action_name
  @action_name
end

#channels ⇒ Channels

apply. Possible values include: ‘Notification’, ‘Api’, ‘Email’, ‘All’

Returns:

  • (Channels) —

    List of channels that this recommendation can



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

def channels
  @channels
end

#creation_time ⇒ DateTime

Returns Timestamp when this instance was created.

Returns:

  • (DateTime) —

    Timestamp when this instance was created.



16
17
18
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 16

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)



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

def display_name
  @display_name
end

#enabled ⇒ Integer

or disabled.

Returns:

  • (Integer) —

    On/off flag indicating the rule is currently enabled



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

def enabled
  @enabled
end

#end_time ⇒ DateTime

refers to.

Returns:

  • (DateTime) —

    The end time of a range that the recommendation



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

def end_time
  @end_time
end

#level ⇒ NotificationLevel

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

Returns:



42
43
44
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 42

def level
  @level
end

#message ⇒ String

Returns Localized text of recommendation, good for UI.

Returns:

  • (String) —

    Localized text of recommendation, good for UI.



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

def message
  @message
end

#next_notification_time ⇒ DateTime

that this will never be notified anymore.

Returns:

  • (DateTime) —

    When to notify this recommendation next. Null means



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 when this notification expires.

Returns:

  • (DateTime) —

    Date and time 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

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

Returns:

  • (DateTime) —

    Last timestamp this instance was actually notified.



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



20
21
22
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 20

def recommendation_id
  @recommendation_id
end

#resource_id ⇒ String

object is associated with.

Returns:

  • (String) —

    Full ARM resource ID string that this recommendation



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

def resource_id
  @resource_id
end

#resource_scope ⇒ String

e.g. Subscription, ServerFarm, Site.

Returns:

  • (String) —

    Name of a resource type this recommendation applies,



28
29
30
 
# File 'lib/generated/azure_mgmt_web/models/recommendation.rb', line 28

def resource_scope
  @resource_scope
end

#rule_name ⇒ String

Returns Unique name of the rule.

Returns:

  • (String) —

    Unique name of the rule



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

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



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

def tags
  @tags
end

Class Method Details

.mapper ⇒ Object

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



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

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: true,
          serialized_name: 'level',
          type: {
            name: 'Enum',
            module: 'NotificationLevel'
          }
        },
        channels: {
          required: true,
          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'
          }
        },
        enabled: {
          required: false,
          serialized_name: 'enabled',
          type: {
            name: 'Number'
          }
        },
        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'
          }
        }
      }
    }
  }
end