Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Vapi::Metadata::Cli::Namespace
  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`` class provides methods to get information about command line interface (CLI) namespaces.

## Defined Under Namespace

Classes: Identity, Info

## Instance Method Summary (collapse)

- - (String) fingerprint

  Returns the aggregate fingerprint of all the namespace metadata from all the metadata sources.

- - (Com::Vmware::Vapi::Metadata::Cli::Namespace::Info) get(identity)

  Retreives information about a namespace including information about children of that namespace.

- - (Namespace) initialize(config) constructor

  Constructs a new instance.

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

  Returns the identifiers of all namespaces registered with the infrastructure.

## Constructor Details

### - (`Namespace`) initialize(config)

Constructs a new instance.

Parameters:

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

  A hash with the api provider details.

    588
    589
    590
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 588

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

## Instance Method Details

### - (`String`) fingerprint

Returns the aggregate fingerprint of all the namespace metadata from all the metadata sources.

     The fingerprint provides clients an efficient way to check if the metadata for namespaces has been modified on the server.

Returns:

- (`String`) —

  Fingerprint of all the namespace metadata present on the server.

    623
    624
    625
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 623

    def fingerprint()
        invoke_with_info(@@fingerprint_info)
    end

### - (`Com::Vmware::Vapi::Metadata::Cli::Namespace::Info`) get(identity)

Retreives information about a namespace including information about children of that namespace.

Parameters:

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

  Identifier of the namespace for which to retreive information.

Returns:

- (`Com::Vmware::Vapi::Metadata::Cli::Namespace::Info`) —

  Information about the namespace including information about child of that namespace.

Raises:

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

  if a namespace corresponding to ``identity`` doesn’t exist.

    610
    611
    612
    613
    614
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 610

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

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

Returns the identifiers of all namespaces registered with the infrastructure.

Returns:

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

  Identifiers of all the namespaces.

    597
    598
    599
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 597

    def list()
        invoke_with_info(@@list_info)
    end