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

Inheritance diagram for Com::Vmware::Vapi::Metadata::Cli::Source:

Classes
class	CreateSpec
class	Info

Avaliable Methods
public method	reload ()
public method	create ()
public method	get ()
public method	delete ()
public method	fingerprint ()
public method	new ()
public method	list ()

Detailed Description

The Com::Vmware::Vapi::Metadata::Cli::Source interface 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.

Member Function Documentation

public method Com::Vmware::Vapi::Metadata::Cli::Source::create

(

)

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 interfaces defined in :mod:com.vmware.vapi.metadata.cli package* .

Parameters

source_id	[REQUIRED] metadata source identifier. The value must be an identifier for the resource type getQualifiedName(com.vmware.vapi.metadata.source). . The value must be str.
spec	[REQUIRED] create specification. . The value must be Com::Vmware::Vapi::Metadata::Cli::Source::CreateSpec.

Exceptions

Com::Vmware::Vapi::Std::Errors::AlreadyExists	If the metadata source identifier is already registered with the infrastructure.
Com::Vmware::Vapi::Std::Errors::InvalidArgument	If type of the source specified in null is invalid.
Com::Vmware::Vapi::Std::Errors::InvalidArgument	If the file specified in null is not a valid JSON file or if the format of the CLI metadata in the JSON file is invalid.
Com::Vmware::Vapi::Std::Errors::InvalidArgument	If the URI specified in null is unreachable or if there is a transport protocol or message protocol mismatch between the client and the server or if the remote server do not have interfaces present in :mod:com.vmware.vapi.metadata.cli package .
Com::Vmware::Vapi::Std::Errors::NotFound	If the file specified in null does not exist.

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Source::delete

(

)

Deletes an existing CLI metadata source from the infrastructure.

Parameters

source_id

[REQUIRED] Identifier of the metadata source. The value must be an identifier for the resource type getQualifiedName(com.vmware.vapi.metadata.source). . The value must be str.

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound

If the metadata source identifier is not found.

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Source::fingerprint

(

)

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

[OPTIONAL] Identifier of the metadata source. The value must be an identifier for the resource type getQualifiedName(com.vmware.vapi.metadata.source). If unspecified, the fingerprint of all the metadata sources is returned. . The value must be str or None.

Return values

Aggregate

fingerprint of all the metadata sources or of a particular metadata source. The return type will be String

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound

If the metadata source identifier is not found.

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Source::get

(

)

Retrieves information about the metadata source corresponding to source_id .

Parameters

source_id

[REQUIRED] Identifier of the metadata source. The value must be an identifier for the resource type getQualifiedName(com.vmware.vapi.metadata.source). . The value must be str.

Return values

The	class Com::Vmware::Vapi::Metadata::Cli::Source::Info instance that corresponds to source_id The return type will be Com::Vmware::Vapi::Metadata::Cli::Source::Info

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound

If the metadata source identifier is not found.

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Source::list

(

)

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

Return values

The	list of identifiers for metadata sources currently registered. The value will be an identifier for the resource type getQualifiedName(com.vmware.vapi.metadata.source). The return type will be Array of str

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Source::new

(

)

Constructor to initialize the object

Parameters

api_provider	- protocol connection to use with stubs created by this factory
StubConfig	- Stub's additional configuration

Return values

Blessed

object

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Source::reload

(

)

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

Parameters

source_id

[OPTIONAL] Identifier of the metadata source. The value must be an identifier for the resource type getQualifiedName(com.vmware.vapi.metadata.source). If unspecified, all the metadata sources are reloaded. . The value must be str or None.

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound

If the metadata source identifier is not found.

Code:

---

The documentation for this class was generated from the following file:

• Com/Vmware/Vapi/Metadata/Cli/Source.pm