Class List Method List File List

# Class: Com::Vmware::Vapi::Metadata::Metamodel::Structure

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

## Overview

The ``Com::Vmware::Vapi::Metadata::Metamodel::Structure`` class providers methods to retrieve metamodel information about a structure element in the interface definition language.

## Constant Summary

RESOURCE_TYPE =

      'com.vmware.vapi.structure'

## Instance Method Summary (collapse)

- - (Com::Vmware::Vapi::Metadata::Metamodel::StructureInfo) get(structure_id)

  Retrieves information about the structure element corresponding to ``structure_id`` .

- - (Structure) initialize(config) constructor

  Constructs a new instance.

- - (Array<String>) list

  Returns the identifiers for the structure elements that are contained in all the package elements and service elements.

## Constructor Details

### - (`Structure`) initialize(config)

Constructs a new instance.

Parameters:

- config (`VAPI::Bindings::StubConfig`) —

  A hash with the api provider details.

    793
    794
    795
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 793

    def initialize(config)
        super(config, @@service_info)
    end

## Instance Method Details

### - (`Com::Vmware::Vapi::Metadata::Metamodel::StructureInfo`) get(structure_id)

Retrieves information about the structure element corresponding to ``structure_id`` .

     The   :class:`Com::Vmware::Vapi::Metadata::Metamodel::StructureInfo`   contains the metamodel information about the structure element. It contains information about all the field elements and enumeration elements contained in this structure element.

Parameters:

- structure_id (`String`) —

  Identifier of the structure element.

Returns:

- (`Com::Vmware::Vapi::Metadata::Metamodel::StructureInfo`) —

  The :class:`Com::Vmware::Vapi::Metadata::Metamodel::StructureInfo` instance that corresponds to ``structure_id`` .

Raises:

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the structure element associated with ``structure_id`` is not contained in any of the package elements or service elements.

    819
    820
    821
    822
    823
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 819

    def get(structure_id)
        invoke_with_info(@@get_info, {
            'structure_id' => structure_id,
        })
    end

### - (`Array<String>`) list

Returns the identifiers for the structure elements that are contained in all the package elements and service elements.

Returns:

- (`Array<String>`) —

  The list of identifiers for the structure elements.

    804
    805
    806
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 804

    def list()
        invoke_with_info(@@list_info)
    end