Class: Azure::SQL::Mgmt::V2015_05_01_preview::Models::RecommendedAction

Inherits:
ProxyResource show all
Includes:
MsRestAzure
Defined in:
lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb

Overview

Database, Server or Elastic Pool Recommended Action.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#details ⇒ Object

Returns Gets additional details specific to this recommended action.

Returns:

  • Gets additional details specific to this recommended action.



117
118
119
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 117

def details
  @details
end

#error_details ⇒ RecommendedActionErrorInfo

this recommended action is put to error state.

Returns:



96
97
98
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 96

def error_details
  @error_details
end

#estimated_impact ⇒ Array<RecommendedActionImpactRecord>

impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change

Returns:



101
102
103
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 101

def estimated_impact
  @estimated_impact
end

#execute_action_duration ⇒ String

action on user resource. e.g., time taken for index creation

Returns:

  • (String) —

    Gets the time taken for applying this recommended



56
57
58
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 56

def execute_action_duration
  @execute_action_duration
end

#execute_action_initiated_by ⇒ RecommendedActionInitiatedBy

this recommended action was given by user/system. Possible values include: ‘User’, ‘System’

Returns:



71
72
73
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 71

def execute_action_initiated_by
  @execute_action_initiated_by
end

#execute_action_initiated_time ⇒ DateTime

approved for execution.

Returns:

  • (DateTime) —

    Gets the time when this recommended action was



75
76
77
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 75

def execute_action_initiated_time
  @execute_action_initiated_time
end

#execute_action_start_time ⇒ DateTime

recommended action on the user resource. e.g., index creation start time

Returns:

  • (DateTime) —

    Gets the time when system started applying this



52
53
54
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 52

def execute_action_start_time
  @execute_action_start_time
end

#implementation_details ⇒ RecommendedActionImplementationInfo

details of this recommended action for user to apply it manually.

Returns:



92
93
94
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 92

def implementation_details
  @implementation_details
end

#is_archived_action ⇒ Boolean

time ago but user chose to ignore this and system added a new recommended action again.

Returns:

  • (Boolean) —

    Gets if this recommended action was suggested some



47
48
49
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 47

def is_archived_action
  @is_archived_action
end

#is_executable_action ⇒ Boolean

Returns Gets if this recommended action is actionable by user.

Returns:

  • (Boolean) —

    Gets if this recommended action is actionable by user



38
39
40
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 38

def is_executable_action
  @is_executable_action
end

#is_revertable_action ⇒ Boolean

can be reverted by user

Returns:

  • (Boolean) —

    Gets if changes applied by this recommended action



42
43
44
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 42

def is_revertable_action
  @is_revertable_action
end

#kind ⇒ String

Returns Resource kind.

Returns:

  • (String) —

    Resource kind.



16
17
18
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 16

def kind
  @kind
end

#last_refresh ⇒ DateTime

refreshed.

Returns:

  • (DateTime) —

    Gets time when this recommended action was last



31
32
33
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 31

def last_refresh
  @last_refresh
end

#linked_objects ⇒ Array<String>

Returns Gets the linked objects, if any.

Returns:

  • (Array<String>) —

    Gets the linked objects, if any.



114
115
116
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 114

def linked_objects
  @linked_objects
end

#location ⇒ String

Returns Resource location.

Returns:

  • (String) —

    Resource location.



19
20
21
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 19

def location
  @location
end

#observed_impact ⇒ Array<RecommendedActionImpactRecord>

impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change

Returns:



106
107
108
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 106

def observed_impact
  @observed_impact
end

#recommendation_reason ⇒ String

DuplicateIndex

Returns:

  • (String) —

    Gets the reason for recommending this action. e.g.,



23
24
25
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 23

def recommendation_reason
  @recommendation_reason
end

#revert_action_duration ⇒ String

recommended action on user resource. e.g., time taken for dropping the created index.

Returns:

  • (String) —

    Gets the time taken for reverting changes of this



66
67
68
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 66

def revert_action_duration
  @revert_action_duration
end

#revert_action_initiated_by ⇒ RecommendedActionInitiatedBy

this recommended action was given by user/system. Possible values include: ‘User’, ‘System’

Returns:



80
81
82
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 80

def revert_action_initiated_by
  @revert_action_initiated_by
end

#revert_action_initiated_time ⇒ DateTime

approved for revert.

Returns:

  • (DateTime) —

    Gets the time when this recommended action was



84
85
86
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 84

def revert_action_initiated_time
  @revert_action_initiated_time
end

#revert_action_start_time ⇒ DateTime

of this recommended action on user resource. e.g., time when index drop is executed.

Returns:

  • (DateTime) —

    Gets the time when system started reverting changes



61
62
63
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 61

def revert_action_start_time
  @revert_action_start_time
end

#score ⇒ Integer

values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact

Returns:

  • (Integer) —

    Gets the impact of this recommended action. Possible



88
89
90
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 88

def score
  @score
end

#state ⇒ RecommendedActionStateInfo

the recommended action is in.

Returns:



35
36
37
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 35

def state
  @state
end

#time_series ⇒ Array<RecommendedActionMetricInfo>

of metrics for this recommended action e.g., CPU consumption time series

Returns:



111
112
113
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 111

def time_series
  @time_series
end

#valid_since ⇒ DateTime

valid.

Returns:

  • (DateTime) —

    Gets the time since when this recommended action is



27
28
29
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 27

def valid_since
  @valid_since
end

Class Method Details

.mapper ⇒ Object

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



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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/models/recommended_action.rb', line 124

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'RecommendedAction',
    type: {
      name: 'Composite',
      class_name: 'RecommendedAction',
      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'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        recommendation_reason: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.recommendationReason',
          type: {
            name: 'String'
          }
        },
        valid_since: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.validSince',
          type: {
            name: 'DateTime'
          }
        },
        last_refresh: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastRefresh',
          type: {
            name: 'DateTime'
          }
        },
        state: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.state',
          type: {
            name: 'Composite',
            class_name: 'RecommendedActionStateInfo'
          }
        },
        is_executable_action: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.isExecutableAction',
          type: {
            name: 'Boolean'
          }
        },
        is_revertable_action: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.isRevertableAction',
          type: {
            name: 'Boolean'
          }
        },
        is_archived_action: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.isArchivedAction',
          type: {
            name: 'Boolean'
          }
        },
        execute_action_start_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.executeActionStartTime',
          type: {
            name: 'DateTime'
          }
        },
        execute_action_duration: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.executeActionDuration',
          type: {
            name: 'String'
          }
        },
        revert_action_start_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.revertActionStartTime',
          type: {
            name: 'DateTime'
          }
        },
        revert_action_duration: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.revertActionDuration',
          type: {
            name: 'String'
          }
        },
        execute_action_initiated_by: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.executeActionInitiatedBy',
          type: {
            name: 'Enum',
            module: 'RecommendedActionInitiatedBy'
          }
        },
        execute_action_initiated_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.executeActionInitiatedTime',
          type: {
            name: 'DateTime'
          }
        },
        revert_action_initiated_by: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.revertActionInitiatedBy',
          type: {
            name: 'Enum',
            module: 'RecommendedActionInitiatedBy'
          }
        },
        revert_action_initiated_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.revertActionInitiatedTime',
          type: {
            name: 'DateTime'
          }
        },
        score: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.score',
          type: {
            name: 'Number'
          }
        },
        implementation_details: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.implementationDetails',
          type: {
            name: 'Composite',
            class_name: 'RecommendedActionImplementationInfo'
          }
        },
        error_details: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.errorDetails',
          type: {
            name: 'Composite',
            class_name: 'RecommendedActionErrorInfo'
          }
        },
        estimated_impact: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.estimatedImpact',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'RecommendedActionImpactRecordElementType',
                type: {
                  name: 'Composite',
                  class_name: 'RecommendedActionImpactRecord'
                }
            }
          }
        },
        observed_impact: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.observedImpact',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'RecommendedActionImpactRecordElementType',
                type: {
                  name: 'Composite',
                  class_name: 'RecommendedActionImpactRecord'
                }
            }
          }
        },
        time_series: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.timeSeries',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'RecommendedActionMetricInfoElementType',
                type: {
                  name: 'Composite',
                  class_name: 'RecommendedActionMetricInfo'
                }
            }
          }
        },
        linked_objects: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.linkedObjects',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        details: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.details',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ObjectElementType',
                type: {
                  name: 'Object'
                }
            }
          }
        }
      }
    }
  }
end