Class List Method List File List

# Class: Com::Vmware::Vapi::Metadata::SourceCreateSpec

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

## Overview

The ``Com::Vmware::Vapi::Metadata::SourceCreateSpec`` class contains the registration information for a metadata source.

## Instance Attribute Summary (collapse)

- - (URI) address

  Connection information of the remote server.

- - (String) description

  English language human readable description of the source.

- - (String) filepath

  Absolute file path of the metamodel metadata file that has the metamodel 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)

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

  Constructs a new instance.

## Constructor Details

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

    73
    74
    75
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata.rb', line 73

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

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

This field is optional and it is only relevant when the value of ``type`` is :attr:`Com::Vmware::Vapi::Metadata::SourceType.REMOTE` .

Returns:

- (`URI`)

    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata.rb', line 44

    class SourceCreateSpec < 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.source_create_spec',
                    {
                        '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),
                    },
                    SourceCreateSpec,
                    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`)

    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata.rb', line 44

    class SourceCreateSpec < 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.source_create_spec',
                    {
                        '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),
                    },
                    SourceCreateSpec,
                    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 metamodel metadata file that has the metamodel information about one component element. This field is optional and it is only relevant when the value of ``type`` is :attr:`Com::Vmware::Vapi::Metadata::SourceType.FILE` .

Returns:

- (`String`)

    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata.rb', line 44

    class SourceCreateSpec < 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.source_create_spec',
                    {
                        '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),
                    },
                    SourceCreateSpec,
                    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`)

    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata.rb', line 44

    class SourceCreateSpec < 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.source_create_spec',
                    {
                        '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),
                    },
                    SourceCreateSpec,
                    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

    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata.rb', line 50

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vapi.metadata.source_create_spec',
            {
                '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),
            },
            SourceCreateSpec,
            false,
            nil)
    end