Class: Azure::RecoveryServicesBackup::Mgmt::V2016_06_01::ProtectedItemOperationStatuses

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

Overview

Open API 2.0 Specs for Azure RecoveryServices Backup service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ProtectedItemOperationStatuses

Creates and initializes a new instance of the ProtectedItemOperationStatuses class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ RecoveryServicesBackupClient (readonly)

Returns reference to the RecoveryServicesBackupClient.

Returns:



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

def client
  @client
end

Instance Method Details

#get(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, operation_id, custom_headers: nil) ⇒ OperationStatus

Gets the status of an operation such as triggering a backup or restore. The status can be: In progress, Completed, or Failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations create jobs. This method returns the list of jobs associated with the operation.

with the Recovery Services vault. item. operation. 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 associated

  • fabric_name (String) —

    The fabric name associated with the backup item.

  • container_name (String) —

    The container name associated with the backup

  • protected_item_name (String) —

    The name of backup item used in this GET

  • operation_id (String) —

    The OperationID used in this GET operation.

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

    A hash of custom headers that

Returns:

  • (OperationStatus) —

    operation results.



49
50
51
52
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protected_item_operation_statuses.rb', line 49

def get(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, operation_id, custom_headers:nil)
  response = get_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, operation_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, operation_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets the status of an operation such as triggering a backup or restore. The status can be: In progress, Completed, or Failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations create jobs. This method returns the list of jobs associated with the operation.

with the Recovery Services vault. item. operation. 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 associated

  • fabric_name (String) —

    The fabric name associated with the backup item.

  • container_name (String) —

    The container name associated with the backup

  • protected_item_name (String) —

    The name of backup item used in this GET

  • operation_id (String) —

    The OperationID used in this GET operation.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protected_item_operation_statuses.rb', line 100

def get_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_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, '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, '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}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationsStatus/{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,'fabricName' => fabric_name,'containerName' => container_name,'protectedItemName' => protected_item_name,'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
      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::V2016_06_01::Models::OperationStatus.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, operation_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the status of an operation such as triggering a backup or restore. The status can be: In progress, Completed, or Failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations create jobs. This method returns the list of jobs associated with the operation.

with the Recovery Services vault. item. operation. 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 associated

  • fabric_name (String) —

    The fabric name associated with the backup item.

  • container_name (String) —

    The container name associated with the backup

  • protected_item_name (String) —

    The name of backup item used in this GET

  • operation_id (String) —

    The OperationID used in this GET operation.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



75
76
77
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protected_item_operation_statuses.rb', line 75

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