Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vapi::Metadata::Cli::Source::Info
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb

## Overview

The ``Com::Vmware::Vapi::Metadata::Cli::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 CLI metadata file that has the CLI information about one component.

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

  The type ( ``FILE``, ``REMOTE`` ) 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)

    958
    959
    960
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 958

    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 should be in the format http(s)://IP:port/namespace.

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

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

Returns:

- (`URI`)

    929
    930
    931
    932
    933
    934
    935
    936
    937
    938
    939
    940
    941
    942
    943
    944
    945
    946
    947
    948
    949
    950
    951
    952
    953
    954
    955
    956
    957
    958
    959
    960
    961
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 929

    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.cli.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`)

    929
    930
    931
    932
    933
    934
    935
    936
    937
    938
    939
    940
    941
    942
    943
    944
    945
    946
    947
    948
    949
    950
    951
    952
    953
    954
    955
    956
    957
    958
    959
    960
    961
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 929

    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.cli.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 CLI metadata file that has the CLI information about one component. 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`)

    929
    930
    931
    932
    933
    934
    935
    936
    937
    938
    939
    940
    941
    942
    943
    944
    945
    946
    947
    948
    949
    950
    951
    952
    953
    954
    955
    956
    957
    958
    959
    960
    961
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 929

    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.cli.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

The type ( ``FILE``, ``REMOTE`` ) of the metadata source.

Returns:

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

    929
    930
    931
    932
    933
    934
    935
    936
    937
    938
    939
    940
    941
    942
    943
    944
    945
    946
    947
    948
    949
    950
    951
    952
    953
    954
    955
    956
    957
    958
    959
    960
    961
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 929

    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.cli.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

    935
    936
    937
    938
    939
    940
    941
    942
    943
    944
    945
    946
    947
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 935

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vapi.metadata.cli.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