class VSphereAutomation::VAPI::MetadataCliCommandApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

fingerprint(opts = {}) click to toggle source

Returns the aggregate fingerprint of all the command metadata from all the metadata sources. <p> The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server. @param [Hash] opts the optional parameters @return [VapiMetadataCliCommandFingerprintResult|]

# File lib/vsphere-automation-vapi/api/metadata_cli_command_api.rb, line 22
def fingerprint(opts = {})
  data, _status_code, _headers = fingerprint_with_http_info(opts)
  data
end
fingerprint_with_http_info(opts = {}) click to toggle source

Returns the aggregate fingerprint of all the command metadata from all the metadata sources. &lt;p&gt; The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server. @api private @param [Hash] opts the optional parameters @return [Array<(VapiMetadataCliCommandFingerprintResult|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-vapi/api/metadata_cli_command_api.rb, line 31
def fingerprint_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataCliCommandApi.fingerprint ...'
  end
  # resource path
  local_var_path = '/com/vmware/vapi/metadata/cli/command?~action=fingerprint'

  # 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,
    :return_type => {
      '200' => 'VAPI::VapiMetadataCliCommandFingerprintResult',
    })
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetadataCliCommandApi#fingerprint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get(request_body, opts = {}) click to toggle source

Retrieves information about a command including information about how to execute that command. @param request_body @param [Hash] opts the optional parameters @return [VapiMetadataCliCommandResult|VapiStdErrorsNotFoundError|]

# File lib/vsphere-automation-vapi/api/metadata_cli_command_api.rb, line 70
def get(request_body, opts = {})
  data, _status_code, _headers = get_with_http_info(request_body, opts)
  data
end
get_with_http_info(request_body, opts = {}) click to toggle source

Retrieves information about a command including information about how to execute that command. @api private @param request_body @param [Hash] opts the optional parameters @return [Array<(VapiMetadataCliCommandResult|VapiStdErrorsNotFoundError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-vapi/api/metadata_cli_command_api.rb, line 80
def get_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataCliCommandApi.get ...'
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling MetadataCliCommandApi.get"
  end
  # resource path
  local_var_path = '/com/vmware/vapi/metadata/cli/command?~action=get'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  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,
    :return_type => {
      '200' => 'VAPI::VapiMetadataCliCommandResult',
      '404' => 'VAPI::VapiStdErrorsNotFoundError',
    })
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetadataCliCommandApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list(opts = {}) click to toggle source

Returns the identifiers of all commands, or commands in a specific namespace. @param [Hash] opts the optional parameters @option opts [String] :path The dot-separated path of the namespace for which command identifiers should be returned. @return [VapiMetadataCliCommandListResult|VapiStdErrorsNotFoundError|]

# File lib/vsphere-automation-vapi/api/metadata_cli_command_api.rb, line 126
def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end
list_with_http_info(opts = {}) click to toggle source

Returns the identifiers of all commands, or commands in a specific namespace. @api private @param [Hash] opts the optional parameters @option opts [String] :path The dot-separated path of the namespace for which command identifiers should be returned. @return [Array<(VapiMetadataCliCommandListResult|VapiStdErrorsNotFoundError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-vapi/api/metadata_cli_command_api.rb, line 136
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataCliCommandApi.list ...'
  end
  # resource path
  local_var_path = '/com/vmware/vapi/metadata/cli/command'

  # query parameters
  query_params = {}
  query_params[:'path'] = opts[:'path'] if !opts[:'path'].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::VapiMetadataCliCommandListResult',
      '404' => 'VAPI::VapiStdErrorsNotFoundError',
    })
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetadataCliCommandApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end