Class: Azure::DataMigration::Mgmt::V2018_04_19::Tasks

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb

Overview

Data Migration Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Tasks

Creates and initializes a new instance of the Tasks class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ DataMigrationServiceClient (readonly)

Returns reference to the DataMigrationServiceClient.

Returns:



22
23
24
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 22

def client
  @client
end

Instance Method Details

#cancel(group_name, service_name, project_name, task_name, custom_headers: nil) ⇒ ProjectTask

Cancel a task

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. This method cancels a task if it’s currently queued or running.

will be added to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

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

    A hash of custom headers that

Returns:

  • (ProjectTask) —

    operation results.



648
649
650
651
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 648

def cancel(group_name, service_name, project_name, task_name, custom_headers:nil)
  response = cancel_async(group_name, service_name, project_name, task_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#cancel_async(group_name, service_name, project_name, task_name, custom_headers: nil) ⇒ Concurrent::Promise

Cancel a task

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. This method cancels a task if it’s currently queued or running.

to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 689

def cancel_async(group_name, service_name, project_name, task_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'group_name is nil' if group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'project_name is nil' if project_name.nil?
  fail ArgumentError, 'task_name is nil' if task_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}/cancel'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'groupName' => group_name,'serviceName' => service_name,'projectName' => project_name,'taskName' => task_name},
      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 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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::DataMigration::Mgmt::V2018_04_19::Models::ProjectTask.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

#cancel_with_http_info(group_name, service_name, project_name, task_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Cancel a task

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. This method cancels a task if it’s currently queued or running.

will be added to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



669
670
671
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 669

def cancel_with_http_info(group_name, service_name, project_name, task_name, custom_headers:nil)
  cancel_async(group_name, service_name, project_name, task_name, custom_headers:custom_headers).value!
end

#create_or_update(parameters, group_name, service_name, project_name, task_name, custom_headers: nil) ⇒ ProjectTask

Create or update task

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an exising one.

will be added to the HTTP request.

Parameters:

  • parameters (ProjectTask) —

    Information about the task

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

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

    A hash of custom headers that

Returns:

  • (ProjectTask) —

    operation results.



158
159
160
161
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 158

def create_or_update(parameters, group_name, service_name, project_name, task_name, custom_headers:nil)
  response = create_or_update_async(parameters, group_name, service_name, project_name, task_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(parameters, group_name, service_name, project_name, task_name, custom_headers: nil) ⇒ Concurrent::Promise

Create or update task

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an exising one.

to the HTTP request.

Parameters:

  • parameters (ProjectTask) —

    Information about the task

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
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
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 203

def create_or_update_async(parameters, group_name, service_name, project_name, task_name, custom_headers:nil)
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'group_name is nil' if group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'project_name is nil' if project_name.nil?
  fail ArgumentError, 'task_name is nil' if task_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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::DataMigration::Mgmt::V2018_04_19::Models::ProjectTask.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/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'groupName' => group_name,'serviceName' => service_name,'projectName' => project_name,'taskName' => task_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(: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 == 201
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::DataMigration::Mgmt::V2018_04_19::Models::ProjectTask.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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::DataMigration::Mgmt::V2018_04_19::Models::ProjectTask.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_or_update_with_http_info(parameters, group_name, service_name, project_name, task_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create or update task

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an exising one.

will be added to the HTTP request.

Parameters:

  • parameters (ProjectTask) —

    Information about the task

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



181
182
183
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 181

def create_or_update_with_http_info(parameters, group_name, service_name, project_name, task_name, custom_headers:nil)
  create_or_update_async(parameters, group_name, service_name, project_name, task_name, custom_headers:custom_headers).value!
end

#delete(group_name, service_name, project_name, task_name, delete_running_tasks: nil, custom_headers: nil) ⇒ Object

Delete task

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The DELETE method deletes a task, canceling it first if it’s running.

running tasks will be added to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

  • delete_running_tasks (Boolean) (defaults to: nil) —

    Delete the resource even if it contains

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

    A hash of custom headers that



412
413
414
415
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 412

def delete(group_name, service_name, project_name, task_name, delete_running_tasks:nil, custom_headers:nil)
  response = delete_async(group_name, service_name, project_name, task_name, delete_running_tasks:delete_running_tasks, custom_headers:custom_headers).value!
  nil
end

#delete_async(group_name, service_name, project_name, task_name, delete_running_tasks: nil, custom_headers: nil) ⇒ Concurrent::Promise

Delete task

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The DELETE method deletes a task, canceling it first if it’s running.

running tasks to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

  • delete_running_tasks (Boolean) (defaults to: nil) —

    Delete the resource even if it contains

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 457

def delete_async(group_name, service_name, project_name, task_name, delete_running_tasks:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'group_name is nil' if group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'project_name is nil' if project_name.nil?
  fail ArgumentError, 'task_name is nil' if task_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'groupName' => group_name,'serviceName' => service_name,'projectName' => project_name,'taskName' => task_name},
      query_params: {'deleteRunningTasks' => delete_running_tasks,'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 == 204
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#delete_with_http_info(group_name, service_name, project_name, task_name, delete_running_tasks: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete task

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The DELETE method deletes a task, canceling it first if it’s running.

running tasks will be added to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

  • delete_running_tasks (Boolean) (defaults to: nil) —

    Delete the resource even if it contains

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



435
436
437
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 435

def delete_with_http_info(group_name, service_name, project_name, task_name, delete_running_tasks:nil, custom_headers:nil)
  delete_async(group_name, service_name, project_name, task_name, delete_running_tasks:delete_running_tasks, custom_headers:custom_headers).value!
end

#get(group_name, service_name, project_name, task_name, expand: nil, custom_headers: nil) ⇒ ProjectTask

Get task information

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.

will be added to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

  • expand (String) (defaults to: nil) —

    Expand the response

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

    A hash of custom headers that

Returns:

  • (ProjectTask) —

    operation results.



295
296
297
298
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 295

def get(group_name, service_name, project_name, task_name, expand:nil, custom_headers:nil)
  response = get_async(group_name, service_name, project_name, task_name, expand:expand, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(group_name, service_name, project_name, task_name, expand: nil, custom_headers: nil) ⇒ Concurrent::Promise

Get task information

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.

to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

  • expand (String) (defaults to: nil) —

    Expand the response

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
389
390
391
392
393
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 338

def get_async(group_name, service_name, project_name, task_name, expand:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'group_name is nil' if group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'project_name is nil' if project_name.nil?
  fail ArgumentError, 'task_name is nil' if task_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'groupName' => group_name,'serviceName' => service_name,'projectName' => project_name,'taskName' => task_name},
      query_params: {'$expand' => expand,'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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::DataMigration::Mgmt::V2018_04_19::Models::ProjectTask.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(group_name, service_name, project_name, task_name, expand: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get task information

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.

will be added to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

  • expand (String) (defaults to: nil) —

    Expand the response

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



317
318
319
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 317

def get_with_http_info(group_name, service_name, project_name, task_name, expand:nil, custom_headers:nil)
  get_async(group_name, service_name, project_name, task_name, expand:expand, custom_headers:custom_headers).value!
end

#list(group_name, service_name, project_name, task_type: nil, custom_headers: nil) ⇒ Array<ProjectTask>

Get tasks in a service

The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

will be added to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_type (String) (defaults to: nil) —

    Filter tasks by task type

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

    A hash of custom headers that

Returns:

  • (Array<ProjectTask>) —

    operation results.



41
42
43
44
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 41

def list(group_name, service_name, project_name, task_type:nil, custom_headers:nil)
  first_page = list_as_lazy(group_name, service_name, project_name, task_type:task_type, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(group_name, service_name, project_name, task_type: nil, custom_headers: nil) ⇒ TaskList

Get tasks in a service

The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

will be added to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_type (String) (defaults to: nil) —

    Filter tasks by task type

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

    A hash of custom headers that

Returns:

  • (TaskList) —

    which provide lazy access to pages of the response.



868
869
870
871
872
873
874
875
876
877
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 868

def list_as_lazy(group_name, service_name, project_name, task_type:nil, custom_headers:nil)
  response = list_async(group_name, service_name, project_name, task_type:task_type, custom_headers: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:custom_headers)
    end
    page
  end
end

#list_async(group_name, service_name, project_name, task_type: nil, custom_headers: nil) ⇒ Concurrent::Promise

Get tasks in a service

The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_type (String) (defaults to: nil) —

    Filter tasks by task type

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
132
133
134
135
136
137
138
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 84

def list_async(group_name, service_name, project_name, task_type:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'group_name is nil' if group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'project_name is nil' if project_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'groupName' => group_name,'serviceName' => service_name,'projectName' => project_name},
      query_params: {'api-version' => @client.api_version,'taskType' => task_type},
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::DataMigration::Mgmt::V2018_04_19::Models::TaskList.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) ⇒ TaskList

Get tasks in a service

The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

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:

  • (TaskList) —

    operation results.



761
762
763
764
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 761

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

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

Get tasks in a service

The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

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.



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
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
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 800

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


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

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail 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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::DataMigration::Mgmt::V2018_04_19::Models::TaskList.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 tasks in a service

The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

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.



781
782
783
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 781

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

#list_with_http_info(group_name, service_name, project_name, task_type: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get tasks in a service

The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

will be added to the HTTP request.

Parameters:

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_type (String) (defaults to: nil) —

    Filter tasks by task type

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



63
64
65
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 63

def list_with_http_info(group_name, service_name, project_name, task_type:nil, custom_headers:nil)
  list_async(group_name, service_name, project_name, task_type:task_type, custom_headers:custom_headers).value!
end

#update(parameters, group_name, service_name, project_name, task_name, custom_headers: nil) ⇒ ProjectTask

Create or update task

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PATCH method updates an existing task, but since tasks have no mutable custom properties, there is little reason to do so.

will be added to the HTTP request.

Parameters:

  • parameters (ProjectTask) —

    Information about the task

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

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

    A hash of custom headers that

Returns:

  • (ProjectTask) —

    operation results.



522
523
524
525
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 522

def update(parameters, group_name, service_name, project_name, task_name, custom_headers:nil)
  response = update_async(parameters, group_name, service_name, project_name, task_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(parameters, group_name, service_name, project_name, task_name, custom_headers: nil) ⇒ Concurrent::Promise

Create or update task

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PATCH method updates an existing task, but since tasks have no mutable custom properties, there is little reason to do so.

to the HTTP request.

Parameters:

  • parameters (ProjectTask) —

    Information about the task

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 567

def update_async(parameters, group_name, service_name, project_name, task_name, custom_headers:nil)
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'group_name is nil' if group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'project_name is nil' if project_name.nil?
  fail ArgumentError, 'task_name is nil' if task_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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::DataMigration::Mgmt::V2018_04_19::Models::ProjectTask.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/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'groupName' => group_name,'serviceName' => service_name,'projectName' => project_name,'taskName' => task_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(:patch, 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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::DataMigration::Mgmt::V2018_04_19::Models::ProjectTask.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

#update_with_http_info(parameters, group_name, service_name, project_name, task_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create or update task

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PATCH method updates an existing task, but since tasks have no mutable custom properties, there is little reason to do so.

will be added to the HTTP request.

Parameters:

  • parameters (ProjectTask) —

    Information about the task

  • group_name (String) —

    Name of the resource group

  • service_name (String) —

    Name of the service

  • project_name (String) —

    Name of the project

  • task_name (String) —

    Name of the Task

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



545
546
547
 
# File 'lib/2018-04-19/generated/azure_mgmt_data_migration/tasks.rb', line 545

def update_with_http_info(parameters, group_name, service_name, project_name, task_name, custom_headers:nil)
  update_async(parameters, group_name, service_name, project_name, task_name, custom_headers:custom_headers).value!
end