class VSphereAutomation::Appliance::RecoveryBackupJobApi
Attributes
Public Class Methods
# File lib/vsphere-automation-appliance/api/recovery_backup_job_api.rb, line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Cancel the backup job. @param id ID (ID of job) @param [Hash] opts the optional parameters @return [ApplianceRecoveryBackupJobCancelResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|]
# File lib/vsphere-automation-appliance/api/recovery_backup_job_api.rb, line 23 def cancel(id, opts = {}) data, _status_code, _headers = cancel_with_http_info(id, opts) data end
Cancel the backup job. @api private @param id ID (ID of job) @param [Hash] opts the optional parameters @return [Array<(ApplianceRecoveryBackupJobCancelResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-appliance/api/recovery_backup_job_api.rb, line 33 def cancel_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RecoveryBackupJobApi.cancel ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling RecoveryBackupJobApi.cancel" end # resource path local_var_path = '/appliance/recovery/backup/job/{id}/cancel'.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => { '200' => 'Appliance::ApplianceRecoveryBackupJobCancelResult', '400' => 'Appliance::VapiStdErrorsErrorError', '404' => 'Appliance::VapiStdErrorsNotFoundError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: RecoveryBackupJobApi#cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Initiate backup. @param request_body @param [Hash] opts the optional parameters @return [ApplianceRecoveryBackupJobCreateResult|VapiStdErrorsErrorError|]
# File lib/vsphere-automation-appliance/api/recovery_backup_job_api.rb, line 78 def create(request_body, opts = {}) data, _status_code, _headers = create_with_http_info(request_body, opts) data end
Initiate backup. @api private @param request_body @param [Hash] opts the optional parameters @return [Array<(ApplianceRecoveryBackupJobCreateResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-appliance/api/recovery_backup_job_api.rb, line 88 def create_with_http_info(request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RecoveryBackupJobApi.create ...' end # verify the required parameter 'request_body' is set if @api_client.config.client_side_validation && request_body.nil? fail ArgumentError, "Missing the required parameter 'request_body' when calling RecoveryBackupJobApi.create" end # resource path local_var_path = '/appliance/recovery/backup/job' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(request_body) auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => { '200' => 'Appliance::ApplianceRecoveryBackupJobCreateResult', '400' => 'Appliance::VapiStdErrorsErrorError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: RecoveryBackupJobApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
See backup job progress/result. @param id ID (ID of job) @param [Hash] opts the optional parameters @return [ApplianceRecoveryBackupJobResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|]
# File lib/vsphere-automation-appliance/api/recovery_backup_job_api.rb, line 134 def get(id, opts = {}) data, _status_code, _headers = get_with_http_info(id, opts) data end
See backup job progress/result. @api private @param id ID (ID of job) @param [Hash] opts the optional parameters @return [Array<(ApplianceRecoveryBackupJobResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-appliance/api/recovery_backup_job_api.rb, line 144 def get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RecoveryBackupJobApi.get ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling RecoveryBackupJobApi.get" end # resource path local_var_path = '/appliance/recovery/backup/job/{id}'.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => { '200' => 'Appliance::ApplianceRecoveryBackupJobResult', '400' => 'Appliance::VapiStdErrorsErrorError', '404' => 'Appliance::VapiStdErrorsNotFoundError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: RecoveryBackupJobApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get list of backup jobs @param [Hash] opts the optional parameters @return [ApplianceRecoveryBackupJobListResult|VapiStdErrorsErrorError|]
# File lib/vsphere-automation-appliance/api/recovery_backup_job_api.rb, line 188 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
Get list of backup jobs @api private @param [Hash] opts the optional parameters @return [Array<(ApplianceRecoveryBackupJobListResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-appliance/api/recovery_backup_job_api.rb, line 197 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RecoveryBackupJobApi.list ...' end # resource path local_var_path = '/appliance/recovery/backup/job' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => { '200' => 'Appliance::ApplianceRecoveryBackupJobListResult', '400' => 'Appliance::VapiStdErrorsErrorError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: RecoveryBackupJobApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end