Class: Azure::MobileEngagement::Mgmt::V2014_12_01::ImportTasks

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb

Overview

Microsoft Azure Mobile Engagement REST APIs.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ImportTasks

Creates and initializes a new instance of the ImportTasks class.

Parameters:

  • client

    service class for accessing basic functionality.



17
18
19
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientEngagementManagementClient (readonly)

Returns reference to the EngagementManagementClient.

Returns:



22
23
24
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 22

def client
  @client
end

Instance Method Details

#create(resource_group_name, app_collection, app_name, parameters, custom_headers = nil) ⇒ ImportTaskResult

Creates a job to import the specified data to a storageUrl.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • app_collection (String)

    Application collection.

  • app_name (String)

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (ImportTaskResult)

    operation results.



182
183
184
185
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 182

def create(resource_group_name, app_collection, app_name, parameters, custom_headers = nil)
  response = create_async(resource_group_name, app_collection, app_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, app_collection, app_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Creates a job to import the specified data to a storageUrl.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • app_collection (String)

    Application collection.

  • app_name (String)

    Application resource name.

  • parameters (ImportTask)
  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 215

def create_async(resource_group_name, app_collection, app_name, parameters, custom_headers = nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::ImportTask.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/importTasks'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name},
      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 == 201 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::ImportTaskResult.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
    # Deserialize Response
    if status_code == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::ImportTaskResult.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

#create_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a job to import the specified data to a storageUrl.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • app_collection (String)

    Application collection.

  • app_name (String)

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



199
200
201
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 199

def create_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers = nil)
  create_async(resource_group_name, app_collection, app_name, parameters, custom_headers).value!
end

#get(id, resource_group_name, app_collection, app_name, custom_headers = nil) ⇒ ImportTaskResult

The Get import job operation retrieves information about a previously created import job.

will be added to the HTTP request.

Parameters:

  • id (String)

    Import job identifier.

  • resource_group_name (String)

    The name of the resource group.

  • app_collection (String)

    Application collection.

  • app_name (String)

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (ImportTaskResult)

    operation results.



301
302
303
304
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 301

def get(id, resource_group_name, app_collection, app_name, custom_headers = nil)
  response = get_async(id, resource_group_name, app_collection, app_name, custom_headers).value!
  response.body unless response.nil?
end

#get_async(id, resource_group_name, app_collection, app_name, custom_headers = nil) ⇒ Concurrent::Promise

The Get import job operation retrieves information about a previously created import job.

to the HTTP request.

Parameters:

  • id (String)

    Import job identifier.

  • resource_group_name (String)

    The name of the resource group.

  • app_collection (String)

    Application collection.

  • app_name (String)

    Application resource name.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 336

def get_async(id, resource_group_name, app_collection, app_name, custom_headers = nil)
  fail ArgumentError, 'id is nil' if id.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/importTasks/{id}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'id' => id,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name},
      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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::ImportTaskResult.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(id, resource_group_name, app_collection, app_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The Get import job operation retrieves information about a previously created import job.

will be added to the HTTP request.

Parameters:

  • id (String)

    Import job identifier.

  • resource_group_name (String)

    The name of the resource group.

  • app_collection (String)

    Application collection.

  • app_name (String)

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



319
320
321
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 319

def get_with_http_info(id, resource_group_name, app_collection, app_name, custom_headers = nil)
  get_async(id, resource_group_name, app_collection, app_name, custom_headers).value!
end

#list(resource_group_name, app_collection, app_name, skip = 0, top = 20, orderby = nil, custom_headers = nil) ⇒ Array<ImportTaskResult>

Get the list of import jobs.

given offset, defaults to 0 (1st page of data). return with each call. By default, it returns all import jobs with a default paging of 20. The response contains a ‘nextLink` property describing the path to get the next page if there are more results. The maximum paging limit for $top is 40. `$orderby=jobId asc` (default when not specified). The syntax is orderby=property direction or just orderby=property. Properties that can be specified for sorting: jobId, errorDetails, dateCreated, jobStatus, and dateCreated. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one orderby property can be specified. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • app_collection (String)

    Application collection.

  • app_name (String)

    Application resource name.

  • skip (Integer) (defaults to: 0)

    Control paging of import jobs, start results at the

  • top (Integer) (defaults to: 20)

    Control paging of import jobs, number of import jobs to

  • orderby (String) (defaults to: nil)

    Sort results by an expression which looks like

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

    A hash of custom headers that

Returns:

  • (Array<ImportTaskResult>)

    operation results.



52
53
54
55
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 52

def list(resource_group_name, app_collection, app_name, skip = 0, top = 20, orderby = nil, custom_headers = nil)
  first_page = list_as_lazy(resource_group_name, app_collection, app_name, skip, top, orderby, custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, app_collection, app_name, skip = 0, top = 20, orderby = nil, custom_headers = nil) ⇒ ImportTaskListResult

Get the list of import jobs.

given offset, defaults to 0 (1st page of data). return with each call. By default, it returns all import jobs with a default paging of 20. The response contains a ‘nextLink` property describing the path to get the next page if there are more results. The maximum paging limit for $top is 40. `$orderby=jobId asc` (default when not specified). The syntax is orderby=property direction or just orderby=property. Properties that can be specified for sorting: jobId, errorDetails, dateCreated, jobStatus, and dateCreated. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one orderby property can be specified. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • app_collection (String)

    Application collection.

  • app_name (String)

    Application resource name.

  • skip (Integer) (defaults to: 0)

    Control paging of import jobs, start results at the

  • top (Integer) (defaults to: 20)

    Control paging of import jobs, number of import jobs to

  • orderby (String) (defaults to: nil)

    Sort results by an expression which looks like

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

    A hash of custom headers that

Returns:

  • (ImportTaskListResult)

    which provide lazy access to pages of the



506
507
508
509
510
511
512
513
514
515
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 506

def list_as_lazy(resource_group_name, app_collection, app_name, skip = 0, top = 20, orderby = nil, custom_headers = nil)
  response = list_async(resource_group_name, app_collection, app_name, skip, top, orderby, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers)
    end
    page
  end
end

#list_async(resource_group_name, app_collection, app_name, skip = 0, top = 20, orderby = nil, custom_headers = nil) ⇒ Concurrent::Promise

Get the list of import jobs.

given offset, defaults to 0 (1st page of data). return with each call. By default, it returns all import jobs with a default paging of 20. The response contains a ‘nextLink` property describing the path to get the next page if there are more results. The maximum paging limit for $top is 40. `$orderby=jobId asc` (default when not specified). The syntax is orderby=property direction or just orderby=property. Properties that can be specified for sorting: jobId, errorDetails, dateCreated, jobStatus, and dateCreated. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one orderby property can be specified. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • app_collection (String)

    Application collection.

  • app_name (String)

    Application resource name.

  • skip (Integer) (defaults to: 0)

    Control paging of import jobs, start results at the

  • top (Integer) (defaults to: 20)

    Control paging of import jobs, number of import jobs to

  • orderby (String) (defaults to: nil)

    Sort results by an expression which looks like

  • 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/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 117

def list_async(resource_group_name, app_collection, app_name, skip = 0, top = 20, orderby = nil, custom_headers = nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/importTasks'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name},
      query_params: {'api-version' => @client.api_version,'$skip' => skip,'$top' => top,'$orderby' => orderby},
      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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::ImportTaskListResult.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_next(next_page_link, custom_headers = nil) ⇒ ImportTaskListResult

Get the list of import jobs.

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:

  • (ImportTaskListResult)

    operation results.



400
401
402
403
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 400

def list_next(next_page_link, custom_headers = nil)
  response = list_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Get the list of import jobs.

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.



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 429

def list_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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::ImportTaskListResult.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_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Get the list of import jobs.

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.



415
416
417
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 415

def list_next_with_http_info(next_page_link, custom_headers = nil)
  list_next_async(next_page_link, custom_headers).value!
end

#list_with_http_info(resource_group_name, app_collection, app_name, skip = 0, top = 20, orderby = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Get the list of import jobs.

given offset, defaults to 0 (1st page of data). return with each call. By default, it returns all import jobs with a default paging of 20. The response contains a ‘nextLink` property describing the path to get the next page if there are more results. The maximum paging limit for $top is 40. `$orderby=jobId asc` (default when not specified). The syntax is orderby=property direction or just orderby=property. Properties that can be specified for sorting: jobId, errorDetails, dateCreated, jobStatus, and dateCreated. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one orderby property can be specified. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • app_collection (String)

    Application collection.

  • app_name (String)

    Application resource name.

  • skip (Integer) (defaults to: 0)

    Control paging of import jobs, start results at the

  • top (Integer) (defaults to: 20)

    Control paging of import jobs, number of import jobs to

  • orderby (String) (defaults to: nil)

    Sort results by an expression which looks like

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



85
86
87
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb', line 85

def list_with_http_info(resource_group_name, app_collection, app_name, skip = 0, top = 20, orderby = nil, custom_headers = nil)
  list_async(resource_group_name, app_collection, app_name, skip, top, orderby, custom_headers).value!
end