Class: VSphereAutomation::Appliance::UpdateApi
- Inherits:
-
Object
- Object
- VSphereAutomation::Appliance::UpdateApi
- Defined in:
- lib/vsphere-automation-appliance/api/update_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#cancel(opts = {}) ⇒ |VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil
Request the cancellation the update operation that is currently in progress.
-
#cancel_with_http_info(opts = {}) ⇒ Array<(|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil, Fixnum, Hash)>
private
Request the cancellation the update operation that is currently in progress.
-
#get(opts = {}) ⇒ ApplianceUpdateResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|
Gets the current status of the appliance update.
-
#get_with_http_info(opts = {}) ⇒ Array<(ApplianceUpdateResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|, Fixnum, Hash)>
private
Gets the current status of the appliance update.
-
#initialize(api_client = ApiClient.default) ⇒ UpdateApi
constructor
A new instance of UpdateApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ UpdateApi
Returns a new instance of UpdateApi.
16 17 18 |
# File 'lib/vsphere-automation-appliance/api/update_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/update_api.rb', line 14 def api_client @api_client end |
Instance Method Details
#cancel(opts = {}) ⇒ |VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil
Request the cancellation the update operation that is currently in progress.
22 23 24 25 |
# File 'lib/vsphere-automation-appliance/api/update_api.rb', line 22 def cancel(opts = {}) cancel_with_http_info(opts) nil end |
#cancel_with_http_info(opts = {}) ⇒ Array<(|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil, 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.
Request the cancellation the update operation that is currently in progress.
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 |
# File 'lib/vsphere-automation-appliance/api/update_api.rb', line 31 def cancel_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UpdateApi.cancel ...' end # resource path local_var_path = '/appliance/update?action=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) if @api_client.config.debugging @api_client.config.logger.debug "API called: UpdateApi#cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get(opts = {}) ⇒ ApplianceUpdateResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|
Gets the current status of the appliance update.
66 67 68 69 |
# File 'lib/vsphere-automation-appliance/api/update_api.rb', line 66 def get(opts = {}) data, _status_code, _headers = get_with_http_info(opts) data end |
#get_with_http_info(opts = {}) ⇒ Array<(ApplianceUpdateResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|, 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.
Gets the current status of the appliance update.
75 76 77 78 79 80 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 |
# File 'lib/vsphere-automation-appliance/api/update_api.rb', line 75 def get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UpdateApi.get ...' end # resource path local_var_path = '/appliance/update' # 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::ApplianceUpdateResult', '400' => 'Appliance::VapiStdErrorsErrorError', '401' => 'Appliance::VapiStdErrorsUnauthenticatedError', '403' => 'Appliance::VapiStdErrorsUnauthorizedError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: UpdateApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |