class VSphereAutomation::VAPI::RestNavigationResourceApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get(type_id, instance_id, opts = {}) click to toggle source

Gets {@link List} of all {@link Operation}s about a vAPI REST {@link Resource}. Information is searched for by {@param.name typeId} and {@param.name instanceId} is used only in URLs. @param type_id Resource type id. @param instance_id Resource instance id. @param [Hash] opts the optional parameters @option opts [String] :base_url Base URL. @return [VapiRestNavigationResourceResult|]

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

Gets {@link List} of all {@link Operation}s about a vAPI REST {@link Resource}. Information is searched for by {@param.name typeId} and {@param.name instanceId} is used only in URLs. @api private @param type_id Resource type id. @param instance_id Resource instance id. @param [Hash] opts the optional parameters @option opts [String] :base_url Base URL. @return [Array<(VapiRestNavigationResourceResult|, Fixnum, Hash)>] data, response status code and response headers

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

Gets list of all vAPI REST {@link Resource}s. @param [Hash] opts the optional parameters @option opts [String] :base_url Base URL. @return [VapiRestNavigationResourceListResult|]

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

Gets list of all vAPI REST {@link Resource}s. @api private @param [Hash] opts the optional parameters @option opts [String] :base_url Base URL. @return [Array<(VapiRestNavigationResourceListResult|, Fixnum, Hash)>] data, response status code and response headers

# 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