Class: Azure::ARM::CustomerInsights::Predictions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_customer_insights/predictions.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) ⇒ Predictions

Creates and initializes a new instance of the Predictions class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.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/generated/azure_mgmt_customer_insights/predictions.rb', line 25

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, hub_name, prediction_name, parameters, custom_headers = nil) ⇒ PredictionResourceFormat

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

create/update Prediction 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.

  • prediction_name (String) —

    The name of the Prediction.

  • parameters (PredictionResourceFormat) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (PredictionResourceFormat) —

    operation results.



604
605
606
607
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 604

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

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

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

create/update Prediction operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • prediction_name (String) —

    The name of the Prediction.

  • parameters (PredictionResourceFormat) —

    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.



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
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 639

def begin_create_or_update_async(resource_group_name, hub_name, prediction_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, 'prediction_name is nil' if prediction_name.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 = {}

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

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

  # Serialize Request
  request_mapper = Azure::ARM::CustomerInsights::Models::PredictionResourceFormat.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}/predictions/{predictionName}'

  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,'predictionName' => prediction_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::ARM::CustomerInsights::Models::PredictionResourceFormat.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, prediction_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

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

create/update Prediction 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.

  • prediction_name (String) —

    The name of the Prediction.

  • parameters (PredictionResourceFormat) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



622
623
624
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 622

def begin_create_or_update_with_http_info(resource_group_name, hub_name, prediction_name, parameters, custom_headers = nil)
  begin_create_or_update_async(resource_group_name, hub_name, prediction_name, parameters, custom_headers).value!
end

#begin_delete(resource_group_name, hub_name, prediction_name, custom_headers = nil) ⇒ Object

Deletes a Prediction 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.

  • prediction_name (String) —

    The name of the Prediction.

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

    A hash of custom headers that



712
713
714
715
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 712

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

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

Deletes a Prediction 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.

  • prediction_name (String) —

    The name of the Prediction.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 743

def begin_delete_async(resource_group_name, hub_name, prediction_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, 'prediction_name is nil' if prediction_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 = {}

  # 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}/predictions/{predictionName}'

  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,'predictionName' => prediction_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, prediction_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a Prediction 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.

  • prediction_name (String) —

    The name of the Prediction.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



728
729
730
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 728

def begin_delete_with_http_info(resource_group_name, hub_name, prediction_name, custom_headers = nil)
  begin_delete_async(resource_group_name, hub_name, prediction_name, custom_headers).value!
end

#create_or_update(resource_group_name, hub_name, prediction_name, parameters, custom_headers = nil) ⇒ PredictionResourceFormat

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

create/update Prediction 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.

  • prediction_name (String) —

    The name of the Prediction.

  • parameters (PredictionResourceFormat) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (PredictionResourceFormat) —

    operation results.



40
41
42
43
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 40

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

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

create/update Prediction 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.

  • prediction_name (String) —

    The name of the Prediction.

  • parameters (PredictionResourceFormat) —

    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/generated/azure_mgmt_customer_insights/predictions.rb', line 57

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

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::ARM::CustomerInsights::Models::PredictionResourceFormat.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, prediction_name, custom_headers = nil) ⇒ Object

Deletes a Prediction 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.

  • prediction_name (String) —

    The name of the Prediction.

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

    A hash of custom headers that



179
180
181
182
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 179

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

#delete_async(resource_group_name, hub_name, prediction_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.

  • prediction_name (String) —

    The name of the Prediction.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 194

def delete_async(resource_group_name, hub_name, prediction_name, custom_headers = nil)
  # Send request
  promise = begin_delete_async(resource_group_name, hub_name, prediction_name, 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, prediction_name, custom_headers = nil) ⇒ PredictionResourceFormat

Gets a Prediction 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.

  • prediction_name (String) —

    The name of the Prediction.

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

    A hash of custom headers that

Returns:

  • (PredictionResourceFormat) —

    operation results.



86
87
88
89
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 86

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

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

Gets a Prediction 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.

  • prediction_name (String) —

    The name of the Prediction.

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

def get_async(resource_group_name, hub_name, prediction_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, 'prediction_name is nil' if prediction_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 = {}

  # 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}/predictions/{predictionName}'

  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,'predictionName' => prediction_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::ARM::CustomerInsights::Models::PredictionResourceFormat.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_model_status(resource_group_name, hub_name, prediction_name, custom_headers = nil) ⇒ PredictionModelStatus

Gets model status of the prediction.

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.

  • prediction_name (String) —

    The name of the Prediction.

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

    A hash of custom headers that

Returns:

  • (PredictionModelStatus) —

    operation results.



316
317
318
319
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 316

def get_model_status(resource_group_name, hub_name, prediction_name, custom_headers = nil)
  response = get_model_status_async(resource_group_name, hub_name, prediction_name, custom_headers).value!
  response.body unless response.nil?
end

#get_model_status_async(resource_group_name, hub_name, prediction_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets model status of the prediction.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • prediction_name (String) —

    The name of the Prediction.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 347

def get_model_status_async(resource_group_name, hub_name, prediction_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, 'prediction_name is nil' if prediction_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 = {}

  # 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}/predictions/{predictionName}/getModelStatus'

  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,'predictionName' => prediction_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 == 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::ARM::CustomerInsights::Models::PredictionModelStatus.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_model_status_with_http_info(resource_group_name, hub_name, prediction_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets model status of the prediction.

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.

  • prediction_name (String) —

    The name of the Prediction.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



332
333
334
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 332

def get_model_status_with_http_info(resource_group_name, hub_name, prediction_name, custom_headers = nil)
  get_model_status_async(resource_group_name, hub_name, prediction_name, custom_headers).value!
end

#get_training_results(resource_group_name, hub_name, prediction_name, custom_headers = nil) ⇒ PredictionTrainingResults

Gets training results.

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.

  • prediction_name (String) —

    The name of the Prediction.

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

    A hash of custom headers that

Returns:

  • (PredictionTrainingResults) —

    operation results.



221
222
223
224
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 221

def get_training_results(resource_group_name, hub_name, prediction_name, custom_headers = nil)
  response = get_training_results_async(resource_group_name, hub_name, prediction_name, custom_headers).value!
  response.body unless response.nil?
end

#get_training_results_async(resource_group_name, hub_name, prediction_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets training results.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • prediction_name (String) —

    The name of the Prediction.

  • 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
295
296
297
298
299
300
301
302
303
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 252

def get_training_results_async(resource_group_name, hub_name, prediction_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, 'prediction_name is nil' if prediction_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 = {}

  # 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}/predictions/{predictionName}/getTrainingResults'

  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,'predictionName' => prediction_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 == 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::ARM::CustomerInsights::Models::PredictionTrainingResults.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_training_results_with_http_info(resource_group_name, hub_name, prediction_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets training results.

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.

  • prediction_name (String) —

    The name of the Prediction.

  • 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/generated/azure_mgmt_customer_insights/predictions.rb', line 237

def get_training_results_with_http_info(resource_group_name, hub_name, prediction_name, custom_headers = nil)
  get_training_results_async(resource_group_name, hub_name, prediction_name, custom_headers).value!
end

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

Gets a Prediction 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.

  • prediction_name (String) —

    The name of the Prediction.

  • 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/generated/azure_mgmt_customer_insights/predictions.rb', line 102

def get_with_http_info(resource_group_name, hub_name, prediction_name, custom_headers = nil)
  get_async(resource_group_name, hub_name, prediction_name, custom_headers).value!
end

#list_by_hub(resource_group_name, hub_name, custom_headers = nil) ⇒ Array<PredictionResourceFormat>

Gets all the predictions 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<PredictionResourceFormat>) —

    operation results.



510
511
512
513
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 510

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)
  first_page.get_all_items
end

#list_by_hub_as_lazy(resource_group_name, hub_name, custom_headers = nil) ⇒ PredictionListResult

Gets all the predictions in the specified hub.

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.

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

    A hash of custom headers that

Returns:

  • (PredictionListResult) —

    which provide lazy access to pages of the



884
885
886
887
888
889
890
891
892
893
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 884

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

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

Gets all the predictions 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.



539
540
541
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
585
586
587
588
589
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 539

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 = {}

  # 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}/predictions'

  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::ARM::CustomerInsights::Models::PredictionListResult.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) ⇒ PredictionListResult

Gets all the predictions 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:

  • (PredictionListResult) —

    operation results.



796
797
798
799
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 796

def list_by_hub_next(next_page_link, custom_headers = nil)
  response = list_by_hub_next_async(next_page_link, 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 predictions 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.



825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 825

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 = {}

  # 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::ARM::CustomerInsights::Models::PredictionListResult.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 predictions 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.



811
812
813
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 811

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

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

Gets all the predictions 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.



525
526
527
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 525

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).value!
end

#model_status(resource_group_name, hub_name, prediction_name, parameters, custom_headers = nil) ⇒ Object

Creates or updates the model status of prediction.

create/update prediction model status 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.

  • prediction_name (String) —

    The name of the Prediction.

  • parameters (PredictionModelStatus) —

    Parameters supplied to the

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

    A hash of custom headers that



412
413
414
415
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 412

def model_status(resource_group_name, hub_name, prediction_name, parameters, custom_headers = nil)
  response = model_status_async(resource_group_name, hub_name, prediction_name, parameters, custom_headers).value!
  nil
end

#model_status_async(resource_group_name, hub_name, prediction_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Creates or updates the model status of prediction.

create/update prediction model status operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • prediction_name (String) —

    The name of the Prediction.

  • parameters (PredictionModelStatus) —

    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.



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
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 447

def model_status_async(resource_group_name, hub_name, prediction_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, 'prediction_name is nil' if prediction_name.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 = {}

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

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

  # Serialize Request
  request_mapper = Azure::ARM::CustomerInsights::Models::PredictionModelStatus.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}/predictions/{predictionName}/modelStatus'

  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,'predictionName' => prediction_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(: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 == 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?

    result
  end

  promise.execute
end

#model_status_with_http_info(resource_group_name, hub_name, prediction_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates the model status of prediction.

create/update prediction model status 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.

  • prediction_name (String) —

    The name of the Prediction.

  • parameters (PredictionModelStatus) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



430
431
432
 
# File 'lib/generated/azure_mgmt_customer_insights/predictions.rb', line 430

def model_status_with_http_info(resource_group_name, hub_name, prediction_name, parameters, custom_headers = nil)
  model_status_async(resource_group_name, hub_name, prediction_name, parameters, custom_headers).value!
end