Class: Com::Vmware::Vapi::Metadata::Authentication::Component

Inherits:
VAPI::Bindings::VapiService
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb

Overview

The ``Com::Vmware::Vapi::Metadata::Authentication::Component`` class provides methods to retrieve authentication information of a component element. 


 A component element is said to contain authentication information if any one of package elements contained in it has authentication information.

Constant Summary

RESOURCE_TYPE = 
'com.vmware.vapi.component'

Instance Method Summary (collapse)

Constructor Details

- (Component) initialize(config)

Constructs a new instance.

Parameters:

  • config (VAPI::Bindings::StubConfig) —

    A hash with the api provider details. 



79
80
81
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 79

def initialize(config)
    super(config, @@service_info)
end

Instance Method Details

- (String) fingerprint(component_id)

Retrieves the fingerprint computed from the authentication metadata of the component element corresponding to ``component_id`` . 


 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   :func:`Com::Vmware::Vapi::Metadata::Authentication::Component.get`  .

Parameters:

  • component_id (String) —

    Identifier of the component element.

Returns:

  • (String) —

    The fingerprint computed from the authentication metadata of the component.

Raises:



122
123
124
125
126
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 122

def fingerprint(component_id)
    invoke_with_info(@@fingerprint_info, {
        'component_id' => component_id,
    })
end

- (Com::Vmware::Vapi::Metadata::Authentication::ComponentData) get(component_id)

Retrieves authentication information about the component element corresponding to ``component_id`` . 


 The   :class:`Com::Vmware::Vapi::Metadata::Authentication::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 (String) —

    Identifier of the component element.

Returns:

Raises:



105
106
107
108
109
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 105

def get(component_id)
    invoke_with_info(@@get_info, {
        'component_id' => component_id,
    })
end

- (Array<String>) list

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

Returns:

  • (Array<String>) —

    The list of identifiers for the component elements that have authentication information. 



90
91
92
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 90

def list()
    invoke_with_info(@@list_info)
end