Class: Com::Vmware::Vapi::Metadata::Authentication::ComponentData

Inherits:
VAPI::Bindings::VapiStruct
  • 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::ComponentData`` class contains the authentication information of the component along with its fingerprint.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (ComponentData) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

  • ruby_values (Hash) (defaults to: nil) —

    a map of initial property values (optional)

  • struct_value (VAPI::Data::StructValue) (defaults to: nil) —

    a raw StructValue from the wire (optional) 



722
723
724
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 722

def initialize(ruby_values=nil, struct_value=nil)
    super(self.class.binding_type, ruby_values, struct_value)
end

Instance Attribute Details

- (String) fingerprint

Fingerprint of the metadata of the component. 


 Authentication information could change when there is an infrastructure update. Since the data present in   :attr:`Com::Vmware::Vapi::Metadata::Authentication::ComponentData.info`   could be quite large,  ``fingerprint``  provides a convenient way to check if the data for a particular component is updated.  

 You should store the fingerprint associated with a component. After an update, by invoking the   :func:`Com::Vmware::Vapi::Metadata::Authentication::Component.fingerprint`    method , you can retrieve the new fingerprint for the component. If the new fingerprint and the previously stored fingerprint do not match, clients can then use the   :func:`Com::Vmware::Vapi::Metadata::Authentication::Component.get`   to retrieve the new authentication information for the component.

Returns:

  • (String) 


697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 697

class ComponentData < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vapi.metadata.authentication.component_data',
                {
                    'info' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Authentication::ComponentInfo'),
                    'fingerprint' => VAPI::Bindings::StringType.instance,
                },
                ComponentData,
                false,
                nil)
        end
    end

    attr_accessor :info,
                  :fingerprint

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Com::Vmware::Vapi::Metadata::Authentication::ComponentInfo) info

Authentication information of the component. This includes information about all the packages in the component.

Returns:



697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 697

class ComponentData < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vapi.metadata.authentication.component_data',
                {
                    'info' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Authentication::ComponentInfo'),
                    'fingerprint' => VAPI::Bindings::StringType.instance,
                },
                ComponentData,
                false,
                nil)
        end
    end

    attr_accessor :info,
                  :fingerprint

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

Class Method Details

+ (VAPI::Bindings::StructType) binding_type

Holds (gets or creates) the binding type metadata for this structure type.

Returns:

  • (VAPI::Bindings::StructType) —

    the binding type 



703
704
705
706
707
708
709
710
711
712
713
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 703

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vapi.metadata.authentication.component_data',
        {
            'info' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Authentication::ComponentInfo'),
            'fingerprint' => VAPI::Bindings::StringType.instance,
        },
        ComponentData,
        false,
        nil)
end