Class: Azure::ARM::Search::SearchManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/generated/azure_mgmt_search/search_management_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, base_url = nil, options = nil) ⇒ SearchManagementClient

Creates initializes a new instance of the SearchManagementClient class.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 55

def initialize(credentials, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

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

  @admin_keys = AdminKeys.new(self)
  @query_keys = QueryKeys.new(self)
  @services = Services.new(self)
  @api_version = '2015-08-19'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String 



30
31
32
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 30

def accept_language
  @accept_language
end

#admin_keys ⇒ AdminKeys (readonly) 



41
42
43
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 41

def admin_keys
  @admin_keys
end

#api_version ⇒ String (readonly)

version is 2015-08-19.



27
28
29
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 27

def api_version
  @api_version
end

#base_url ⇒ String 



15
16
17
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ Object (readonly) 



18
19
20
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 18

def credentials
  @credentials
end

#generate_client_request_id ⇒ Boolean

is generated and included in each request. Default is true.



38
39
40
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 38

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Running Operations. Default value is 30.



34
35
36
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 34

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#query_keys ⇒ QueryKeys (readonly) 



44
45
46
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 44

def query_keys
  @query_keys
end

#services ⇒ Services (readonly) 



47
48
49
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 47

def services
  @services
end

#subscription_id ⇒ String

subscription. You can obtain this value from the Azure Resource Manager API or the portal.



23
24
25
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 23

def subscription_id
  @subscription_id
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)



89
90
91
92
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 89

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.



114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 114

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

  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.



101
102
103
104
105
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 101

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