class Azure::CognitiveServices::Qnamaker::V4_0::EndpointSettings

An API for QnAMaker Service

Attributes

client[R]

@return [QnamakerClient] reference to the QnamakerClient

Private Class Methods

new(client) click to toggle source

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

# File lib/4.0/generated/azure_cognitiveservices_qnamaker/endpoint_settings.rb, line 17
def initialize(client)
  @client = client
end

Private Instance Methods

get_settings(custom_headers:nil) click to toggle source

Gets endpoint settings for an endpoint.

@param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [EndpointSettingsDTO] operation results.

# File lib/4.0/generated/azure_cognitiveservices_qnamaker/endpoint_settings.rb, line 32
def get_settings(custom_headers:nil)
  response = get_settings_async(custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_settings_async(custom_headers:nil) click to toggle source

Gets endpoint settings for an endpoint.

@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/4.0/generated/azure_cognitiveservices_qnamaker/endpoint_settings.rb, line 57
def get_settings_async(custom_headers:nil)
  fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.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 = 'endpointSettings'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{Endpoint}', @client.endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      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::CognitiveServices::Qnamaker::V4_0::Models::EndpointSettingsDTO.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_settings_with_http_info(custom_headers:nil) click to toggle source

Gets endpoint settings for an endpoint.

@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/4.0/generated/azure_cognitiveservices_qnamaker/endpoint_settings.rb, line 45
def get_settings_with_http_info(custom_headers:nil)
  get_settings_async(custom_headers:custom_headers).value!
end
update_settings(endpoint_settings_payload, custom_headers:nil) click to toggle source

Updates endpoint settings for an endpoint.

@param endpoint_settings_payload [EndpointSettingsDTO] Post body of the request. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [String] operation results.

# File lib/4.0/generated/azure_cognitiveservices_qnamaker/endpoint_settings.rb, line 118
def update_settings(endpoint_settings_payload, custom_headers:nil)
  response = update_settings_async(endpoint_settings_payload, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
update_settings_async(endpoint_settings_payload, custom_headers:nil) click to toggle source

Updates endpoint settings for an endpoint.

@param endpoint_settings_payload [EndpointSettingsDTO] Post body of the request. @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/4.0/generated/azure_cognitiveservices_qnamaker/endpoint_settings.rb, line 147
def update_settings_async(endpoint_settings_payload, custom_headers:nil)
  fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil?
  fail ArgumentError, 'endpoint_settings_payload is nil' if endpoint_settings_payload.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::CognitiveServices::Qnamaker::V4_0::Models::EndpointSettingsDTO.mapper()
  request_content = @client.serialize(request_mapper,  endpoint_settings_payload)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'endpointSettings'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{Endpoint}', @client.endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      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 = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'String'
          }
        }
        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_settings_with_http_info(endpoint_settings_payload, custom_headers:nil) click to toggle source

Updates endpoint settings for an endpoint.

@param endpoint_settings_payload [EndpointSettingsDTO] Post body of the request. @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/4.0/generated/azure_cognitiveservices_qnamaker/endpoint_settings.rb, line 133
def update_settings_with_http_info(endpoint_settings_payload, custom_headers:nil)
  update_settings_async(endpoint_settings_payload, custom_headers:custom_headers).value!
end