Class List Method List File List

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

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

     A service is a logical grouping of operations that operate on some entity. A service element describes a service. It contains operation elements that describe the operations grouped in the service. It also contains structure elements and enumeration elements corresponding to the structures and enumerations defined in the service.

## Constant Summary

RESOURCE_TYPE =

      'com.vmware.vapi.service'

## Instance Method Summary (collapse)

- - (Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo) get(service_id)

  Retrieves information about the service element corresponding to ``service_id`` .

- - (ServiceService) initialize(config) constructor

  Constructs a new instance.

- - (Array<String>) list

  Returns the identifiers for the service elements that are currently registered with the infrastructure.

## Constructor Details

### - (`ServiceService`) initialize(config)

Constructs a new instance.

Parameters:

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

  A hash with the api provider details.

    425
    426
    427
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 425

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

## Instance Method Details

### - (`Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo`) get(service_id)

Retrieves information about the service element corresponding to ``service_id`` .

     The   :class:`Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo`   contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service element.

Parameters:

- service_id (`String`) —

  Identifier of the service element.

Returns:

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

  The :class:`Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo` instance that corresponds to ``service_id``

Raises:

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

  if the service element associated with ``service_id`` is not registered with the infrastructure.

    453
    454
    455
    456
    457
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 453

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

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

Returns the identifiers for the service elements that are currently registered with the infrastructure.

     The list of service elements is an aggregate list of all the service elements contained in all the package elements.

Returns:

- (`Array<String>`) —

  The list of identifiers for the service elements that are currently registered with the infrastructure.

    438
    439
    440
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 438

    def list()
        invoke_with_info(@@list_info)
    end