Class: Azure::CustomerInsights::Mgmt::V2017_04_26::Views
- Inherits:
-
Object
- Object
- Azure::CustomerInsights::Mgmt::V2017_04_26::Views
- Includes:
- MsRestAzure
- Defined in:
- lib/2017-04-26/generated/azure_mgmt_customer_insights/views.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
-
#client ⇒ CustomerInsightsManagementClient
readonly
Reference to the CustomerInsightsManagementClient.
Instance Method Summary collapse
-
#create_or_update(resource_group_name, hub_name, view_name, parameters, custom_headers: nil) ⇒ ViewResourceFormat
Creates a view or updates an exisiting view in the hub.
-
#create_or_update_async(resource_group_name, hub_name, view_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Creates a view or updates an exisiting view in the hub.
-
#create_or_update_with_http_info(resource_group_name, hub_name, view_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates a view or updates an exisiting view in the hub.
-
#delete(resource_group_name, hub_name, view_name, user_id, custom_headers: nil) ⇒ Object
Deletes a view in the specified hub.
-
#delete_async(resource_group_name, hub_name, view_name, user_id, custom_headers: nil) ⇒ Concurrent::Promise
Deletes a view in the specified hub.
-
#delete_with_http_info(resource_group_name, hub_name, view_name, user_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes a view in the specified hub.
-
#get(resource_group_name, hub_name, view_name, user_id, custom_headers: nil) ⇒ ViewResourceFormat
Gets a view in the hub.
-
#get_async(resource_group_name, hub_name, view_name, user_id, custom_headers: nil) ⇒ Concurrent::Promise
Gets a view in the hub.
-
#get_with_http_info(resource_group_name, hub_name, view_name, user_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets a view in the hub.
-
#initialize(client) ⇒ Views
constructor
Creates and initializes a new instance of the Views class.
-
#list_by_hub(resource_group_name, hub_name, user_id, custom_headers: nil) ⇒ Array<ViewResourceFormat>
Gets all available views for given user in the specified hub.
-
#list_by_hub_as_lazy(resource_group_name, hub_name, user_id, custom_headers: nil) ⇒ ViewListResult
Gets all available views for given user in the specified hub.
-
#list_by_hub_async(resource_group_name, hub_name, user_id, custom_headers: nil) ⇒ Concurrent::Promise
Gets all available views for given user in the specified hub.
-
#list_by_hub_next(next_page_link, custom_headers: nil) ⇒ ViewListResult
Gets all available views for given user in the specified hub.
-
#list_by_hub_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Gets all available views for given user in the specified hub.
-
#list_by_hub_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets all available views for given user in the specified hub.
-
#list_by_hub_with_http_info(resource_group_name, hub_name, user_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets all available views for given user in the specified hub.
Constructor Details
#initialize(client) ⇒ Views
Creates and initializes a new instance of the Views class.
20 21 22 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 20 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ CustomerInsightsManagementClient (readonly)
Returns reference to the CustomerInsightsManagementClient.
25 26 27 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 25 def client @client end |
Instance Method Details
#create_or_update(resource_group_name, hub_name, view_name, parameters, custom_headers: nil) ⇒ ViewResourceFormat
Creates a view or updates an exisiting view in the hub.
CreateOrUpdate View operation. will be added to the HTTP request.
136 137 138 139 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 136 def create_or_update(resource_group_name, hub_name, view_name, parameters, custom_headers:nil) response = create_or_update_async(resource_group_name, hub_name, view_name, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end |
#create_or_update_async(resource_group_name, hub_name, view_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Creates a view or updates an exisiting view in the hub.
CreateOrUpdate View operation. to the HTTP request.
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 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 171 def create_or_update_async(resource_group_name, hub_name, view_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, 'view_name is nil' if view_name.nil? fail ArgumentError, "'view_name' should satisfy the constraint - 'MaxLength': '512'" if !view_name.nil? && view_name.length > 512 fail ArgumentError, "'view_name' should satisfy the constraint - 'MinLength': '1'" if !view_name.nil? && view_name.length < 1 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_04_26::Models::ViewResourceFormat.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}/views/{viewName}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'viewName' => view_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, ) 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_04_26::Models::ViewResourceFormat.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#create_or_update_with_http_info(resource_group_name, hub_name, view_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates a view or updates an exisiting view in the hub.
CreateOrUpdate View operation. will be added to the HTTP request.
154 155 156 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 154 def create_or_update_with_http_info(resource_group_name, hub_name, view_name, parameters, custom_headers:nil) create_or_update_async(resource_group_name, hub_name, view_name, parameters, custom_headers:custom_headers).value! end |
#delete(resource_group_name, hub_name, view_name, user_id, custom_headers: nil) ⇒ Object
Deletes a view in the specified hub.
will be added to the HTTP request.
346 347 348 349 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 346 def delete(resource_group_name, hub_name, view_name, user_id, custom_headers:nil) response = delete_async(resource_group_name, hub_name, view_name, user_id, custom_headers:custom_headers).value! nil end |
#delete_async(resource_group_name, hub_name, view_name, user_id, custom_headers: nil) ⇒ Concurrent::Promise
Deletes a view in the specified hub.
to the HTTP request.
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 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 379 def delete_async(resource_group_name, hub_name, view_name, user_id, 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, 'view_name is nil' if view_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? fail ArgumentError, 'user_id is nil' if user_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}/views/{viewName}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'viewName' => view_name,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version,'userId' => user_id}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:delete, path_template, ) 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 |
#delete_with_http_info(resource_group_name, hub_name, view_name, user_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes a view in the specified hub.
will be added to the HTTP request.
363 364 365 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 363 def delete_with_http_info(resource_group_name, hub_name, view_name, user_id, custom_headers:nil) delete_async(resource_group_name, hub_name, view_name, user_id, custom_headers:custom_headers).value! end |
#get(resource_group_name, hub_name, view_name, user_id, custom_headers: nil) ⇒ ViewResourceFormat
Gets a view in the hub.
will be added to the HTTP request.
247 248 249 250 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 247 def get(resource_group_name, hub_name, view_name, user_id, custom_headers:nil) response = get_async(resource_group_name, hub_name, view_name, user_id, custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_async(resource_group_name, hub_name, view_name, user_id, custom_headers: nil) ⇒ Concurrent::Promise
Gets a view in the hub.
to the HTTP request.
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 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 280 def get_async(resource_group_name, hub_name, view_name, user_id, 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, 'view_name is nil' if view_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? fail ArgumentError, 'user_id is nil' if user_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}/views/{viewName}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'viewName' => view_name,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version,'userId' => user_id}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) 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_04_26::Models::ViewResourceFormat.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#get_with_http_info(resource_group_name, hub_name, view_name, user_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets a view in the hub.
will be added to the HTTP request.
264 265 266 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 264 def get_with_http_info(resource_group_name, hub_name, view_name, user_id, custom_headers:nil) get_async(resource_group_name, hub_name, view_name, user_id, custom_headers:custom_headers).value! end |
#list_by_hub(resource_group_name, hub_name, user_id, custom_headers: nil) ⇒ Array<ViewResourceFormat>
Gets all available views for given user in the specified hub.
will be added to the HTTP request.
38 39 40 41 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 38 def list_by_hub(resource_group_name, hub_name, user_id, custom_headers:nil) first_page = list_by_hub_as_lazy(resource_group_name, hub_name, user_id, custom_headers:custom_headers) first_page.get_all_items end |
#list_by_hub_as_lazy(resource_group_name, hub_name, user_id, custom_headers: nil) ⇒ ViewListResult
Gets all available views for given user in the specified hub.
will be added to the HTTP request.
523 524 525 526 527 528 529 530 531 532 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 523 def list_by_hub_as_lazy(resource_group_name, hub_name, user_id, custom_headers:nil) response = list_by_hub_async(resource_group_name, hub_name, user_id, 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, user_id, custom_headers: nil) ⇒ Concurrent::Promise
Gets all available views for given user in the specified hub.
to the HTTP request.
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 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 69 def list_by_hub_async(resource_group_name, hub_name, user_id, 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? fail ArgumentError, 'user_id is nil' if user_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}/views' request_url = @base_url || @client.base_url = { 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,'userId' => user_id}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) 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_04_26::Models::ViewListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_by_hub_next(next_page_link, custom_headers: nil) ⇒ ViewListResult
Gets all available views for given user in the specified hub.
to List operation. will be added to the HTTP request.
434 435 436 437 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 434 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 available views for given user in the specified hub.
to List operation. to the HTTP request.
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 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 463 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 = { 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, ) 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_04_26::Models::ViewListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., 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 available views for given user in the specified hub.
to List operation. will be added to the HTTP request.
449 450 451 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 449 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, user_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets all available views for given user in the specified hub.
will be added to the HTTP request.
54 55 56 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb', line 54 def list_by_hub_with_http_info(resource_group_name, hub_name, user_id, custom_headers:nil) list_by_hub_async(resource_group_name, hub_name, user_id, custom_headers:custom_headers).value! end |