Class List Method List File List

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

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

     The  ``Com::Vmware::Vapi::Metadata::Metamodel::Enumeration``  has a list of enumeration value elements.

## Constant Summary

RESOURCE_TYPE =

      'com.vmware.vapi.enumeration'

## Instance Method Summary (collapse)

- - (Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo) get(enumeration_id)

  Retrieves information about the enumeration element corresponding to ``enumeration_id`` .

- - (Enumeration) initialize(config) constructor

  Constructs a new instance.

- - (Array<String>) list

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

## Constructor Details

### - (`Enumeration`) initialize(config)

Constructs a new instance.

Parameters:

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

  A hash with the api provider details.

    188
    189
    190
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 188

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

## Instance Method Details

### - (`Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo`) get(enumeration_id)

Retrieves information about the enumeration element corresponding to ``enumeration_id`` .

     The   :class:`Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo`   contains the metamodel information about the enumeration value element contained in the enumeration element.

Parameters:

- enumeration_id (`String`) —

  Identifier of the enumeration element.

Returns:

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

  The :class:`Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo` instance that corresponds to ``enumeration_id``

Raises:

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

  if the enumeration element associated with ``enumeration_id`` is not contained in any of the package elements, service elements and structure elements.

    214
    215
    216
    217
    218
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 214

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

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

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

Returns:

- (`Array<String>`) —

  The list of identifiers for the enumeration elements.

    199
    200
    201
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 199

    def list()
        invoke_with_info(@@list_info)
    end