class VSphereAutomation::Appliance::RecoveryBackupSchedulesApi
Attributes
Public Class Methods
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Creates a schedule @param schedule Identifier of the schedule @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 24 def create(schedule, request_body, opts = {}) create_with_http_info(schedule, request_body, opts) nil end
Creates a schedule @api private @param schedule Identifier of the schedule @param request_body @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 35 def create_with_http_info(schedule, request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RecoveryBackupSchedulesApi.create ...' end # verify the required parameter 'schedule' is set if @api_client.config.client_side_validation && schedule.nil? fail ArgumentError, "Missing the required parameter 'schedule' when calling RecoveryBackupSchedulesApi.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 RecoveryBackupSchedulesApi.create" end # resource path local_var_path = '/appliance/recovery/backup/schedules/{schedule}'.sub('{' + 'schedule' + '}', schedule.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']) # 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) if @api_client.config.debugging @api_client.config.logger.debug "API called: RecoveryBackupSchedulesApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Deletes an existing schedule @param schedule Identifier of the schedule @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|nil]
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 81 def delete(schedule, opts = {}) delete_with_http_info(schedule, opts) nil end
Deletes an existing schedule @api private @param schedule Identifier of the schedule @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 91 def delete_with_http_info(schedule, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RecoveryBackupSchedulesApi.delete ...' end # verify the required parameter 'schedule' is set if @api_client.config.client_side_validation && schedule.nil? fail ArgumentError, "Missing the required parameter 'schedule' when calling RecoveryBackupSchedulesApi.delete" end # resource path local_var_path = '/appliance/recovery/backup/schedules/{schedule}'.sub('{' + 'schedule' + '}', schedule.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(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: RecoveryBackupSchedulesApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns an existing schedule information based on id @param schedule Identifier of the schedule @param [Hash] opts the optional parameters @return [ApplianceRecoveryBackupSchedulesResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|]
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 131 def get(schedule, opts = {}) data, _status_code, _headers = get_with_http_info(schedule, opts) data end
Returns an existing schedule information based on id @api private @param schedule Identifier of the schedule @param [Hash] opts the optional parameters @return [Array<(ApplianceRecoveryBackupSchedulesResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 141 def get_with_http_info(schedule, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RecoveryBackupSchedulesApi.get ...' end # verify the required parameter 'schedule' is set if @api_client.config.client_side_validation && schedule.nil? fail ArgumentError, "Missing the required parameter 'schedule' when calling RecoveryBackupSchedulesApi.get" end # resource path local_var_path = '/appliance/recovery/backup/schedules/{schedule}'.sub('{' + 'schedule' + '}', schedule.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::ApplianceRecoveryBackupSchedulesResult', '400' => 'Appliance::VapiStdErrorsErrorError', '404' => 'Appliance::VapiStdErrorsNotFoundError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: RecoveryBackupSchedulesApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns a list of existing schedules with details @param [Hash] opts the optional parameters @return [ApplianceRecoveryBackupSchedulesListResult|VapiStdErrorsErrorError|]
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 185 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
Returns a list of existing schedules with details @api private @param [Hash] opts the optional parameters @return [Array<(ApplianceRecoveryBackupSchedulesListResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 194 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RecoveryBackupSchedulesApi.list ...' end # resource path local_var_path = '/appliance/recovery/backup/schedules' # 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::ApplianceRecoveryBackupSchedulesListResult', '400' => 'Appliance::VapiStdErrorsErrorError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: RecoveryBackupSchedulesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Initiate backup with the specified schedule @param schedule Identifier of the schedule @param [Hash] opts the optional parameters @option opts [ApplianceRecoveryBackupSchedulesRun] :request_body @return [ApplianceRecoveryBackupSchedulesRunResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|]
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 235 def run(schedule, opts = {}) data, _status_code, _headers = run_with_http_info(schedule, opts) data end
Initiate backup with the specified schedule @api private @param schedule Identifier of the schedule @param [Hash] opts the optional parameters @option opts [ApplianceRecoveryBackupSchedulesRun] :request_body @return [Array<(ApplianceRecoveryBackupSchedulesRunResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 246 def run_with_http_info(schedule, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RecoveryBackupSchedulesApi.run ...' end # verify the required parameter 'schedule' is set if @api_client.config.client_side_validation && schedule.nil? fail ArgumentError, "Missing the required parameter 'schedule' when calling RecoveryBackupSchedulesApi.run" end # resource path local_var_path = '/appliance/recovery/backup/schedules/{schedule}?action=run'.sub('{' + 'schedule' + '}', schedule.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']) # 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(opts[:'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::ApplianceRecoveryBackupSchedulesRunResult', '400' => 'Appliance::VapiStdErrorsErrorError', '404' => 'Appliance::VapiStdErrorsNotFoundError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: RecoveryBackupSchedulesApi#run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates a schedule @param schedule Identifier of the schedule @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|nil]
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 294 def update(schedule, request_body, opts = {}) update_with_http_info(schedule, request_body, opts) nil end
Updates a schedule @api private @param schedule Identifier of the schedule @param request_body @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vsphere-automation-appliance/api/recovery_backup_schedules_api.rb, line 305 def update_with_http_info(schedule, request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RecoveryBackupSchedulesApi.update ...' end # verify the required parameter 'schedule' is set if @api_client.config.client_side_validation && schedule.nil? fail ArgumentError, "Missing the required parameter 'schedule' when calling RecoveryBackupSchedulesApi.update" 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 RecoveryBackupSchedulesApi.update" end # resource path local_var_path = '/appliance/recovery/backup/schedules/update/{schedule}'.sub('{' + 'schedule' + '}', schedule.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']) # 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(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: RecoveryBackupSchedulesApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end