Class: VSphereAutomation::Appliance::RecoveryBackupSystemNameArchiveApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RecoveryBackupSystemNameArchiveApi

Returns a new instance of RecoveryBackupSystemNameArchiveApi.



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

def api_client
  @api_client
end

Instance Method Details

#get(system_name, spec_location, archive, opts = {}) ⇒ ApplianceRecoveryBackupSystemNameArchiveResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|

Returns the information for backup corresponding to given backup location and system name.

Parameters:

  • system_name —

    System name identifier.

  • spec_location —

    Backup location URL.

  • archive —

    Archive identifier.

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

    the optional parameters

Options Hash (opts):

  • :spec_location_user (String) —

    Username for the given location.

  • :spec_location_password (String) —

    Password for the given location.

Returns:



27
28
29
30
 
# File 'lib/vsphere-automation-appliance/api/recovery_backup_system_name_archive_api.rb', line 27

def get(system_name, spec_location, archive, opts = {})
  data, _status_code, _headers = get_with_http_info(system_name, spec_location, archive, opts)
  data
end

#get_with_http_info(system_name, spec_location, archive, opts = {}) ⇒ Array<(ApplianceRecoveryBackupSystemNameArchiveResult|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 the information for backup corresponding to given backup location and system name.

Parameters:

  • system_name —

    System name identifier.

  • spec_location —

    Backup location URL.

  • archive —

    Archive identifier.

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

    the optional parameters

Options Hash (opts):

  • :spec_location_user (String) —

    Username for the given location.

  • :spec_location_password (String) —

    Password for the given location.

Returns:



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
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/vsphere-automation-appliance/api/recovery_backup_system_name_archive_api.rb', line 41

def get_with_http_info(system_name, spec_location, archive, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecoveryBackupSystemNameArchiveApi.get ...'
  end
  # verify the required parameter 'system_name' is set
  if @api_client.config.client_side_validation && system_name.nil?
    fail ArgumentError, "Missing the required parameter 'system_name' when calling RecoveryBackupSystemNameArchiveApi.get"
  end
  # verify the required parameter 'spec_location' is set
  if @api_client.config.client_side_validation && spec_location.nil?
    fail ArgumentError, "Missing the required parameter 'spec_location' when calling RecoveryBackupSystemNameArchiveApi.get"
  end
  # verify the required parameter 'archive' is set
  if @api_client.config.client_side_validation && archive.nil?
    fail ArgumentError, "Missing the required parameter 'archive' when calling RecoveryBackupSystemNameArchiveApi.get"
  end
  # resource path
  local_var_path = '/appliance/recovery/backup/system-name/{system_name}/archives/{archive}'.sub('{' + 'system_name' + '}', system_name.to_s).sub('{' + 'archive' + '}', archive.to_s)

  # query parameters
  query_params = {}
  query_params[:'spec.location'] = spec_location
  query_params[:'spec.location_user'] = opts[:'spec_location_user'] if !opts[:'spec_location_user'].nil?
  query_params[:'spec.location_password'] = opts[:'spec_location_password'] if !opts[:'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::ApplianceRecoveryBackupSystemNameArchiveResult',
	  '400' => 'Appliance::VapiStdErrorsErrorError',
	  '404' => 'Appliance::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecoveryBackupSystemNameArchiveApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns information about backup archives corresponding to given backup location and system name, which match the FilterSpec.

Parameters:

  • system_name —

    System name identifier.

  • loc_spec_location —

    Backup location URL.

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

    the optional parameters

Options Hash (opts):

  • :filter_spec_start_timestamp (String) —

    Backup must have been taken on or after this time to match the filter.

  • :filter_spec_end_timestamp (String) —

    Backup must have been taken on or before this time to match the filter.

  • :filter_spec_comment_substring (String) —

    Backup comment must contain this string to match the filter.

  • :filter_spec_max_results (Integer) —

    Limit result to a max count of most recent backups.

  • :loc_spec_location_user (String) —

    Username for the given location.

  • :loc_spec_location_password (String) —

    Password for the given location.

Returns:



104
105
106
107
 
# File 'lib/vsphere-automation-appliance/api/recovery_backup_system_name_archive_api.rb', line 104

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

#list_with_http_info(system_name, loc_spec_location, opts = {}) ⇒ Array<(ApplianceRecoveryBackupSystemNameArchiveListResult|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 information about backup archives corresponding to given backup location and system name, which match the FilterSpec.

Parameters:

  • system_name —

    System name identifier.

  • loc_spec_location —

    Backup location URL.

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

    the optional parameters

Options Hash (opts):

  • :filter_spec_start_timestamp (String) —

    Backup must have been taken on or after this time to match the filter.

  • :filter_spec_end_timestamp (String) —

    Backup must have been taken on or before this time to match the filter.

  • :filter_spec_comment_substring (String) —

    Backup comment must contain this string to match the filter.

  • :filter_spec_max_results (Integer) —

    Limit result to a max count of most recent backups.

  • :loc_spec_location_user (String) —

    Username for the given location.

  • :loc_spec_location_password (String) —

    Password for the given location.

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/vsphere-automation-appliance/api/recovery_backup_system_name_archive_api.rb', line 121

def list_with_http_info(system_name, loc_spec_location, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecoveryBackupSystemNameArchiveApi.list ...'
  end
  # verify the required parameter 'system_name' is set
  if @api_client.config.client_side_validation && system_name.nil?
    fail ArgumentError, "Missing the required parameter 'system_name' when calling RecoveryBackupSystemNameArchiveApi.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 RecoveryBackupSystemNameArchiveApi.list"
  end
  # resource path
  local_var_path = '/appliance/recovery/backup/system-name/{system_name}/archives'.sub('{' + 'system_name' + '}', system_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'loc_spec.location'] = loc_spec_location
  query_params[:'filter_spec.start_timestamp'] = opts[:'filter_spec_start_timestamp'] if !opts[:'filter_spec_start_timestamp'].nil?
  query_params[:'filter_spec.end_timestamp'] = opts[:'filter_spec_end_timestamp'] if !opts[:'filter_spec_end_timestamp'].nil?
  query_params[:'filter_spec.comment_substring'] = opts[:'filter_spec_comment_substring'] if !opts[:'filter_spec_comment_substring'].nil?
  query_params[:'filter_spec.max_results'] = opts[:'filter_spec_max_results'] if !opts[:'filter_spec_max_results'].nil?
  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::ApplianceRecoveryBackupSystemNameArchiveListResult',
	  '400' => 'Appliance::VapiStdErrorsErrorError',
	  '404' => 'Appliance::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecoveryBackupSystemNameArchiveApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end