class VSphereAutomation::VAPI::MetadataAuthenticationComponentApi
Attributes
Public Class Methods
# File lib/vsphere-automation-vapi/api/metadata_authentication_component_api.rb, line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Retrieves the fingerprint computed from the authentication metadata of the component element corresponding to {@param.name 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 {@link vapi.metadata.authentication.Component#get}. @param component_id Identifier of the component element. @param [Hash] opts the optional parameters @return [VapiMetadataAuthenticationComponentFingerprintResult|VapiStdErrorsNotFoundError|]
# File lib/vsphere-automation-vapi/api/metadata_authentication_component_api.rb, line 23 def fingerprint(component_id, opts = {}) data, _status_code, _headers = fingerprint_with_http_info(component_id, opts) data end
Retrieves the fingerprint computed from the authentication metadata of the component element corresponding to {@param.name 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 {@link vapi.metadata.authentication.Component#get}. @api private @param component_id Identifier of the component element. @param [Hash] opts the optional parameters @return [Array<(VapiMetadataAuthenticationComponentFingerprintResult|VapiStdErrorsNotFoundError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-vapi/api/metadata_authentication_component_api.rb, line 33 def fingerprint_with_http_info(component_id, 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 # resource path local_var_path = '/com/vmware/vapi/metadata/authentication/component/id:{component_id}?~action=fingerprint'.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(: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
Retrieves authentication information about the component element corresponding to {@param.name componentId}. <p> The {@link 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. @param component_id Identifier of the component element. @param [Hash] opts the optional parameters @return [VapiMetadataAuthenticationComponentResult|VapiStdErrorsNotFoundError|]
# File lib/vsphere-automation-vapi/api/metadata_authentication_component_api.rb, line 77 def get(component_id, opts = {}) data, _status_code, _headers = get_with_http_info(component_id, opts) data end
Retrieves authentication information about the component element corresponding to {@param.name componentId}. <p> The {@link 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. @api private @param component_id Identifier of the component element. @param [Hash] opts the optional parameters @return [Array<(VapiMetadataAuthenticationComponentResult|VapiStdErrorsNotFoundError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-vapi/api/metadata_authentication_component_api.rb, line 87 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
Returns the identifiers for the component elements that have authentication information. @param [Hash] opts the optional parameters @return [VapiMetadataAuthenticationComponentListResult|]
# File lib/vsphere-automation-vapi/api/metadata_authentication_component_api.rb, line 130 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
Returns the identifiers for the component elements that have authentication information. @api private @param [Hash] opts the optional parameters @return [Array<(VapiMetadataAuthenticationComponentListResult|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-vapi/api/metadata_authentication_component_api.rb, line 139 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