Class: VSphereAutomation::Appliance::RecoveryBackupSystemNameApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RecoveryBackupSystemNameApi

Returns a new instance of RecoveryBackupSystemNameApi.



16
17
18
 
# File 'lib/vsphere-automation-appliance/api/recovery_backup_system_name_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_system_name_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#list(loc_spec_location, opts = {}) ⇒ ApplianceRecoveryBackupSystemNameListResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|

Returns a list of system names for which backup archives exist under locSpec.

Parameters:

  • loc_spec_location —

    Backup location URL.

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

    the optional parameters

Options Hash (opts):

  • :loc_spec_location_user (String) —

    Username for the given location.

  • :loc_spec_location_password (String) —

    Password for the given location.

Returns:



25
26
27
28
 
# File 'lib/vsphere-automation-appliance/api/recovery_backup_system_name_api.rb', line 25

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

#list_with_http_info(loc_spec_location, opts = {}) ⇒ Array<(ApplianceRecoveryBackupSystemNameListResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|, 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 a list of system names for which backup archives exist under locSpec.

Parameters:

  • loc_spec_location —

    Backup location URL.

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

    the optional parameters

Options Hash (opts):

  • :loc_spec_location_user (String) —

    Username for the given location.

  • :loc_spec_location_password (String) —

    Password for the given location.

Returns:



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
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/vsphere-automation-appliance/api/recovery_backup_system_name_api.rb', line 37

def list_with_http_info(loc_spec_location, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecoveryBackupSystemNameApi.list ...'
  end
  # verify the required parameter 'loc_spec_location' is set
  if @api_client.config.client_side_validation && loc_spec_location.nil?
    fail ArgumentError, "Missing the required parameter 'loc_spec_location' when calling RecoveryBackupSystemNameApi.list"
  end
  # resource path
  local_var_path = '/appliance/recovery/backup/system-name'

  # query parameters
  query_params = {}
  query_params[:'loc_spec.location'] = loc_spec_location
  query_params[:'loc_spec.location_user'] = opts[:'loc_spec_location_user'] if !opts[:'loc_spec_location_user'].nil?
  query_params[:'loc_spec.location_password'] = opts[:'loc_spec_location_password'] if !opts[:'loc_spec_location_password'].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::ApplianceRecoveryBackupSystemNameListResult',
	  '400' => 'Appliance::VapiStdErrorsErrorError',
	  '404' => 'Appliance::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecoveryBackupSystemNameApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end