Class: VSphereAutomation::VAPI::MetadataAuthenticationComponentApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MetadataAuthenticationComponentApi

Returns a new instance of MetadataAuthenticationComponentApi.



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

def api_client
  @api_client
end

Instance Method Details

#fingerprint(component_id, action, opts = {}) ⇒ VapiMetadataAuthenticationComponentFingerprintResult|VapiStdErrorsNotFoundError|

Retrieves the fingerprint computed from the authentication metadata of the component element corresponding to componentId. <p> The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of vapi.metadata.authentication.Component#get.

Parameters:

  • component_id —

    Identifier of the component element.

  • action —

    ~action&#x3D;fingerprint

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

    the optional parameters

Returns:



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

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

#fingerprint_with_http_info(component_id, action, opts = {}) ⇒ Array<(VapiMetadataAuthenticationComponentFingerprintResult|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 the fingerprint computed from the authentication metadata of the component element corresponding to componentId. &lt;p&gt; The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of vapi.metadata.authentication.Component#get.

Parameters:

  • component_id —

    Identifier of the component element.

  • action —

    ~action&#x3D;fingerprint

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

    the optional parameters

Returns:



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
77
78
79
80
81
82
83
 
# File 'lib/vsphere-automation-vapi/api/metadata_authentication_component_api.rb', line 35

def fingerprint_with_http_info(component_id, action, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataAuthenticationComponentApi.fingerprint ...'
  end
  # verify the required parameter 'component_id' is set
  if @api_client.config.client_side_validation && component_id.nil?
    fail ArgumentError, "Missing the required parameter 'component_id' when calling MetadataAuthenticationComponentApi.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 MetadataAuthenticationComponentApi.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/authentication/component/id:{component_id}'.sub('{' + 'component_id' + '}', component_id.to_s)

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

#get(component_id, opts = {}) ⇒ VapiMetadataAuthenticationComponentResult|VapiStdErrorsNotFoundError|

Retrieves authentication information about the component element corresponding to componentId. <p> The ComponentData contains the authentication information about the component element and it’s fingerprint. It contains information about all the package elements that belong to this component element.

Parameters:

  • component_id —

    Identifier of the component element.

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/vsphere-automation-vapi/api/metadata_authentication_component_api.rb', line 88

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

#get_with_http_info(component_id, opts = {}) ⇒ Array<(VapiMetadataAuthenticationComponentResult|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 authentication information about the component element corresponding to componentId. &lt;p&gt; The ComponentData contains the authentication information about the component element and it&#39;s fingerprint. It contains information about all the package elements that belong to this component element.

Parameters:

  • component_id —

    Identifier of the component element.

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

    the optional parameters

Returns:



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
133
134
135
136
137
 
# File 'lib/vsphere-automation-vapi/api/metadata_authentication_component_api.rb', line 98

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

  # 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::VapiMetadataAuthenticationComponentResult',
	  '404' => 'VAPI::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetadataAuthenticationComponentApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ VapiMetadataAuthenticationComponentListResult|

Returns the identifiers for the component elements that have authentication information.

Parameters:

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

    the optional parameters

Returns:



141
142
143
144
 
# File 'lib/vsphere-automation-vapi/api/metadata_authentication_component_api.rb', line 141

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

#list_with_http_info(opts = {}) ⇒ Array<(VapiMetadataAuthenticationComponentListResult|, 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 for the component elements that have authentication information.

Parameters:

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

    the optional parameters

Returns:



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
180
181
182
183
184
 
# File 'lib/vsphere-automation-vapi/api/metadata_authentication_component_api.rb', line 150

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

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