Class: VSphereAutomation::Appliance::RecoveryBackupJobDetailsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vsphere-automation-appliance/api/recovery_backup_job_details_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RecoveryBackupJobDetailsApi

Returns a new instance of RecoveryBackupJobDetailsApi.



16
17
18
 
# File 'lib/vsphere-automation-appliance/api/recovery_backup_job_details_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/vsphere-automation-appliance/api/recovery_backup_job_details_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#list(opts = {}) ⇒ ApplianceRecoveryBackupJobDetailsListResult|VapiStdErrorsErrorError|

Returns detailed information about the current and historical backup jobs.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_jobs (Array<String>) —

    Identifiers of backup jobs that can match the filter.

Returns:



23
24
25
26
 
# File 'lib/vsphere-automation-appliance/api/recovery_backup_job_details_api.rb', line 23

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_with_http_info(opts = {}) ⇒ Array<(ApplianceRecoveryBackupJobDetailsListResult|VapiStdErrorsErrorError|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns detailed information about the current and historical backup jobs.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_jobs (Array<String>) —

    Identifiers of backup jobs that can match the filter.

Returns:



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/vsphere-automation-appliance/api/recovery_backup_job_details_api.rb', line 33

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecoveryBackupJobDetailsApi.list ...'
  end
  # resource path
  local_var_path = '/appliance/recovery/backup/job/details'

  # query parameters
  query_params = {}
  query_params[:'filter.jobs'] = @api_client.build_collection_param(opts[:'filter_jobs'], :multi) if !opts[:'filter_jobs'].nil?

  # 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::ApplianceRecoveryBackupJobDetailsListResult',
	  '400' => 'Appliance::VapiStdErrorsErrorError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecoveryBackupJobDetailsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end