Class: Azure::CognitiveServices::CustomSearch::V1_0::CustomSearchClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, options = nil) ⇒ CustomSearchClient

Creates initializes a new instance of the CustomSearchClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb', line 49

def initialize(credentials = nil, options = nil)
  super(credentials, options)
  @base_url = '{Endpoint}/bingcustomsearch/v7.0'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @custom_instance = CustomInstance.new(self)
  @endpoint = 'https://api.cognitive.microsoft.com'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



30
31
32
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb', line 30

def accept_language
  @accept_language
end

#base_url ⇒ String (readonly)

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ Object

subscription.

Returns:

  • Subscription credentials which uniquely identify client



27
28
29
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb', line 27

def credentials
  @credentials
end

#credentials1 ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb', line 18

def credentials1
  @credentials1
end

#custom_instance ⇒ CustomInstance (readonly)

Returns custom_instance.

Returns:



42
43
44
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb', line 42

def custom_instance
  @custom_instance
end

#endpoint ⇒ String

hostname, for example: “westus.api.cognitive.microsoft.com”, “api.cognitive.microsoft.com”).

Returns:

  • (String) —

    Supported Cognitive Services endpoints (protocol and



23
24
25
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb', line 23

def endpoint
  @endpoint
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



39
40
41
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb', line 39

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



34
35
36
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb', line 34

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

Instance Method Details

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



80
81
82
83
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb', line 80

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb', line 105

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



92
93
94
95
96
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb', line 92

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end