class Azure::CustomerInsights::Mgmt::V2017_01_01::Images

The Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.

Attributes

client[R]

@return [CustomerInsightsManagementClient] reference to the CustomerInsightsManagementClient

Public Class Methods

new(client) click to toggle source

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

# File lib/2017-01-01/generated/azure_mgmt_customer_insights/images.rb, line 20
def initialize(client)
  @client = client
end

Public Instance Methods

get_upload_url_for_data(resource_group_name, hub_name, parameters, custom_headers:nil) click to toggle source

Gets data image upload URL.

@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param parameters [GetImageUploadUrlInput] Parameters supplied to the GetUploadUrlForData operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ImageDefinition] operation results.

# File lib/2017-01-01/generated/azure_mgmt_customer_insights/images.rb, line 145
def get_upload_url_for_data(resource_group_name, hub_name, parameters, custom_headers:nil)
  response = get_upload_url_for_data_async(resource_group_name, hub_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_upload_url_for_data_async(resource_group_name, hub_name, parameters, custom_headers:nil) click to toggle source

Gets data image upload URL.

@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param parameters [GetImageUploadUrlInput] Parameters supplied to the GetUploadUrlForData 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/2017-01-01/generated/azure_mgmt_customer_insights/images.rb, line 178
def get_upload_url_for_data_async(resource_group_name, hub_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'hub_name is nil' if hub_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


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

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

  # Serialize Request
  request_mapper = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::GetImageUploadUrlInput.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/images/getDataImageUploadUrl'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::ImageDefinition.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end
get_upload_url_for_data_with_http_info(resource_group_name, hub_name, parameters, custom_headers:nil) click to toggle source

Gets data image upload URL.

@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param parameters [GetImageUploadUrlInput] Parameters supplied to the GetUploadUrlForData 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/2017-01-01/generated/azure_mgmt_customer_insights/images.rb, line 162
def get_upload_url_for_data_with_http_info(resource_group_name, hub_name, parameters, custom_headers:nil)
  get_upload_url_for_data_async(resource_group_name, hub_name, parameters, custom_headers:custom_headers).value!
end
get_upload_url_for_entity_type(resource_group_name, hub_name, parameters, custom_headers:nil) click to toggle source

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

@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param parameters [GetImageUploadUrlInput] Parameters supplied to the GetUploadUrlForEntityType operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ImageDefinition] operation results.

# File lib/2017-01-01/generated/azure_mgmt_customer_insights/images.rb, line 39
def get_upload_url_for_entity_type(resource_group_name, hub_name, parameters, custom_headers:nil)
  response = get_upload_url_for_entity_type_async(resource_group_name, hub_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_upload_url_for_entity_type_async(resource_group_name, hub_name, parameters, custom_headers:nil) click to toggle source

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

@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param parameters [GetImageUploadUrlInput] Parameters supplied to the GetUploadUrlForEntityType 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/2017-01-01/generated/azure_mgmt_customer_insights/images.rb, line 72
def get_upload_url_for_entity_type_async(resource_group_name, hub_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'hub_name is nil' if hub_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


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

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

  # Serialize Request
  request_mapper = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::GetImageUploadUrlInput.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/images/getEntityTypeImageUploadUrl'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::ImageDefinition.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end
get_upload_url_for_entity_type_with_http_info(resource_group_name, hub_name, parameters, custom_headers:nil) click to toggle source

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

@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param parameters [GetImageUploadUrlInput] Parameters supplied to the GetUploadUrlForEntityType 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/2017-01-01/generated/azure_mgmt_customer_insights/images.rb, line 56
def get_upload_url_for_entity_type_with_http_info(resource_group_name, hub_name, parameters, custom_headers:nil)
  get_upload_url_for_entity_type_async(resource_group_name, hub_name, parameters, custom_headers:custom_headers).value!
end