Class: VSphereAutomation::VAPI::MetadataCliCommandApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MetadataCliCommandApi

Returns a new instance of MetadataCliCommandApi.



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

def api_client
  @api_client
end

Instance Method Details

#fingerprint(opts = {}) ⇒ VapiMetadataCliCommandFingerprintResult|

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.

Parameters:

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

    the optional parameters

Returns:



22
23
24
25
 
# 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 = {}) ⇒ Array<(VapiMetadataCliCommandFingerprintResult|, 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.

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.

Parameters:

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

    the optional parameters

Returns:



31
32
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
 
# 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 = {}) ⇒ VapiMetadataCliCommandResult|VapiStdErrorsNotFoundError|

Retrieves information about a command including information about how to execute that command.

Parameters:

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

    the optional parameters

Returns:



70
71
72
73
 
# 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 = {}) ⇒ Array<(VapiMetadataCliCommandResult|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.

Retrieves information about a command including information about how to execute that command.

Parameters:

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

    the optional parameters

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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
 
# 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 = {}) ⇒ VapiMetadataCliCommandListResult|VapiStdErrorsNotFoundError|

Returns the identifiers of all commands, or commands in a specific namespace.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :path (String) —

    The dot-separated path of the namespace for which command identifiers should be returned.

Returns:



126
127
128
129
 
# 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 = {}) ⇒ Array<(VapiMetadataCliCommandListResult|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.

Returns the identifiers of all commands, or commands in a specific namespace.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :path (String) —

    The dot-separated path of the namespace for which command identifiers should be returned.

Returns:



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# 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