Class: Azure::CustomerInsights::Mgmt::V2017_01_01::Images

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

Creates and initializes a new instance of the Images class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#get_upload_url_for_data(resource_group_name, hub_name, parameters, custom_headers: nil) ⇒ ImageDefinition

Gets data image upload URL.

GetUploadUrlForData 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.

  • parameters (GetImageUploadUrlInput) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (ImageDefinition) —

    operation results.



145
146
147
148
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/images.rb', line 145

def get_upload_url_for_data(resource_group_name, hub_name, parameters, custom_headers:nil)
  response = get_upload_url_for_data_async(resource_group_name, hub_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Gets data image upload URL.

GetUploadUrlForData operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • parameters (GetImageUploadUrlInput) —

    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.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/images.rb', line 178

def get_upload_url_for_data_async(resource_group_name, hub_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, '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::GetImageUploadUrlInput.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}/images/getDataImageUploadUrl'

  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},
      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?
    # 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::ImageDefinition.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_upload_url_for_data_with_http_info(resource_group_name, hub_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets data image upload URL.

GetUploadUrlForData 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.

  • parameters (GetImageUploadUrlInput) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



162
163
164
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/images.rb', line 162

def get_upload_url_for_data_with_http_info(resource_group_name, hub_name, parameters, custom_headers:nil)
  get_upload_url_for_data_async(resource_group_name, hub_name, parameters, custom_headers:custom_headers).value!
end

#get_upload_url_for_entity_type(resource_group_name, hub_name, parameters, custom_headers: nil) ⇒ ImageDefinition

Gets entity type (profile or interaction) image upload URL.

GetUploadUrlForEntityType 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.

  • parameters (GetImageUploadUrlInput) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (ImageDefinition) —

    operation results.



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

def get_upload_url_for_entity_type(resource_group_name, hub_name, parameters, custom_headers:nil)
  response = get_upload_url_for_entity_type_async(resource_group_name, hub_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Gets entity type (profile or interaction) image upload URL.

GetUploadUrlForEntityType operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • parameters (GetImageUploadUrlInput) —

    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.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/images.rb', line 72

def get_upload_url_for_entity_type_async(resource_group_name, hub_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, '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::GetImageUploadUrlInput.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}/images/getEntityTypeImageUploadUrl'

  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},
      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?
    # 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::ImageDefinition.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_upload_url_for_entity_type_with_http_info(resource_group_name, hub_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets entity type (profile or interaction) image upload URL.

GetUploadUrlForEntityType 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.

  • parameters (GetImageUploadUrlInput) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



56
57
58
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/images.rb', line 56

def get_upload_url_for_entity_type_with_http_info(resource_group_name, hub_name, parameters, custom_headers:nil)
  get_upload_url_for_entity_type_async(resource_group_name, hub_name, parameters, custom_headers:custom_headers).value!
end