Class: Azure::Cosmosdb::Mgmt::V2020_06_01_preview::RestorableDatabaseAccounts

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/restorable_database_accounts.rb

Overview

RestorableDatabaseAccounts

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ RestorableDatabaseAccounts

Creates and initializes a new instance of the RestorableDatabaseAccounts class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/restorable_database_accounts.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ CosmosDBManagementClient (readonly)

Returns reference to the CosmosDBManagementClient.

Returns:



22
23
24
 
# File 'lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/restorable_database_accounts.rb', line 22

def client
  @client
end

Instance Method Details

#get_by_location(location, instance_id, custom_headers: nil) ⇒ RestorableDatabaseAccountGetResult

Retrieves the properties of an existing Azure Cosmos DB restorable database account.

word capitalized. account. will be added to the HTTP request.

Parameters:

  • location (String) —

    Cosmos DB region, with spaces between words and each

  • instance_id (String) —

    The instanceId GUID of a restorable database

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (RestorableDatabaseAccountGetResult) —

    operation results.



226
227
228
229
 
# File 'lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/restorable_database_accounts.rb', line 226

def get_by_location(location, instance_id, custom_headers:nil)
  response = get_by_location_async(location, instance_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_by_location_async(location, instance_id, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves the properties of an existing Azure Cosmos DB restorable database account.

word capitalized. account. to the HTTP request.

Parameters:

  • location (String) —

    Cosmos DB region, with spaces between words and each

  • instance_id (String) —

    The instanceId GUID of a restorable database

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/restorable_database_accounts.rb', line 261

def get_by_location_async(location, instance_id, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'instance_id is nil' if instance_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'location' => location,'instanceId' => instance_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, options)

  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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Cosmosdb::Mgmt::V2020_06_01_preview::Models::RestorableDatabaseAccountGetResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_by_location_with_http_info(location, instance_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the properties of an existing Azure Cosmos DB restorable database account.

word capitalized. account. will be added to the HTTP request.

Parameters:

  • location (String) —

    Cosmos DB region, with spaces between words and each

  • instance_id (String) —

    The instanceId GUID of a restorable database

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



244
245
246
 
# File 'lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/restorable_database_accounts.rb', line 244

def get_by_location_with_http_info(location, instance_id, custom_headers:nil)
  get_by_location_async(location, instance_id, custom_headers:custom_headers).value!
end

#list(custom_headers: nil) ⇒ RestorableDatabaseAccountsListResult

Lists all the restorable Azure Cosmos DB database accounts available under the subscription.

will be added to the HTTP request.

Parameters:

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (RestorableDatabaseAccountsListResult) —

    operation results.



131
132
133
134
 
# File 'lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/restorable_database_accounts.rb', line 131

def list(custom_headers:nil)
  response = list_async(custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_async(custom_headers: nil) ⇒ Concurrent::Promise

Lists all the restorable Azure Cosmos DB database accounts available under the subscription.

to the HTTP request.

Parameters:

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/restorable_database_accounts.rb', line 158

def list_async(custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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.DocumentDB/restorableDatabaseAccounts'

  request_url = @base_url || @client.base_url

  options = {
      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, options)

  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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Cosmosdb::Mgmt::V2020_06_01_preview::Models::RestorableDatabaseAccountsListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_location(location, custom_headers: nil) ⇒ RestorableDatabaseAccountsListResult

Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region.

word capitalized. will be added to the HTTP request.

Parameters:

  • location (String) —

    Cosmos DB region, with spaces between words and each

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (RestorableDatabaseAccountsListResult) —

    operation results.



35
36
37
38
 
# File 'lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/restorable_database_accounts.rb', line 35

def list_by_location(location, custom_headers:nil)
  response = list_by_location_async(location, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_location_async(location, custom_headers: nil) ⇒ Concurrent::Promise

Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region.

word capitalized. to the HTTP request.

Parameters:

  • location (String) —

    Cosmos DB region, with spaces between words and each

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/restorable_database_accounts.rb', line 66

def list_by_location_async(location, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'location is nil' if location.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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.DocumentDB/locations/{location}/restorableDatabaseAccounts'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'location' => location},
      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, options)

  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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Cosmosdb::Mgmt::V2020_06_01_preview::Models::RestorableDatabaseAccountsListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_location_with_http_info(location, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region.

word capitalized. will be added to the HTTP request.

Parameters:

  • location (String) —

    Cosmos DB region, with spaces between words and each

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



51
52
53
 
# File 'lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/restorable_database_accounts.rb', line 51

def list_by_location_with_http_info(location, custom_headers:nil)
  list_by_location_async(location, custom_headers:custom_headers).value!
end

#list_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all the restorable Azure Cosmos DB database accounts available under the subscription.

will be added to the HTTP request.

Parameters:

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



145
146
147
 
# File 'lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/restorable_database_accounts.rb', line 145

def list_with_http_info(custom_headers:nil)
  list_async(custom_headers:custom_headers).value!
end