Class: Azure::ARM::IotHub::IotHubClient
- Inherits:
-
MsRestAzure::AzureServiceClient
- Object
- MsRestAzure::AzureServiceClient
- Azure::ARM::IotHub::IotHubClient
- Includes:
- MsRestAzure, MsRestAzure::Serialization
- Defined in:
- lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb
Overview
A service client - single point of access to the REST API.
Instance Attribute Summary collapse
-
#accept_language ⇒ String
Gets or sets the preferred language for the response.
-
#api_version ⇒ String
readonly
Version of the Api.
-
#base_url ⇒ String
The base URI of the service.
-
#credentials ⇒ Object
readonly
Credentials needed for the client to connect to Azure.
-
#generate_client_request_id ⇒ Boolean
is generated and included in each request.
-
#iot_hub_resource ⇒ IotHubResource
readonly
Iot_hub_resource.
-
#long_running_operation_retry_timeout ⇒ Integer
Running Operations.
-
#subscription_id ⇒ String
The subscription identifier.
Instance Method Summary collapse
-
#initialize(credentials, base_url = nil, options = nil) ⇒ IotHubClient
constructor
Creates initializes a new instance of the IotHubClient class.
-
#make_request(method, path, options = {}) ⇒ Hash{String=>String}
Makes a request and returns the body of the response.
-
#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise
Makes a request asynchronously.
-
#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse
Makes a request and returns the operation response.
Constructor Details
#initialize(credentials, base_url = nil, options = nil) ⇒ IotHubClient
Creates initializes a new instance of the IotHubClient class.
46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 46 def initialize(credentials, base_url = nil, = nil) super(credentials, ) @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 @iot_hub_resource = IotHubResource.new(self) @api_version = '2016-02-03' @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.
27 28 29 |
# File 'lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 27 def accept_language @accept_language end |
#api_version ⇒ String (readonly)
Returns Version of the Api.
24 25 26 |
# File 'lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 24 def api_version @api_version end |
#base_url ⇒ String
Returns the base URI of the service.
15 16 17 |
# File 'lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 15 def base_url @base_url end |
#credentials ⇒ Object (readonly)
Returns Credentials needed for the client to connect to Azure.
18 19 20 |
# File 'lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 18 def credentials @credentials end |
#generate_client_request_id ⇒ Boolean
is generated and included in each request. Default is true.
35 36 37 |
# File 'lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 35 def generate_client_request_id @generate_client_request_id end |
#iot_hub_resource ⇒ IotHubResource (readonly)
Returns iot_hub_resource.
38 39 40 |
# File 'lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 38 def iot_hub_resource @iot_hub_resource end |
#long_running_operation_retry_timeout ⇒ Integer
Running Operations. Default value is 30.
31 32 33 |
# File 'lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 31 def long_running_operation_retry_timeout @long_running_operation_retry_timeout end |
#subscription_id ⇒ String
Returns The subscription identifier.
21 22 23 |
# File 'lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 21 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"
= {
body: request_content,
query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, )
77 78 79 80 |
# File 'lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 77 def make_request(method, path, = {}) result = make_request_with_http_info(method, path, ) result.body unless result.nil? end |
#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise
Makes a request asynchronously.
102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 102 def make_request_async(method, path, = {}) fail ArgumentError, 'method is nil' if method.nil? fail ArgumentError, 'path is nil' if path.nil? request_url = [:base_url] || @base_url request_headers = @request_headers request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil? .merge!({headers: request_headers.merge([:headers] || {})}) .merge!({credentials: @credentials}) unless @credentials.nil? super(request_url, method, path, ) end |
#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse
Makes a request and returns the operation response.
89 90 91 92 93 |
# File 'lib/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 89 def make_request_with_http_info(method, path, = {}) result = make_request_async(method, path, ).value! result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body) result end |