Class: Azure::MobileEngagement::Mgmt::V2014_12_01::AppCollections
- Inherits:
-
Object
- Object
- Azure::MobileEngagement::Mgmt::V2014_12_01::AppCollections
- Includes:
- MsRestAzure
- Defined in:
- lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb
Overview
Microsoft Azure Mobile Engagement REST APIs.
Instance Attribute Summary collapse
-
#client ⇒ EngagementManagementClient
readonly
Reference to the EngagementManagementClient.
Instance Method Summary collapse
-
#check_name_availability(parameters, custom_headers = nil) ⇒ AppCollectionNameAvailability
Checks availability of an app collection name in the Engagement domain.
-
#check_name_availability_async(parameters, custom_headers = nil) ⇒ Concurrent::Promise
Checks availability of an app collection name in the Engagement domain.
-
#check_name_availability_with_http_info(parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Checks availability of an app collection name in the Engagement domain.
-
#initialize(client) ⇒ AppCollections
constructor
Creates and initializes a new instance of the AppCollections class.
-
#list(custom_headers = nil) ⇒ Array<AppCollection>
Lists app collections in a subscription.
-
#list_as_lazy(custom_headers = nil) ⇒ AppCollectionListResult
Lists app collections in a subscription.
-
#list_async(custom_headers = nil) ⇒ Concurrent::Promise
Lists app collections in a subscription.
-
#list_next(next_page_link, custom_headers = nil) ⇒ AppCollectionListResult
Lists app collections in a subscription.
-
#list_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise
Lists app collections in a subscription.
-
#list_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Lists app collections in a subscription.
-
#list_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Lists app collections in a subscription.
Constructor Details
#initialize(client) ⇒ AppCollections
Creates and initializes a new instance of the AppCollections class.
17 18 19 |
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb', line 17 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ EngagementManagementClient (readonly)
Returns reference to the EngagementManagementClient.
22 23 24 |
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb', line 22 def client @client end |
Instance Method Details
#check_name_availability(parameters, custom_headers = nil) ⇒ AppCollectionNameAvailability
Checks availability of an app collection name in the Engagement domain.
will be added to the HTTP request.
116 117 118 119 |
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb', line 116 def check_name_availability(parameters, custom_headers = nil) response = check_name_availability_async(parameters, custom_headers).value! response.body unless response.nil? end |
#check_name_availability_async(parameters, custom_headers = nil) ⇒ Concurrent::Promise
Checks availability of an app collection name in the Engagement domain.
to the HTTP request.
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb', line 143 def check_name_availability_async(parameters, custom_headers = nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'parameters is nil' if parameters.nil? request_headers = {} # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? request_headers['Content-Type'] = 'application/json; charset=utf-8' # Serialize Request request_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::AppCollectionNameAvailability.mapper() request_content = @client.serialize(request_mapper, parameters) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.MobileEngagement/checkAppCollectionNameAvailability' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:post, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::AppCollectionNameAvailability.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#check_name_availability_with_http_info(parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Checks availability of an app collection name in the Engagement domain.
will be added to the HTTP request.
130 131 132 |
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb', line 130 def check_name_availability_with_http_info(parameters, custom_headers = nil) check_name_availability_async(parameters, custom_headers).value! end |
#list(custom_headers = nil) ⇒ Array<AppCollection>
Lists app collections in a subscription.
will be added to the HTTP request.
32 33 34 35 |
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb', line 32 def list(custom_headers = nil) first_page = list_as_lazy(custom_headers) first_page.get_all_items end |
#list_as_lazy(custom_headers = nil) ⇒ AppCollectionListResult
Lists app collections in a subscription.
will be added to the HTTP request.
response.
299 300 301 302 303 304 305 306 307 308 |
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb', line 299 def list_as_lazy(custom_headers = nil) response = list_async(custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_next_async(next_page_link, custom_headers) end page end end |
#list_async(custom_headers = nil) ⇒ Concurrent::Promise
Lists app collections in a subscription.
to the HTTP request.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb', line 57 def list_async(custom_headers = nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? request_headers = {} # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.MobileEngagement/appCollections' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::AppCollectionListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_next(next_page_link, custom_headers = nil) ⇒ AppCollectionListResult
Lists app collections in a subscription.
to List operation. will be added to the HTTP request.
213 214 215 216 |
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb', line 213 def list_next(next_page_link, custom_headers = nil) response = list_next_async(next_page_link, custom_headers).value! response.body unless response.nil? end |
#list_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise
Lists app collections in a subscription.
to List operation. to the HTTP request.
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb', line 242 def list_next_async(next_page_link, custom_headers = nil) fail ArgumentError, 'next_page_link is nil' if next_page_link.nil? request_headers = {} # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = '{nextLink}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], skip_encoding_path_params: {'nextLink' => next_page_link}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::AppCollectionListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Lists app collections in a subscription.
to List operation. will be added to the HTTP request.
228 229 230 |
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb', line 228 def list_next_with_http_info(next_page_link, custom_headers = nil) list_next_async(next_page_link, custom_headers).value! end |
#list_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Lists app collections in a subscription.
will be added to the HTTP request.
45 46 47 |
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/app_collections.rb', line 45 def list_with_http_info(custom_headers = nil) list_async(custom_headers).value! end |