File: recommendations.rb

package info (click to toggle)
ruby-azure-sdk 0.8.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 22,400 kB
  • ctags: 12,388
  • sloc: ruby: 168,299; sh: 6; makefile: 2
file content (521 lines) | stat: -rw-r--r-- 23,219 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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
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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
# encoding: utf-8
# Code generated by Microsoft (R) AutoRest Code Generator 1.0.0.0
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.

module Azure::ARM::Web
  #
  # Composite Swagger for WebSite Management Client
  #
  class Recommendations
    include Azure::ARM::Web::Models
    include MsRestAzure

    #
    # Creates and initializes a new instance of the Recommendations class.
    # @param client service class for accessing basic functionality.
    #
    def initialize(client)
      @client = client
    end

    # @return [WebSiteManagementClient] reference to the WebSiteManagementClient
    attr_reader :client

    #
    # Gets a list of recommendations associated with the specified subscription.
    #
    # Gets a list of recommendations associated with the specified subscription.
    #
    # @param featured [Boolean] If set, this API returns only the most critical
    # recommendation among the others. Otherwise this API returns all
    # recommendations available
    # @param filter [String] Return only channels specified in the filter. Filter
    # is specified by using OData syntax. Example: $filter=channels eq 'Api' or
    # channel eq 'Notification'
    # @param custom_headers [Hash{String => String}] A hash of custom headers that
    # will be added to the HTTP request.
    #
    # @return [Array] operation results.
    #
    def get(featured = nil, filter = nil, custom_headers = nil)
      response = get_async(featured, filter, custom_headers).value!
      response.body unless response.nil?
    end

    #
    # Gets a list of recommendations associated with the specified subscription.
    #
    # Gets a list of recommendations associated with the specified subscription.
    #
    # @param featured [Boolean] If set, this API returns only the most critical
    # recommendation among the others. Otherwise this API returns all
    # recommendations available
    # @param filter [String] Return only channels specified in the filter. Filter
    # is specified by using OData syntax. Example: $filter=channels eq 'Api' or
    # channel eq 'Notification'
    # @param custom_headers [Hash{String => String}] A hash of custom headers that
    # will be added to the HTTP request.
    #
    # @return [MsRestAzure::AzureOperationResponse] HTTP response information.
    #
    def get_with_http_info(featured = nil, filter = nil, custom_headers = nil)
      get_async(featured, filter, custom_headers).value!
    end

    #
    # Gets a list of recommendations associated with the specified subscription.
    #
    # Gets a list of recommendations associated with the specified subscription.
    #
    # @param featured [Boolean] If set, this API returns only the most critical
    # recommendation among the others. Otherwise this API returns all
    # recommendations available
    # @param filter [String] Return only channels specified in the filter. Filter
    # is specified by using OData syntax. Example: $filter=channels eq 'Api' or
    # channel eq 'Notification'
    # @param [Hash{String => String}] A hash of custom headers that will be added
    # to the HTTP request.
    #
    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
    #
    def get_async(featured = nil, filter = nil, custom_headers = nil)
      fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
      api_version = '2016-03-01'


      request_headers = {}

      # Set Headers
      request_headers['x-ms-client-request-id'] = SecureRandom.uuid
      request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
      path_template = '/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations'

      request_url = @base_url || @client.base_url

      options = {
          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
          path_params: {'subscriptionId' => @client.subscription_id},
          query_params: {'featured' => featured,'$filter' => filter,'api-version' => api_version},
          headers: request_headers.merge(custom_headers || {}),
          base_url: request_url
      }
      promise = @client.make_request_async(:get, path_template, options)

      promise = promise.then do |result|
        http_response = result.response
        status_code = http_response.status
        response_content = http_response.body
        unless status_code == 200
          error_model = JSON.load(response_content)
          fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
        end

        result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
        # Deserialize Response
        if status_code == 200
          begin
            parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
            result_mapper = {
              required: false,
              serialized_name: 'parsed_response',
              type: {
                name: 'Sequence',
                element: {
                    required: false,
                    serialized_name: 'RecommendationElementType',
                    type: {
                      name: 'Composite',
                      class_name: 'Recommendation'
                    }
                }
              }
            }
            result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
          rescue Exception => e
            fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
          end
        end

        result
      end

      promise.execute
    end

    #
    # Gets the list of past recommendations optionally specified by the time range.
    #
    # Gets the list of past recommendations optionally specified by the time range.
    #
    # @param resource_group_name [String] Resource group name
    # @param site_name [String] Site name
    # @param start_time [String] The start time of a time range to query, e.g.
    # $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq
    # '2015-01-02T00:00:00Z'
    # @param end_time [String] The end time of a time range to query, e.g.
    # $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq
    # '2015-01-02T00:00:00Z'
    # @param custom_headers [Hash{String => String}] A hash of custom headers that
    # will be added to the HTTP request.
    #
    # @return [Array] operation results.
    #
    def list_history_for_web_app(resource_group_name, site_name, start_time = nil, end_time = nil, custom_headers = nil)
      response = list_history_for_web_app_async(resource_group_name, site_name, start_time, end_time, custom_headers).value!
      response.body unless response.nil?
    end

    #
    # Gets the list of past recommendations optionally specified by the time range.
    #
    # Gets the list of past recommendations optionally specified by the time range.
    #
    # @param resource_group_name [String] Resource group name
    # @param site_name [String] Site name
    # @param start_time [String] The start time of a time range to query, e.g.
    # $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq
    # '2015-01-02T00:00:00Z'
    # @param end_time [String] The end time of a time range to query, e.g.
    # $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq
    # '2015-01-02T00:00:00Z'
    # @param custom_headers [Hash{String => String}] A hash of custom headers that
    # will be added to the HTTP request.
    #
    # @return [MsRestAzure::AzureOperationResponse] HTTP response information.
    #
    def list_history_for_web_app_with_http_info(resource_group_name, site_name, start_time = nil, end_time = nil, custom_headers = nil)
      list_history_for_web_app_async(resource_group_name, site_name, start_time, end_time, custom_headers).value!
    end

    #
    # Gets the list of past recommendations optionally specified by the time range.
    #
    # Gets the list of past recommendations optionally specified by the time range.
    #
    # @param resource_group_name [String] Resource group name
    # @param site_name [String] Site name
    # @param start_time [String] The start time of a time range to query, e.g.
    # $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq
    # '2015-01-02T00:00:00Z'
    # @param end_time [String] The end time of a time range to query, e.g.
    # $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq
    # '2015-01-02T00:00:00Z'
    # @param [Hash{String => String}] A hash of custom headers that will be added
    # to the HTTP request.
    #
    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
    #
    def list_history_for_web_app_async(resource_group_name, site_name, start_time = nil, end_time = nil, custom_headers = nil)
      fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
      fail ArgumentError, 'site_name is nil' if site_name.nil?
      fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
      api_version = '2016-03-01'


      request_headers = {}

      # Set Headers
      request_headers['x-ms-client-request-id'] = SecureRandom.uuid
      request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
      path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory'

      request_url = @base_url || @client.base_url

      options = {
          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
          path_params: {'resourceGroupName' => resource_group_name,'siteName' => site_name,'subscriptionId' => @client.subscription_id},
          query_params: {'startTime' => start_time,'endTime' => end_time,'api-version' => api_version},
          headers: request_headers.merge(custom_headers || {}),
          base_url: request_url
      }
      promise = @client.make_request_async(:get, path_template, options)

      promise = promise.then do |result|
        http_response = result.response
        status_code = http_response.status
        response_content = http_response.body
        unless status_code == 200
          error_model = JSON.load(response_content)
          fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
        end

        result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
        # Deserialize Response
        if status_code == 200
          begin
            parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
            result_mapper = {
              required: false,
              serialized_name: 'parsed_response',
              type: {
                name: 'Sequence',
                element: {
                    required: false,
                    serialized_name: 'RecommendationElementType',
                    type: {
                      name: 'Composite',
                      class_name: 'Recommendation'
                    }
                }
              }
            }
            result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
          rescue Exception => e
            fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
          end
        end

        result
      end

      promise.execute
    end

    #
    # Gets a list of recommendations associated with the specified web site.
    #
    # Gets a list of recommendations associated with the specified web site.
    #
    # @param resource_group_name [String] Resource group name
    # @param site_name [String] Site name
    # @param featured [Boolean] If set, this API returns only the most critical
    # recommendation among the others. Otherwise this API returns all
    # recommendations available
    # @param web_app_sku [String] The name of web app SKU.
    # @param num_slots [Integer] The number of site slots associated to the site
    # @param live_hours [Integer] If greater than zero, this API scans the last
    # active live site symptoms, dynamically generate on-the-fly recommendations
    # @param custom_headers [Hash{String => String}] A hash of custom headers that
    # will be added to the HTTP request.
    #
    # @return [Array] operation results.
    #
    def list_recommended_rules_for_web_app(resource_group_name, site_name, featured = nil, web_app_sku = nil, num_slots = nil, live_hours = nil, custom_headers = nil)
      response = list_recommended_rules_for_web_app_async(resource_group_name, site_name, featured, web_app_sku, num_slots, live_hours, custom_headers).value!
      response.body unless response.nil?
    end

    #
    # Gets a list of recommendations associated with the specified web site.
    #
    # Gets a list of recommendations associated with the specified web site.
    #
    # @param resource_group_name [String] Resource group name
    # @param site_name [String] Site name
    # @param featured [Boolean] If set, this API returns only the most critical
    # recommendation among the others. Otherwise this API returns all
    # recommendations available
    # @param web_app_sku [String] The name of web app SKU.
    # @param num_slots [Integer] The number of site slots associated to the site
    # @param live_hours [Integer] If greater than zero, this API scans the last
    # active live site symptoms, dynamically generate on-the-fly recommendations
    # @param custom_headers [Hash{String => String}] A hash of custom headers that
    # will be added to the HTTP request.
    #
    # @return [MsRestAzure::AzureOperationResponse] HTTP response information.
    #
    def list_recommended_rules_for_web_app_with_http_info(resource_group_name, site_name, featured = nil, web_app_sku = nil, num_slots = nil, live_hours = nil, custom_headers = nil)
      list_recommended_rules_for_web_app_async(resource_group_name, site_name, featured, web_app_sku, num_slots, live_hours, custom_headers).value!
    end

    #
    # Gets a list of recommendations associated with the specified web site.
    #
    # Gets a list of recommendations associated with the specified web site.
    #
    # @param resource_group_name [String] Resource group name
    # @param site_name [String] Site name
    # @param featured [Boolean] If set, this API returns only the most critical
    # recommendation among the others. Otherwise this API returns all
    # recommendations available
    # @param web_app_sku [String] The name of web app SKU.
    # @param num_slots [Integer] The number of site slots associated to the site
    # @param live_hours [Integer] If greater than zero, this API scans the last
    # active live site symptoms, dynamically generate on-the-fly recommendations
    # @param [Hash{String => String}] A hash of custom headers that will be added
    # to the HTTP request.
    #
    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
    #
    def list_recommended_rules_for_web_app_async(resource_group_name, site_name, featured = nil, web_app_sku = nil, num_slots = nil, live_hours = nil, custom_headers = nil)
      fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
      fail ArgumentError, 'site_name is nil' if site_name.nil?
      fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
      api_version = '2016-03-01'


      request_headers = {}

      # Set Headers
      request_headers['x-ms-client-request-id'] = SecureRandom.uuid
      request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
      path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations'

      request_url = @base_url || @client.base_url

      options = {
          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
          path_params: {'resourceGroupName' => resource_group_name,'siteName' => site_name,'subscriptionId' => @client.subscription_id},
          query_params: {'featured' => featured,'webAppSku' => web_app_sku,'numSlots' => num_slots,'liveHours' => live_hours,'api-version' => api_version},
          headers: request_headers.merge(custom_headers || {}),
          base_url: request_url
      }
      promise = @client.make_request_async(:get, path_template, options)

      promise = promise.then do |result|
        http_response = result.response
        status_code = http_response.status
        response_content = http_response.body
        unless status_code == 200
          error_model = JSON.load(response_content)
          fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
        end

        result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
        # Deserialize Response
        if status_code == 200
          begin
            parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
            result_mapper = {
              required: false,
              serialized_name: 'parsed_response',
              type: {
                name: 'Sequence',
                element: {
                    required: false,
                    serialized_name: 'RecommendationElementType',
                    type: {
                      name: 'Composite',
                      class_name: 'Recommendation'
                    }
                }
              }
            }
            result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
          rescue Exception => e
            fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
          end
        end

        result
      end

      promise.execute
    end

    #
    # Gets the detailed properties of the recommendation object for the specified
    # web site.
    #
    # Gets the detailed properties of the recommendation object for the specified
    # web site.
    #
    # @param resource_group_name [String] Resource group name
    # @param site_name [String] Name of web app
    # @param name [String] Recommendation rule name
    # @param update_seen [Boolean] If true, the backend updates the last seen
    # timestamp of the recommendation object.
    # @param custom_headers [Hash{String => String}] A hash of custom headers that
    # will be added to the HTTP request.
    #
    # @return [RecommendationRule] operation results.
    #
    def get_rule_details_by_web_app(resource_group_name, site_name, name, update_seen = nil, custom_headers = nil)
      response = get_rule_details_by_web_app_async(resource_group_name, site_name, name, update_seen, custom_headers).value!
      response.body unless response.nil?
    end

    #
    # Gets the detailed properties of the recommendation object for the specified
    # web site.
    #
    # Gets the detailed properties of the recommendation object for the specified
    # web site.
    #
    # @param resource_group_name [String] Resource group name
    # @param site_name [String] Name of web app
    # @param name [String] Recommendation rule name
    # @param update_seen [Boolean] If true, the backend updates the last seen
    # timestamp of the recommendation object.
    # @param custom_headers [Hash{String => String}] A hash of custom headers that
    # will be added to the HTTP request.
    #
    # @return [MsRestAzure::AzureOperationResponse] HTTP response information.
    #
    def get_rule_details_by_web_app_with_http_info(resource_group_name, site_name, name, update_seen = nil, custom_headers = nil)
      get_rule_details_by_web_app_async(resource_group_name, site_name, name, update_seen, custom_headers).value!
    end

    #
    # Gets the detailed properties of the recommendation object for the specified
    # web site.
    #
    # Gets the detailed properties of the recommendation object for the specified
    # web site.
    #
    # @param resource_group_name [String] Resource group name
    # @param site_name [String] Name of web app
    # @param name [String] Recommendation rule name
    # @param update_seen [Boolean] If true, the backend updates the last seen
    # timestamp of the recommendation object.
    # @param [Hash{String => String}] A hash of custom headers that will be added
    # to the HTTP request.
    #
    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
    #
    def get_rule_details_by_web_app_async(resource_group_name, site_name, name, update_seen = nil, custom_headers = nil)
      fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
      fail ArgumentError, 'site_name is nil' if site_name.nil?
      fail ArgumentError, 'name is nil' if name.nil?
      fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
      api_version = '2016-03-01'


      request_headers = {}

      # Set Headers
      request_headers['x-ms-client-request-id'] = SecureRandom.uuid
      request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
      path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}'

      request_url = @base_url || @client.base_url

      options = {
          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
          path_params: {'resourceGroupName' => resource_group_name,'siteName' => site_name,'name' => name,'subscriptionId' => @client.subscription_id},
          query_params: {'updateSeen' => update_seen,'api-version' => api_version},
          headers: request_headers.merge(custom_headers || {}),
          base_url: request_url
      }
      promise = @client.make_request_async(:get, path_template, options)

      promise = promise.then do |result|
        http_response = result.response
        status_code = http_response.status
        response_content = http_response.body
        unless status_code == 200
          error_model = JSON.load(response_content)
          fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
        end

        result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
        # Deserialize Response
        if status_code == 200
          begin
            parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
            result_mapper = RecommendationRule.mapper()
            result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
          rescue Exception => e
            fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
          end
        end

        result
      end

      promise.execute
    end

  end
end