Class: Azure::RecoveryServicesBackup::Mgmt::V2019_05_13::JobCancellations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-05-13/generated/azure_mgmt_recovery_services_backup/job_cancellations.rb

Overview

JobCancellations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ JobCancellations

Creates and initializes a new instance of the JobCancellations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-05-13/generated/azure_mgmt_recovery_services_backup/job_cancellations.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-05-13/generated/azure_mgmt_recovery_services_backup/job_cancellations.rb', line 22

def client
  @client
end

Instance Method Details

#trigger(vault_name, resource_group_name, job_name, custom_headers: nil) ⇒ Object

Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call GetCancelOperationResult API.

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

  • job_name (String) —

    Name of the job to cancel.

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

    A hash of custom headers that



37
38
39
40
 
# File 'lib/2019-05-13/generated/azure_mgmt_recovery_services_backup/job_cancellations.rb', line 37

def trigger(vault_name, resource_group_name, job_name, custom_headers:nil)
  response = trigger_async(vault_name, resource_group_name, job_name, custom_headers:custom_headers).value!
  nil
end

#trigger_async(vault_name, resource_group_name, job_name, custom_headers: nil) ⇒ Concurrent::Promise

Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call GetCancelOperationResult API.

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

  • job_name (String) —

    Name of the job to cancel.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2019-05-13/generated/azure_mgmt_recovery_services_backup/job_cancellations.rb', line 74

def trigger_async(vault_name, resource_group_name, job_name, 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, 'job_name is nil' if job_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}/backupJobs/{jobName}/cancel'

  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,'jobName' => job_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, 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 == 202
      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

#trigger_with_http_info(vault_name, resource_group_name, job_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call GetCancelOperationResult API.

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

  • job_name (String) —

    Name of the job to cancel.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



56
57
58
 
# File 'lib/2019-05-13/generated/azure_mgmt_recovery_services_backup/job_cancellations.rb', line 56

def trigger_with_http_info(vault_name, resource_group_name, job_name, custom_headers:nil)
  trigger_async(vault_name, resource_group_name, job_name, custom_headers:custom_headers).value!
end