Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vapi::Metadata::Cli::Namespace::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::Namespace::Info`` class contains information about a namespace. It includes the identity of the namespace, a description, information children namespaces.

## Instance Attribute Summary (collapse)

- - (Array<Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity>) children

  The children of this namespace in the tree of CLI namespaces.

- - (String) description

  The text description displayed to the user in help output.

- - (Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity) identity

  Basic namespace identity.

## 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)

    704
    705
    706
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 704

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

## Instance Attribute Details

### - (`Array<Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity>`) children

The children of this namespace in the tree of CLI namespaces.

Returns:

- (`Array<Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity>`)

    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 677

    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.namespace.info',
                    {
                        'identity' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity'),
                        'description' => VAPI::Bindings::StringType.instance,
                        'children' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity')),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :identity,
                      :description,
                      :children

        # 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

The text description displayed to the user in help output.

Returns:

- (`String`)

    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 677

    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.namespace.info',
                    {
                        'identity' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity'),
                        'description' => VAPI::Bindings::StringType.instance,
                        'children' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity')),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :identity,
                      :description,
                      :children

        # 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::Cli::Namespace::Identity`) identity

Basic namespace identity.

Returns:

- (`Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity`)

    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 677

    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.namespace.info',
                    {
                        'identity' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity'),
                        'description' => VAPI::Bindings::StringType.instance,
                        'children' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity')),
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :identity,
                      :description,
                      :children

        # 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

    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 683

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vapi.metadata.cli.namespace.info',
            {
                'identity' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity'),
                'description' => VAPI::Bindings::StringType.instance,
                'children' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Namespace::Identity')),
            },
            Info,
            false,
            nil)
    end