Class: Com::Vmware::Vapi::Metadata::Cli::Source

Inherits:
VAPI::Bindings::VapiService
  • Object
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::Source`` class provides methods to manage the sources of command line interface (CLI) metadata information. 


 The interface definition language infrastructure provides tools to generate various kinds of metadata in JSON format from the interface definition files and additional properties files. One of the generated files contains CLI information.  

 A CLI metadata file contains information about one component element. When a CLI metadata file is added as a source, each source contributes only one component element's metadata.  

 CLI metadata can also be discovered from a remote server that supports the CLI metadata services (see   :mod:`com.vmware.vapi.metadata.cli`  )  package . Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.

Defined Under Namespace

Classes: CreateSpec, Info

Instance Method Summary (collapse)

Constructor Details

- (Source) initialize(config)

Constructs a new instance.

Parameters:

  • config (VAPI::Bindings::StubConfig) —

    A hash with the api provider details. 



812
813
814
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 812

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

Instance Method Details

- (Void) create(source_id, spec)

Creates a new metadata source. Once the server validates the registration information of the metadata source, the CLI metadata is retrieved from the source. This populates elements in all the classs defined in :mod:`com.vmware.vapi.metadata.cli` package .

Parameters:

Returns:

  • (Void)

Raises:



834
835
836
837
838
839
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 834

def create(source_id, spec)
    invoke_with_info(@@create_info, {
        'source_id' => source_id,
        'spec' => spec,
    })
end

- (Void) delete(source_id)

Deletes an existing CLI metadata source from the infrastructure.

Parameters:

  • source_id (String) —

    Identifier of the metadata source.

Returns:

  • (Void)

Raises:



849
850
851
852
853
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 849

def delete(source_id)
    invoke_with_info(@@delete_info, {
        'source_id' => source_id,
    })
end

- (String) fingerprint(source_id = nil)

Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if ``source_id`` is specified.

Parameters:

  • source_id (String, nil) (defaults to: nil) —

    Identifier of the metadata source. If unspecified, the fingerprint of all the metadata sources is returned.

Returns:

  • (String) —

    Aggregate fingerprint of all the metadata sources or of a particular metadata source.

Raises:



904
905
906
907
908
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 904

def fingerprint(source_id=nil)
    invoke_with_info(@@fingerprint_info, {
        'source_id' => source_id,
    })
end

- (Com::Vmware::Vapi::Metadata::Cli::Source::Info) get(source_id)

Retrieves information about the metadata source corresponding to ``source_id`` .

Parameters:

  • source_id (String) —

    Identifier of the metadata source.

Returns:

Raises:



864
865
866
867
868
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 864

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

- (Array<String>) list

Returns the identifiers of the metadata sources currently registered with the infrastructure.

Returns:

  • (Array<String>) —

    The list of identifiers for metadata sources currently registered. 



875
876
877
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 875

def list()
    invoke_with_info(@@list_info)
end

- (Void) reload(source_id = nil)

Reloads the CLI metadata from all the metadata sources or of a particular metadata source if ``source_id`` is specified.

Parameters:

  • source_id (String, nil) (defaults to: nil) —

    Identifier of the metadata source. If unspecified, all the metadata sources are reloaded.

Returns:

  • (Void)

Raises:



888
889
890
891
892
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 888

def reload(source_id=nil)
    invoke_with_info(@@reload_info, {
        'source_id' => source_id,
    })
end