class VSphereAutomation::Appliance::UpdateApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/vsphere-automation-appliance/api/update_api.rb, line 16
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

cancel(opts = {}) click to toggle source

Request the cancellation the update operation that is currently in progress. @param [Hash] opts the optional parameters @return [|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil]

# 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 = {}) click to toggle source

Request the cancellation the update operation that is currently in progress. @api private @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil, Fixnum, Hash)>] nil, response status code and response headers

# 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 = {}) click to toggle source

Gets the current status of the appliance update. @param [Hash] opts the optional parameters @return [ApplianceUpdateResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|]

# 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 = {}) click to toggle source

Gets the current status of the appliance update. @api private @param [Hash] opts the optional parameters @return [Array<(ApplianceUpdateResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|, Fixnum, Hash)>] data, response status code and response headers

# 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