Class: VSphereAutomation::VAPI::RestNavigationServiceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RestNavigationServiceApi 



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

def api_client
  @api_client
end

Instance Method Details

#list(component_id, opts = {}) ⇒ VapiRestNavigationServiceListResult|VapiStdErrorsNotFoundError|

Gets list of all vAPI REST Services for a vAPI REST Component.

Options Hash (opts):

  • :base_url (String) —

    Base URL.



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

def list(component_id, opts = {})
  data, _status_code, _headers = list_with_http_info(component_id, opts)
  data
end

#list_with_http_info(component_id, opts = {}) ⇒ Array<(VapiRestNavigationServiceListResult|VapiStdErrorsNotFoundError|, 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 list of all vAPI REST Services for a vAPI REST Component.

Options Hash (opts):

  • :base_url (String) —

    Base URL.



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
69
70
71
72
73
74
75
76
 
# File 'lib/vsphere-automation-vapi/api/rest_navigation_service_api.rb', line 35

def list_with_http_info(component_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RestNavigationServiceApi.list ...'
  end
  # verify the required parameter 'component_id' is set
  if @api_client.config.client_side_validation && component_id.nil?
    fail ArgumentError, "Missing the required parameter 'component_id' when calling RestNavigationServiceApi.list"
  end
  # resource path
  local_var_path = '/com/vmware/vapi/rest/navigation/service'

  # query parameters
  query_params = {}
  query_params[:'component_id'] = component_id
  query_params[:'base_url'] = opts[:'base_url'] if !opts[:'base_url'].nil?

  # 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' => 'VAPI::VapiRestNavigationServiceListResult',
    '404' => 'VAPI::VapiStdErrorsNotFoundError',
  })
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RestNavigationServiceApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end