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.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) —

    credentials to authorize HTTP requests made by the service client.

  • base_url (String) (defaults to: nil) —

    the base URI of the service.

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

    filters to be applied to the HTTP requests.



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

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-02-28'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
end

Instance Attribute Details

#accept_language ⇒ String

Returns Gets or sets the preferred language for the response.

Returns:

  • (String) —

    Gets or sets the preferred language for the response.



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

def accept_language
  @accept_language
end

#admin_keys ⇒ AdminKeys (readonly)

Returns admin_keys.

Returns:



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

def admin_keys
  @admin_keys
end

#api_version ⇒ String (readonly)

Returns Client Api Version.

Returns:

  • (String) —

    Client Api Version.



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

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



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

def base_url
  @base_url
end

#credentials ⇒ Object

subscription.

Returns:

  • Subscription credentials which uniquely identify client



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.

Returns:

  • (Boolean) —

    When set to true a unique x-ms-client-request-id value



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

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Running Operations. Default value is 30.

Returns:

  • (Integer) —

    Gets or sets the retry timeout in seconds for Long



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

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#query_keys ⇒ QueryKeys (readonly)

Returns query_keys.

Returns:



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

def query_keys
  @query_keys
end

#services ⇒ Services (readonly)

Returns services.

Returns:



50
51
52
 
# File 'lib/generated/azure_mgmt_search/search_management_client.rb', line 50

def services
  @services
end

#subscription_id ⇒ String

Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Returns:

  • (String) —

    Gets subscription credentials which uniquely identify



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

def subscription_id
  @subscription_id
end