Class: Azure::RecoveryServicesBackup::Mgmt::V2019_06_15::RecoveryPoints

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb

Overview

RecoveryPoints

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ RecoveryPoints

Creates and initializes a new instance of the RecoveryPoints class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ RecoveryServicesBackupClient (readonly)

Returns reference to the RecoveryServicesBackupClient.

Returns:



22
23
24
 
# File 'lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 22

def client
  @client
end

Instance Method Details

#get(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers: nil) ⇒ RecoveryPointResource

Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation. To know the status of the operation, call the GetProtectedItemOperationResult API.

recovery services vault is present. needs to be fetched. data to be fetched. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • fabric_name (String) —

    Fabric name associated with backed up item.

  • container_name (String) —

    Container name associated with backed up item.

  • protected_item_name (String) —

    Backed up item name whose backup data

  • recovery_point_id (String) —

    RecoveryPointID represents the backed up

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

    A hash of custom headers that

Returns:

  • (RecoveryPointResource) —

    operation results.



162
163
164
165
 
# File 'lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 162

def get(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers:nil)
  response = get_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers: nil) ⇒ Concurrent::Promise

Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation. To know the status of the operation, call the GetProtectedItemOperationResult API.

recovery services vault is present. needs to be fetched. data to be fetched. to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • fabric_name (String) —

    Fabric name associated with backed up item.

  • container_name (String) —

    Container name associated with backed up item.

  • protected_item_name (String) —

    Backed up item name whose backup data

  • recovery_point_id (String) —

    RecoveryPointID represents the backed up

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
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
 
# File 'lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 211

def get_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'fabric_name is nil' if fabric_name.nil?
  fail ArgumentError, 'container_name is nil' if container_name.nil?
  fail ArgumentError, 'protected_item_name is nil' if protected_item_name.nil?
  fail ArgumentError, 'recovery_point_id is nil' if recovery_point_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}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'vaultName' => vault_name,'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'fabricName' => fabric_name,'containerName' => container_name,'protectedItemName' => protected_item_name,'recoveryPointId' => recovery_point_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 MsRestAzure::AzureOperationError.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::RecoveryServicesBackup::Mgmt::V2019_06_15::Models::RecoveryPointResource.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_with_http_info(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation. To know the status of the operation, call the GetProtectedItemOperationResult API.

recovery services vault is present. needs to be fetched. data to be fetched. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • fabric_name (String) —

    Fabric name associated with backed up item.

  • container_name (String) —

    Container name associated with backed up item.

  • protected_item_name (String) —

    Backed up item name whose backup data

  • recovery_point_id (String) —

    RecoveryPointID represents the backed up

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



187
188
189
 
# File 'lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 187

def get_with_http_info(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers:nil)
  get_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers:custom_headers).value!
end

#list(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter: nil, custom_headers: nil) ⇒ Array<RecoveryPointResource>

Lists the backup copies for the backed up item.

recovery services vault is present. item. be fetched. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • fabric_name (String) —

    Fabric name associated with the backed up item.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item whose backup copies are to

  • filter (String) (defaults to: nil) —

    OData filter options.

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

    A hash of custom headers that

Returns:

  • (Array<RecoveryPointResource>) —

    operation results.



41
42
43
44
 
# File 'lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 41

def list(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:nil, custom_headers:nil)
  first_page = list_as_lazy(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter: nil, custom_headers: nil) ⇒ RecoveryPointResourceList

Lists the backup copies for the backed up item.

recovery services vault is present. item. be fetched. will be added to the HTTP request.

response.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • fabric_name (String) —

    Fabric name associated with the backed up item.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item whose backup copies are to

  • filter (String) (defaults to: nil) —

    OData filter options.

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

    A hash of custom headers that

Returns:

  • (RecoveryPointResourceList) —

    which provide lazy access to pages of the



378
379
380
381
382
383
384
385
386
387
 
# File 'lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 378

def list_as_lazy(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:nil, custom_headers:nil)
  response = list_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:filter, custom_headers: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:custom_headers)
    end
    page
  end
end

#list_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the backup copies for the backed up item.

recovery services vault is present. item. be fetched. to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • fabric_name (String) —

    Fabric name associated with the backed up item.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item whose backup copies are to

  • filter (String) (defaults to: nil) —

    OData filter options.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 84

def list_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'fabric_name is nil' if fabric_name.nil?
  fail ArgumentError, 'container_name is nil' if container_name.nil?
  fail ArgumentError, 'protected_item_name is nil' if protected_item_name.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}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'vaultName' => vault_name,'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'fabricName' => fabric_name,'containerName' => container_name,'protectedItemName' => protected_item_name},
      query_params: {'api-version' => @client.api_version,'$filter' => filter},
      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 MsRestAzure::AzureOperationError.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::RecoveryServicesBackup::Mgmt::V2019_06_15::Models::RecoveryPointResourceList.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_next(next_page_link, custom_headers: nil) ⇒ RecoveryPointResourceList

Lists the backup copies for the backed up item.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (RecoveryPointResourceList) —

    operation results.



280
281
282
283
 
# File 'lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 280

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists the backup copies for the backed up item.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 309

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      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, 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 MsRestAzure::AzureOperationError.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::RecoveryServicesBackup::Mgmt::V2019_06_15::Models::RecoveryPointResourceList.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_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the backup copies for the backed up item.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



295
296
297
 
# File 'lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 295

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the backup copies for the backed up item.

recovery services vault is present. item. be fetched. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • fabric_name (String) —

    Fabric name associated with the backed up item.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item whose backup copies are to

  • filter (String) (defaults to: nil) —

    OData filter options.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



63
64
65
 
# File 'lib/2019-06-15/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 63

def list_with_http_info(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:nil, custom_headers:nil)
  list_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:filter, custom_headers:custom_headers).value!
end