Class: VSphereAutomation::Appliance::UpdateStagedApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UpdateStagedApi

Returns a new instance of UpdateStagedApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete(opts = {}) ⇒ |VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil

Deletes the staged update

Parameters:

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

    the optional parameters

Returns:



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

def delete(opts = {})
  delete_with_http_info(opts)
  nil
end

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

Deletes the staged update

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

def delete_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UpdateStagedApi.delete ...'
  end
  # resource path
  local_var_path = '/appliance/update/staged'

  # 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(:DELETE, 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: UpdateStagedApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(opts = {}) ⇒ ApplianceUpdateStagedResult|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|

Gets the current status of the staged update

Parameters:

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

    the optional parameters

Returns:



66
67
68
69
 
# File 'lib/vsphere-automation-appliance/api/update_staged_api.rb', line 66

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

#get_with_http_info(opts = {}) ⇒ Array<(ApplianceUpdateStagedResult|VapiStdErrorsNotAllowedInCurrentStateError|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 staged update

Parameters:

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

    the optional parameters

Returns:



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_staged_api.rb', line 75

def get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UpdateStagedApi.get ...'
  end
  # resource path
  local_var_path = '/appliance/update/staged'

  # 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::ApplianceUpdateStagedResult',
	  '400' => 'Appliance::VapiStdErrorsNotAllowedInCurrentStateError',
	  '401' => 'Appliance::VapiStdErrorsUnauthenticatedError',
	  '403' => 'Appliance::VapiStdErrorsUnauthorizedError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UpdateStagedApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end