Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Vapi::Metadata::Metamodel::Package
  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::Package`` class provides methods to retrieve metamodel information about a package element in the interface definition language.

     A package is a logical grouping of services, structures and enumerations. A package element describes the package. It contains the service elements, structure elements and enumeration elements that are grouped together.

## Constant Summary

RESOURCE_TYPE =

      'com.vmware.vapi.package'

## Instance Method Summary (collapse)

- - (Com::Vmware::Vapi::Metadata::Metamodel::PackageInfo) get(package_id)

  Retrieves information about the package element corresponding to ``package_id`` .

- - (Package) initialize(config) constructor

  Constructs a new instance.

- - (Array<String>) list

  Returns the identifiers for the packages elements that are contained in all the registered component elements.

## Constructor Details

### - (`Package`) initialize(config)

Constructs a new instance.

Parameters:

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

  A hash with the api provider details.

    305
    306
    307
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 305

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

## Instance Method Details

### - (`Com::Vmware::Vapi::Metadata::Metamodel::PackageInfo`) get(package_id)

Retrieves information about the package element corresponding to ``package_id`` .

Parameters:

- package_id (`String`) —

  Identifier of the package element.

Returns:

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

  The :class:`Com::Vmware::Vapi::Metadata::Metamodel::PackageInfo` instance that corresponds to ``package_id`` .

Raises:

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

  if the package element associated with ``package_id`` does not exist.

    329
    330
    331
    332
    333
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 329

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

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

Returns the identifiers for the packages elements that are contained in all the registered component elements.

Returns:

- (`Array<String>`) —

  The list of identifiers for the package elements that are contained in all the registered component elements.

    316
    317
    318
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 316

    def list()
        invoke_with_info(@@list_info)
    end