Class: VSphereAutomation::Appliance::RecoveryRestoreJobApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RecoveryRestoreJobApi

Returns a new instance of RecoveryRestoreJobApi.



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

def api_client
  @api_client
end

Instance Method Details

#cancel(opts = {}) ⇒ ApplianceRecoveryRestoreJobCancelResult|VapiStdErrorsErrorError|

Cancel the restore job

Parameters:

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

    the optional parameters

Returns:



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

def cancel(opts = {})
  data, _status_code, _headers = cancel_with_http_info(opts)
  data
end

#cancel_with_http_info(opts = {}) ⇒ Array<(ApplianceRecoveryRestoreJobCancelResult|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.

Cancel the restore job

Parameters:

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

    the optional parameters

Returns:



31
32
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
 
# File 'lib/vsphere-automation-appliance/api/recovery_restore_job_api.rb', line 31

def cancel_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecoveryRestoreJobApi.cancel ...'
  end
  # resource path
  local_var_path = '/appliance/recovery/restore/job/cancel'

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

#create(request_body, opts = {}) ⇒ ApplianceRecoveryRestoreJobCreateResult|VapiStdErrorsErrorError|

Initiate restore.

Parameters:

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

    the optional parameters

Returns:



71
72
73
74
 
# File 'lib/vsphere-automation-appliance/api/recovery_restore_job_api.rb', line 71

def create(request_body, opts = {})
  data, _status_code, _headers = create_with_http_info(request_body, opts)
  data
end

#create_with_http_info(request_body, opts = {}) ⇒ Array<(ApplianceRecoveryRestoreJobCreateResult|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.

Initiate restore.

Parameters:

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

    the optional parameters

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/vsphere-automation-appliance/api/recovery_restore_job_api.rb', line 81

def create_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecoveryRestoreJobApi.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 RecoveryRestoreJobApi.create"
  end
  # resource path
  local_var_path = '/appliance/recovery/restore/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::ApplianceRecoveryRestoreJobCreateResult',
	  '400' => 'Appliance::VapiStdErrorsErrorError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecoveryRestoreJobApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(opts = {}) ⇒ ApplianceRecoveryRestoreJobResult|VapiStdErrorsErrorError|

See restore job progress/result.

Parameters:

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

    the optional parameters

Returns:



126
127
128
129
 
# File 'lib/vsphere-automation-appliance/api/recovery_restore_job_api.rb', line 126

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

#get_with_http_info(opts = {}) ⇒ Array<(ApplianceRecoveryRestoreJobResult|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.

See restore job progress/result.

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/vsphere-automation-appliance/api/recovery_restore_job_api.rb', line 135

def get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecoveryRestoreJobApi.get ...'
  end
  # resource path
  local_var_path = '/appliance/recovery/restore/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::ApplianceRecoveryRestoreJobResult',
	  '400' => 'Appliance::VapiStdErrorsErrorError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecoveryRestoreJobApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end