Class: Azure::IotHub::Mgmt::V2018_04_01::IotHubClient
- Inherits:
-
MsRestAzure::AzureServiceClient
- Object
- MsRestAzure::AzureServiceClient
- Azure::IotHub::Mgmt::V2018_04_01::IotHubClient
- Includes:
- MsRestAzure, MsRestAzure::Serialization
- Defined in:
- lib/2018-04-01/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
The preferred language for the response.
-
#api_version ⇒ String
readonly
The version of the API.
-
#base_url ⇒ String
The base URI of the service.
-
#certificates ⇒ Certificates
readonly
Certificates.
-
#credentials ⇒ Object
readonly
Credentials needed for the client to connect to Azure.
-
#generate_client_request_id ⇒ Boolean
generated.
-
#iot_hub_resource ⇒ IotHubResource
readonly
Iot_hub_resource.
-
#long_running_operation_retry_timeout ⇒ Integer
Operations.
-
#operations ⇒ Operations
readonly
Operations.
-
#resource_provider_common ⇒ ResourceProviderCommon
readonly
Resource_provider_common.
-
#subscription_id ⇒ String
The subscription identifier.
Instance Method Summary collapse
-
#initialize(credentials = nil, 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 = nil, base_url = nil, options = nil) ⇒ IotHubClient
Creates initializes a new instance of the IotHubClient class.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 56 def initialize(credentials = nil, base_url = nil, = nil) super(credentials, ) @base_url = base_url || 'https://management.azure.com' fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil? @credentials = credentials @operations = Operations.new(self) @iot_hub_resource = IotHubResource.new(self) @resource_provider_common = ResourceProviderCommon.new(self) @certificates = Certificates.new(self) @api_version = '2018-04-01' @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.
27 28 29 |
# File 'lib/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 27 def accept_language @accept_language end |
#api_version ⇒ String (readonly)
Returns The version of the API.
24 25 26 |
# File 'lib/2018-04-01/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/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 15 def base_url @base_url end |
#certificates ⇒ Certificates (readonly)
Returns certificates.
48 49 50 |
# File 'lib/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 48 def certificates @certificates end |
#credentials ⇒ Object (readonly)
Returns Credentials needed for the client to connect to Azure.
18 19 20 |
# File 'lib/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 18 def credentials @credentials 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.
36 37 38 |
# File 'lib/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 36 def generate_client_request_id @generate_client_request_id end |
#iot_hub_resource ⇒ IotHubResource (readonly)
Returns iot_hub_resource.
42 43 44 |
# File 'lib/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 42 def iot_hub_resource @iot_hub_resource end |
#long_running_operation_retry_timeout ⇒ Integer
Operations. Default value is 30.
31 32 33 |
# File 'lib/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 31 def long_running_operation_retry_timeout @long_running_operation_retry_timeout end |
#operations ⇒ Operations (readonly)
Returns operations.
39 40 41 |
# File 'lib/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 39 def operations @operations end |
#resource_provider_common ⇒ ResourceProviderCommon (readonly)
Returns resource_provider_common.
45 46 47 |
# File 'lib/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 45 def resource_provider_common @resource_provider_common end |
#subscription_id ⇒ String
Returns The subscription identifier.
21 22 23 |
# File 'lib/2018-04-01/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, )
90 91 92 93 |
# File 'lib/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 90 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.
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 115 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 if(![:headers].nil? && ![:headers]['Content-Type'].nil?) @request_headers['Content-Type'] = [:headers]['Content-Type'] end 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.
102 103 104 105 106 |
# File 'lib/2018-04-01/generated/azure_mgmt_iot_hub/iot_hub_client.rb', line 102 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 |