Class: Azure::ARM::NotificationHubs::NotificationHubsManagementClient
- Inherits:
-
MsRestAzure::AzureServiceClient
- Object
- MsRestAzure::AzureServiceClient
- Azure::ARM::NotificationHubs::NotificationHubsManagementClient
- Includes:
- MsRestAzure, MsRestAzure::Serialization
- Defined in:
- lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_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
Client Api Version.
-
#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.
-
#hubs ⇒ Hubs
readonly
Hubs.
-
#long_running_operation_retry_timeout ⇒ Integer
Running Operations.
-
#name ⇒ Name
readonly
Name.
-
#namespaces ⇒ Namespaces
readonly
Namespaces.
-
#notification_hubs ⇒ NotificationHubs
readonly
Notification_hubs.
-
#subscription_id ⇒ String
Microsoft Azure subscription.
Instance Method Summary collapse
-
#initialize(credentials = nil, base_url = nil, options = nil) ⇒ NotificationHubsManagementClient
constructor
Creates initializes a new instance of the NotificationHubsManagementClient 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) ⇒ NotificationHubsManagementClient
Creates initializes a new instance of the NotificationHubsManagementClient class.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_client.rb', line 57 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 @namespaces = Namespaces.new(self) @name = Name.new(self) @notification_hubs = NotificationHubs.new(self) @hubs = Hubs.new(self) @api_version = '2017-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 Gets or sets the preferred language for the response.
29 30 31 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_client.rb', line 29 def accept_language @accept_language end |
#api_version ⇒ String (readonly)
Returns Client Api Version.
26 27 28 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_client.rb', line 26 def api_version @api_version end |
#base_url ⇒ String
Returns the base URI of the service.
15 16 17 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_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_notification_hubs/notification_hubs_management_client.rb', line 18 def credentials @credentials end |
#generate_client_request_id ⇒ Boolean
is generated and included in each request. Default is true.
37 38 39 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_client.rb', line 37 def generate_client_request_id @generate_client_request_id end |
#hubs ⇒ Hubs (readonly)
Returns hubs.
49 50 51 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_client.rb', line 49 def hubs @hubs end |
#long_running_operation_retry_timeout ⇒ Integer
Running Operations. Default value is 30.
33 34 35 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_client.rb', line 33 def long_running_operation_retry_timeout @long_running_operation_retry_timeout end |
#name ⇒ Name (readonly)
Returns name.
43 44 45 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_client.rb', line 43 def name @name end |
#namespaces ⇒ Namespaces (readonly)
Returns namespaces.
40 41 42 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_client.rb', line 40 def namespaces @namespaces end |
#notification_hubs ⇒ NotificationHubs (readonly)
Returns notification_hubs.
46 47 48 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_client.rb', line 46 def notification_hubs @notification_hubs end |
#subscription_id ⇒ String
Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
23 24 25 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_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"
= {
body: request_content,
query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, )
91 92 93 94 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_client.rb', line 91 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.
116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_client.rb', line 116 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.
103 104 105 106 107 |
# File 'lib/generated/azure_mgmt_notification_hubs/notification_hubs_management_client.rb', line 103 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 |