Class: VSphereAutomation::VAPI::RestNavigationResourceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RestNavigationResourceApi

Returns a new instance of RestNavigationResourceApi.



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

def api_client
  @api_client
end

Instance Method Details

#get(type_id, instance_id, opts = {}) ⇒ VapiRestNavigationResourceResult|

Gets List of all Operations about a vAPI REST Resource. Information is searched for by typeId and instanceId is used only in URLs.

Parameters:

  • type_id —

    Resource type id.

  • instance_id —

    Resource instance id.

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

    the optional parameters

Options Hash (opts):

  • :base_url (String) —

    Base URL.

Returns:



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

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

#get_with_http_info(type_id, instance_id, opts = {}) ⇒ Array<(VapiRestNavigationResourceResult|, 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 Operations about a vAPI REST Resource. Information is searched for by typeId and instanceId is used only in URLs.

Parameters:

  • type_id —

    Resource type id.

  • instance_id —

    Resource instance id.

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

    the optional parameters

Options Hash (opts):

  • :base_url (String) —

    Base URL.

Returns:



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
77
78
79
80
 
# File 'lib/vsphere-automation-vapi/api/rest_navigation_resource_api.rb', line 37

def get_with_http_info(type_id, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RestNavigationResourceApi.get ...'
  end
  # verify the required parameter 'type_id' is set
  if @api_client.config.client_side_validation && type_id.nil?
    fail ArgumentError, "Missing the required parameter 'type_id' when calling RestNavigationResourceApi.get"
  end
  # verify the required parameter 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling RestNavigationResourceApi.get"
  end
  # resource path
  local_var_path = '/com/vmware/vapi/rest/navigation/resource/id:{type_id}/id:{instance_id}'.sub('{' + 'type_id' + '}', type_id.to_s).sub('{' + 'instance_id' + '}', instance_id.to_s)

  # query parameters
  query_params = {}
  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::VapiRestNavigationResourceResult',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RestNavigationResourceApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ VapiRestNavigationResourceListResult|

Gets list of all vAPI REST Resources.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :base_url (String) —

    Base URL.

Returns:



85
86
87
88
 
# File 'lib/vsphere-automation-vapi/api/rest_navigation_resource_api.rb', line 85

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

#list_with_http_info(opts = {}) ⇒ Array<(VapiRestNavigationResourceListResult|, 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 Resources.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :base_url (String) —

    Base URL.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/vsphere-automation-vapi/api/rest_navigation_resource_api.rb', line 95

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RestNavigationResourceApi.list ...'
  end
  # resource path
  local_var_path = '/com/vmware/vapi/rest/navigation/resource'

  # query parameters
  query_params = {}
  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::VapiRestNavigationResourceListResult',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RestNavigationResourceApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end