Class: VSphereAutomation::VAPI::MetadataCliNamespaceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MetadataCliNamespaceApi

Returns a new instance of MetadataCliNamespaceApi.



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

def api_client
  @api_client
end

Instance Method Details

#fingerprint(action, opts = {}) ⇒ VapiMetadataCliNamespaceFingerprintResult|

Returns the aggregate fingerprint of all the namespace metadata from all the metadata sources. <p> The fingerprint provides clients an efficient way to check if the metadata for namespaces has been modified on the server.

Parameters:

  • action —

    ~action&#x3D;fingerprint

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

    the optional parameters

Returns:



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

def fingerprint(action, opts = {})
  data, _status_code, _headers = fingerprint_with_http_info(action, opts)
  data
end

#fingerprint_with_http_info(action, opts = {}) ⇒ Array<(VapiMetadataCliNamespaceFingerprintResult|, 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 namespace metadata from all the metadata sources. &lt;p&gt; The fingerprint provides clients an efficient way to check if the metadata for namespaces has been modified on the server.

Parameters:

  • action —

    ~action&#x3D;fingerprint

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

    the optional parameters

Returns:



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

def fingerprint_with_http_info(action, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataCliNamespaceApi.fingerprint ...'
  end
  # verify the required parameter 'action' is set
  if @api_client.config.client_side_validation && action.nil?
    fail ArgumentError, "Missing the required parameter 'action' when calling MetadataCliNamespaceApi.fingerprint"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['fingerprint'].include?(action)
    fail ArgumentError, "invalid value for 'action', must be one of fingerprint"
  end
  # resource path
  local_var_path = '/com/vmware/vapi/metadata/cli/namespace'

  # query parameters
  query_params = {}
  query_params[:'~action'] = action

  # 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::VapiMetadataCliNamespaceFingerprintResult',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetadataCliNamespaceApi#fingerprint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(request_body, opts = {}) ⇒ VapiMetadataCliNamespaceResult|VapiStdErrorsNotFoundError|

Retreives information about a namespace including information about children of that namespace.

Parameters:

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/vsphere-automation-vapi/api/metadata_cli_namespace_api.rb', line 81

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<(VapiMetadataCliNamespaceResult|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.

Retreives information about a namespace including information about children of that namespace.

Parameters:

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

    the optional parameters

Returns:



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
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/vsphere-automation-vapi/api/metadata_cli_namespace_api.rb', line 91

def get_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataCliNamespaceApi.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 MetadataCliNamespaceApi.get"
  end
  # resource path
  local_var_path = '/com/vmware/vapi/metadata/cli/namespace?~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::VapiMetadataCliNamespaceResult',
	  '404' => 'VAPI::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetadataCliNamespaceApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ VapiMetadataCliNamespaceListResult|

Returns the identifiers of all namespaces registered with the infrastructure.

Parameters:

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

    the optional parameters

Returns:



136
137
138
139
 
# File 'lib/vsphere-automation-vapi/api/metadata_cli_namespace_api.rb', line 136

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

#list_with_http_info(opts = {}) ⇒ Array<(VapiMetadataCliNamespaceListResult|, 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 namespaces registered with the infrastructure.

Parameters:

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

    the optional parameters

Returns:



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
173
174
175
176
177
178
179
 
# File 'lib/vsphere-automation-vapi/api/metadata_cli_namespace_api.rb', line 145

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

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