Class: Azure::CustomerInsights::Mgmt::V2017_01_01::Kpi

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb

Overview

The Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Kpi

Creates and initializes a new instance of the Kpi class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ CustomerInsightsManagementClient (readonly)

Returns reference to the CustomerInsightsManagementClient.

Returns:



25
26
27
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 25

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, hub_name, kpi_name, parameters, custom_headers: nil) ⇒ KpiResourceFormat

Creates a KPI or updates an existing KPI in the hub.

create/update KPI operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • parameters (KpiResourceFormat) —

    Parameters supplied to the

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (KpiResourceFormat) —

    operation results.



401
402
403
404
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 401

def begin_create_or_update(resource_group_name, hub_name, kpi_name, parameters, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, hub_name, kpi_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, hub_name, kpi_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a KPI or updates an existing KPI in the hub.

create/update KPI operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • parameters (KpiResourceFormat) —

    Parameters supplied to the

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 436

def begin_create_or_update_async(resource_group_name, hub_name, kpi_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'hub_name is nil' if hub_name.nil?
  fail ArgumentError, 'kpi_name is nil' if kpi_name.nil?
  fail ArgumentError, "'kpi_name' should satisfy the constraint - 'MaxLength': '512'" if !kpi_name.nil? && kpi_name.length > 512
  fail ArgumentError, "'kpi_name' should satisfy the constraint - 'MinLength': '1'" if !kpi_name.nil? && kpi_name.length < 1
  fail ArgumentError, "'kpi_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z][a-zA-Z0-9_]+$'" if !kpi_name.nil? && kpi_name.match(Regexp.new('^^[a-zA-Z][a-zA-Z0-9_]+$$')).nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::KpiResourceFormat.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'kpiName' => kpi_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 || status_code == 202
      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 = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::KpiResourceFormat.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      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

#begin_create_or_update_with_http_info(resource_group_name, hub_name, kpi_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a KPI or updates an existing KPI in the hub.

create/update KPI operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • parameters (KpiResourceFormat) —

    Parameters supplied to the

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



419
420
421
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 419

def begin_create_or_update_with_http_info(resource_group_name, hub_name, kpi_name, parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, hub_name, kpi_name, parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, hub_name, kpi_name, custom_headers: nil) ⇒ Object

Deletes a KPI in the hub.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that



511
512
513
514
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 511

def begin_delete(resource_group_name, hub_name, kpi_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, hub_name, kpi_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, hub_name, kpi_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a KPI in the hub.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 542

def begin_delete_async(resource_group_name, hub_name, kpi_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'hub_name is nil' if hub_name.nil?
  fail ArgumentError, 'kpi_name is nil' if kpi_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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.CustomerInsights/hubs/{hubName}/kpi/{kpiName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'kpiName' => kpi_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 || status_code == 202
      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?

    result
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, hub_name, kpi_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a KPI in the hub.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



527
528
529
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 527

def begin_delete_with_http_info(resource_group_name, hub_name, kpi_name, custom_headers:nil)
  begin_delete_async(resource_group_name, hub_name, kpi_name, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, hub_name, kpi_name, parameters, custom_headers: nil) ⇒ KpiResourceFormat

Creates a KPI or updates an existing KPI in the hub.

create/update KPI operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • parameters (KpiResourceFormat) —

    Parameters supplied to the

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (KpiResourceFormat) —

    operation results.



40
41
42
43
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 40

def create_or_update(resource_group_name, hub_name, kpi_name, parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, hub_name, kpi_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, hub_name, kpi_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

create/update KPI operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • parameters (KpiResourceFormat) —

    Parameters supplied to the

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 57

def create_or_update_async(resource_group_name, hub_name, kpi_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, hub_name, kpi_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::KpiResourceFormat.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(resource_group_name, hub_name, kpi_name, custom_headers: nil) ⇒ Object

Deletes a KPI in the hub.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that



180
181
182
183
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 180

def delete(resource_group_name, hub_name, kpi_name, custom_headers:nil)
  response = delete_async(resource_group_name, hub_name, kpi_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, hub_name, kpi_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 195

def delete_async(resource_group_name, hub_name, kpi_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, hub_name, kpi_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#get(resource_group_name, hub_name, kpi_name, custom_headers: nil) ⇒ KpiResourceFormat

Gets a KPI in the hub.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (KpiResourceFormat) —

    operation results.



86
87
88
89
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 86

def get(resource_group_name, hub_name, kpi_name, custom_headers:nil)
  response = get_async(resource_group_name, hub_name, kpi_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, hub_name, kpi_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets a KPI in the hub.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 117

def get_async(resource_group_name, hub_name, kpi_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'hub_name is nil' if hub_name.nil?
  fail ArgumentError, 'kpi_name is nil' if kpi_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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.CustomerInsights/hubs/{hubName}/kpi/{kpiName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'kpiName' => kpi_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.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 = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::KpiResourceFormat.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      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

#get_with_http_info(resource_group_name, hub_name, kpi_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a KPI in the hub.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



102
103
104
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 102

def get_with_http_info(resource_group_name, hub_name, kpi_name, custom_headers:nil)
  get_async(resource_group_name, hub_name, kpi_name, custom_headers:custom_headers).value!
end

#list_by_hub(resource_group_name, hub_name, custom_headers: nil) ⇒ Array<KpiResourceFormat>

Gets all the KPIs in the specified hub.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Array<KpiResourceFormat>) —

    operation results.



306
307
308
309
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 306

def list_by_hub(resource_group_name, hub_name, custom_headers:nil)
  first_page = list_by_hub_as_lazy(resource_group_name, hub_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_hub_as_lazy(resource_group_name, hub_name, custom_headers: nil) ⇒ KpiListResult

Gets all the KPIs in the specified hub.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (KpiListResult) —

    which provide lazy access to pages of the response.



684
685
686
687
688
689
690
691
692
693
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 684

def list_by_hub_as_lazy(resource_group_name, hub_name, custom_headers:nil)
  response = list_by_hub_async(resource_group_name, hub_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_hub_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_hub_async(resource_group_name, hub_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets all the KPIs in the specified hub.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 335

def list_by_hub_async(resource_group_name, hub_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'hub_name is nil' if hub_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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.CustomerInsights/hubs/{hubName}/kpi'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.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 = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::KpiListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      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

#list_by_hub_next(next_page_link, custom_headers: nil) ⇒ KpiListResult

Gets all the KPIs in the specified hub.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (KpiListResult) —

    operation results.



596
597
598
599
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 596

def list_by_hub_next(next_page_link, custom_headers:nil)
  response = list_by_hub_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_hub_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Gets all the KPIs in the specified hub.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 625

def list_by_hub_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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 = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::KpiListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      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

#list_by_hub_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the KPIs in the specified hub.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



611
612
613
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 611

def list_by_hub_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_hub_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_hub_with_http_info(resource_group_name, hub_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the KPIs in the specified hub.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



321
322
323
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 321

def list_by_hub_with_http_info(resource_group_name, hub_name, custom_headers:nil)
  list_by_hub_async(resource_group_name, hub_name, custom_headers:custom_headers).value!
end

#reprocess(resource_group_name, hub_name, kpi_name, custom_headers: nil) ⇒ Object

Reprocesses the Kpi values of the specified KPI.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that



221
222
223
224
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 221

def reprocess(resource_group_name, hub_name, kpi_name, custom_headers:nil)
  response = reprocess_async(resource_group_name, hub_name, kpi_name, custom_headers:custom_headers).value!
  nil
end

#reprocess_async(resource_group_name, hub_name, kpi_name, custom_headers: nil) ⇒ Concurrent::Promise

Reprocesses the Kpi values of the specified KPI.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 252

def reprocess_async(resource_group_name, hub_name, kpi_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'hub_name is nil' if hub_name.nil?
  fail ArgumentError, 'kpi_name is nil' if kpi_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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.CustomerInsights/hubs/{hubName}/kpi/{kpiName}/reprocess'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'kpiName' => kpi_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, 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 == 202
      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?

    result
  end

  promise.execute
end

#reprocess_with_http_info(resource_group_name, hub_name, kpi_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Reprocesses the Kpi values of the specified KPI.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • kpi_name (String) —

    The name of the KPI.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



237
238
239
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/kpi.rb', line 237

def reprocess_with_http_info(resource_group_name, hub_name, kpi_name, custom_headers:nil)
  reprocess_async(resource_group_name, hub_name, kpi_name, custom_headers:custom_headers).value!
end