Class: VSphereAutomation::VAPI::VcenterActivationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VcenterActivationApi

Returns a new instance of VcenterActivationApi.



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

def api_client
  @api_client
end

Instance Method Details

#cancel(activation_id, opts = {}) ⇒ |VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil

Sends a request to cancel the task associated with the provided activationId.

Parameters:

  • activation_id —

    the activationId associated with a vCenter Server task to be canceled.

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

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/vsphere-automation-vapi/api/vcenter_activation_api.rb', line 23

def cancel(activation_id, opts = {})
  cancel_with_http_info(activation_id, opts)
  nil
end

#cancel_with_http_info(activation_id, opts = {}) ⇒ Array<(|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|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.

Sends a request to cancel the task associated with the provided activationId.

Parameters:

  • activation_id —

    the activationId associated with a vCenter Server task to be canceled.

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

    the optional parameters

Returns:



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
67
68
 
# File 'lib/vsphere-automation-vapi/api/vcenter_activation_api.rb', line 33

def cancel_with_http_info(activation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VcenterActivationApi.cancel ...'
  end
  # verify the required parameter 'activation_id' is set
  if @api_client.config.client_side_validation && activation_id.nil?
    fail ArgumentError, "Missing the required parameter 'activation_id' when calling VcenterActivationApi.cancel"
  end
  # resource path
  local_var_path = '/com/vmware/vapi/vcenter/activation/id:{activation_id}?~action=cancel'.sub('{' + 'activation_id' + '}', activation_id.to_s)

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