class Azure::MobileEngagement::Mgmt::V2014_12_01::ImportTasks

Microsoft Azure Mobile Engagement REST APIs.

Attributes

client[R]

@return [EngagementManagementClient] reference to the EngagementManagementClient

Private Class Methods

new(client) click to toggle source

Creates and initializes a new instance of the ImportTasks class. @param client service class for accessing basic functionality.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb, line 17
def initialize(client)
  @client = client
end

Private Instance Methods

create(resource_group_name, app_collection, app_name, parameters, custom_headers:nil) click to toggle source

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

@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param parameters [ImportTask] @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ImportTaskResult] operation results.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb, line 186
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:custom_headers).value!
  response.body unless response.nil?
end
create_async(resource_group_name, app_collection, app_name, parameters, custom_headers:nil) click to toggle source

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

@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param parameters [ImportTask] @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb, line 219
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 = {}
  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::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) click to toggle source

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

@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param parameters [ImportTask] @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb, line 203
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:custom_headers).value!
end
get(id, resource_group_name, app_collection, app_name, custom_headers:nil) click to toggle source

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

@param id [String] Import job identifier. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ImportTaskResult] operation results.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb, line 304
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:custom_headers).value!
  response.body unless response.nil?
end
get_async(id, resource_group_name, app_collection, app_name, custom_headers:nil) click to toggle source

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

@param id [String] Import job identifier. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb, line 339
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 = {}
  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.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) click to toggle source

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

@param id [String] Import job identifier. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb, line 322
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:custom_headers).value!
end
list(resource_group_name, app_collection, app_name, skip:0, top:20, orderby:nil, custom_headers:nil) click to toggle source

Get the list of import jobs.

@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param skip [Integer] Control paging of import jobs, start results at the given offset, defaults to 0 (1st page of data). @param top [Integer] Control paging of import jobs, number of import jobs to 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. @param orderby [String] Sort results by an expression which looks like `$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. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<ImportTaskResult>] operation results.

# 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:skip, top:top, orderby:orderby, custom_headers: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) click to toggle source

Get the list of import jobs.

@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param skip [Integer] Control paging of import jobs, start results at the given offset, defaults to 0 (1st page of data). @param top [Integer] Control paging of import jobs, number of import jobs to 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. @param orderby [String] Sort results by an expression which looks like `$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. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ImportTaskListResult] which provide lazy access to pages of the response.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb, line 511
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:skip, top:top, orderby:orderby, 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(resource_group_name, app_collection, app_name, skip:0, top:20, orderby:nil, custom_headers:nil) click to toggle source

Get the list of import jobs.

@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param skip [Integer] Control paging of import jobs, start results at the given offset, defaults to 0 (1st page of data). @param top [Integer] Control paging of import jobs, number of import jobs to 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. @param orderby [String] Sort results by an expression which looks like `$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. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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?
  fail ArgumentError, "'skip' should satisfy the constraint - 'InclusiveMinimum': '0'" if !skip.nil? && skip < 0
  fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMaximum': '40'" if !top.nil? && top > 40
  fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1


  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.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) click to toggle source

Get the list of import jobs.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ImportTaskListResult] operation results.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb, line 404
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) click to toggle source

Get the list of import jobs.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb, line 433
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?
    # 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) click to toggle source

Get the list of import jobs.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/import_tasks.rb, line 419
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(resource_group_name, app_collection, app_name, skip:0, top:20, orderby:nil, custom_headers:nil) click to toggle source

Get the list of import jobs.

@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param skip [Integer] Control paging of import jobs, start results at the given offset, defaults to 0 (1st page of data). @param top [Integer] Control paging of import jobs, number of import jobs to 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. @param orderby [String] Sort results by an expression which looks like `$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. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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:skip, top:top, orderby:orderby, custom_headers:custom_headers).value!
end