Class List Method List File List

# Class: Com::Vmware::Vapi::Metadata::Authentication::Source::Info

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vapi::Metadata::Authentication::Source::Info
  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::Source::Info`` class contains the metadata source information.

## Instance Attribute Summary (collapse)

- - (URI) address

  Connection information for the remote server.

- - (String) description

  English language human readable description of the source.

- - (String) filepath

  Absolute file path of the authentication metadata file that has the authentication information about one component element.

- - (Com::Vmware::Vapi::Metadata::SourceType) type

  Type of the metadata source.

## Class Method Summary (collapse)

- + (VAPI::Bindings::StructType) binding_type

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

## Instance Method Summary (collapse)

- - (Info) initialize(ruby_values = nil, struct_value = nil) constructor

  Constructs a new instance.

## Constructor Details

### - (`Info`) 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)

    527
    528
    529
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 527

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

## Instance Attribute Details

### - (`URI`) address

Connection information for the remote server. This must be in the format http(s)://IP:port/namespace.

     The remote server must support the  classs  in the   :mod:`com.vmware.vapi.metadata.authentication`    package . It must expose authentication information of one or more components.

This field is optional and it is only relevant when the value of ``type`` is null .

Returns:

- (`URI`)

    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 498

    class Info < 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.source.info',
                    {
                        'description' => VAPI::Bindings::StringType.instance,
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::SourceType'),
                        'filepath' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'address' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :description,
                      :type,
                      :filepath,
                      :address

        # 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

### - (`String`) description

English language human readable description of the source.

Returns:

- (`String`)

    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 498

    class Info < 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.source.info',
                    {
                        'description' => VAPI::Bindings::StringType.instance,
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::SourceType'),
                        'filepath' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'address' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :description,
                      :type,
                      :filepath,
                      :address

        # 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

### - (`String`) filepath

Absolute file path of the authentication metadata file that has the authentication information about one component element. The ``filePath`` is the path to the file in the server’s filesystem. This field is optional and it is only relevant when the value of ``type`` is null .

Returns:

- (`String`)

    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 498

    class Info < 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.source.info',
                    {
                        'description' => VAPI::Bindings::StringType.instance,
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::SourceType'),
                        'filepath' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'address' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :description,
                      :type,
                      :filepath,
                      :address

        # 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::SourceType`) type

Type of the metadata source.

Returns:

- (`Com::Vmware::Vapi::Metadata::SourceType`)

    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 498

    class Info < 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.source.info',
                    {
                        'description' => VAPI::Bindings::StringType.instance,
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::SourceType'),
                        'filepath' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'address' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :description,
                      :type,
                      :filepath,
                      :address

        # 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

    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 504

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vapi.metadata.authentication.source.info',
            {
                'description' => VAPI::Bindings::StringType.instance,
                'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::SourceType'),
                'filepath' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'address' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
            },
            Info,
            false,
            nil)
    end