Class: Azure::RecoveryServicesBackup::Mgmt::V2016_12_01::BackupOperationResults

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_operation_results.rb

Overview

Open API 2.0 Specs for Azure RecoveryServices Backup service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ BackupOperationResults

Creates and initializes a new instance of the BackupOperationResults class.

Parameters:

  • client

    service class for accessing basic functionality.



21
22
23
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_operation_results.rb', line 21

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientRecoveryServicesBackupClient (readonly)

Returns reference to the RecoveryServicesBackupClient.

Returns:



26
27
28
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_operation_results.rb', line 26

def client
  @client
end

Instance Method Details

#get(vault_name, resource_group_name, operation_id, custom_headers: nil) ⇒ Object

Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the status code in the response would be Accepted. It will continue to be in this state till it reaches completion. On successful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is part of the Location header of the operation response.

recovery services vault is present. 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

  • operation_id (String)

    OperationID which represents the operation.

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

    A hash of custom headers that



45
46
47
48
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_operation_results.rb', line 45

def get(vault_name, resource_group_name, operation_id, custom_headers:nil)
  response = get_async(vault_name, resource_group_name, operation_id, custom_headers:custom_headers).value!
  nil
end

#get_async(vault_name, resource_group_name, operation_id, custom_headers: nil) ⇒ Concurrent::Promise

Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the status code in the response would be Accepted. It will continue to be in this state till it reaches completion. On successful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is part of the Location header of the operation response.

recovery services vault is present. 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

  • operation_id (String)

    OperationID which represents the operation.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_operation_results.rb', line 90

def get_async(vault_name, resource_group_name, operation_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, 'operation_id is nil' if operation_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}/backupOperationResults/{operationId}'

  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,'operationId' => operation_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 || status_code == 202 || status_code == 204
      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?

    result
  end

  promise.execute
end

#get_with_http_info(vault_name, resource_group_name, operation_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the status code in the response would be Accepted. It will continue to be in this state till it reaches completion. On successful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is part of the Location header of the operation response.

recovery services vault is present. 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

  • operation_id (String)

    OperationID which represents the operation.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



68
69
70
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_operation_results.rb', line 68

def get_with_http_info(vault_name, resource_group_name, operation_id, custom_headers:nil)
  get_async(vault_name, resource_group_name, operation_id, custom_headers:custom_headers).value!
end