VMware vCloud Suite SDK for .NET 6.0.0
vmware::vapi::metadata::cli::Command Interface Reference

The Command interface provides methods to get information about command line interface (CLI) commands. More...

Inherited by vmware::vapi::metadata::cli::CommandStub.

List of all members.

Public Member Functions

global::System.Collections.Generic.List
< vmware.vapi.metadata.cli.CommandTypes.Identity
List (string path)
 Returns the identifiers of all commands, or commands in a specific namespace.
global::System.Collections.Generic.List
< vmware.vapi.metadata.cli.CommandTypes.Identity
List (string path, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns the identifiers of all commands, or commands in a specific namespace.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vapi.metadata.cli.CommandTypes.Identity > > 
ListAsync (string path)
 Returns the identifiers of all commands, or commands in a specific namespace.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vapi.metadata.cli.CommandTypes.Identity > > 
ListAsync (string path, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns the identifiers of all commands, or commands in a specific namespace.
vmware.vapi.metadata.cli.CommandTypes.Info Get (vmware.vapi.metadata.cli.CommandTypes.Identity identity)
 Retrieves information about a command including information about how to execute that command.
vmware.vapi.metadata.cli.CommandTypes.Info Get (vmware.vapi.metadata.cli.CommandTypes.Identity identity, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Retrieves information about a command including information about how to execute that command.
global::System.Threading.Tasks.Task
< vmware.vapi.metadata.cli.CommandTypes.Info
GetAsync (vmware.vapi.metadata.cli.CommandTypes.Identity identity)
 Retrieves information about a command including information about how to execute that command.
global::System.Threading.Tasks.Task
< vmware.vapi.metadata.cli.CommandTypes.Info
GetAsync (vmware.vapi.metadata.cli.CommandTypes.Identity identity, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Retrieves information about a command including information about how to execute that command.
string Fingerprint ()
 Returns the aggregate fingerprint of all the command metadata from all the metadata sources.
string Fingerprint (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns the aggregate fingerprint of all the command metadata from all the metadata sources.
global::System.Threading.Tasks.Task
< string > 
FingerprintAsync ()
 Returns the aggregate fingerprint of all the command metadata from all the metadata sources.
global::System.Threading.Tasks.Task
< string > 
FingerprintAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns the aggregate fingerprint of all the command metadata from all the metadata sources.

Detailed Description

The Command interface provides methods to get information about command line interface (CLI) commands.


Member Function Documentation

string vmware::vapi::metadata::cli::Command::Fingerprint ( )

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

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

Returns:
Fingerprint of all the command metadata present on the server.

Implemented in vmware::vapi::metadata::cli::CommandStub.

string vmware::vapi::metadata::cli::Command::Fingerprint ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

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

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

Returns:
Fingerprint of all the command metadata present on the server.

Implemented in vmware::vapi::metadata::cli::CommandStub.

global::System.Threading.Tasks.Task<string> vmware::vapi::metadata::cli::Command::FingerprintAsync ( )

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

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

Returns:
Fingerprint of all the command metadata present on the server.

Implemented in vmware::vapi::metadata::cli::CommandStub.

global::System.Threading.Tasks.Task<string> vmware::vapi::metadata::cli::Command::FingerprintAsync ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

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

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

Returns:
Fingerprint of all the command metadata present on the server.

Implemented in vmware::vapi::metadata::cli::CommandStub.

vmware.vapi.metadata.cli.CommandTypes.Info vmware::vapi::metadata::cli::Command::Get ( vmware.vapi.metadata.cli.CommandTypes.Identity  identity)

Retrieves information about a command including information about how to execute that command.

Exceptions:
vmware.vapi.std.errors.NotFoundif a command corresponding to identity doesn't exist.
Parameters:
identityIdentifier of the command for which to retreive information.
Returns:
Information about the command including information about how to execute that command.

Implemented in vmware::vapi::metadata::cli::CommandStub.

vmware.vapi.metadata.cli.CommandTypes.Info vmware::vapi::metadata::cli::Command::Get ( vmware.vapi.metadata.cli.CommandTypes.Identity  identity,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Retrieves information about a command including information about how to execute that command.

Exceptions:
vmware.vapi.std.errors.NotFoundif a command corresponding to identity doesn't exist.
Parameters:
identityIdentifier of the command for which to retreive information.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Information about the command including information about how to execute that command.

Implemented in vmware::vapi::metadata::cli::CommandStub.

global::System.Threading.Tasks.Task<vmware.vapi.metadata.cli.CommandTypes.Info> vmware::vapi::metadata::cli::Command::GetAsync ( vmware.vapi.metadata.cli.CommandTypes.Identity  identity,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Retrieves information about a command including information about how to execute that command.

Exceptions:
vmware.vapi.std.errors.NotFoundif a command corresponding to identity doesn't exist.
Parameters:
identityIdentifier of the command for which to retreive information.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Information about the command including information about how to execute that command.

Implemented in vmware::vapi::metadata::cli::CommandStub.

global::System.Threading.Tasks.Task<vmware.vapi.metadata.cli.CommandTypes.Info> vmware::vapi::metadata::cli::Command::GetAsync ( vmware.vapi.metadata.cli.CommandTypes.Identity  identity)

Retrieves information about a command including information about how to execute that command.

Exceptions:
vmware.vapi.std.errors.NotFoundif a command corresponding to identity doesn't exist.
Parameters:
identityIdentifier of the command for which to retreive information.
Returns:
Information about the command including information about how to execute that command.

Implemented in vmware::vapi::metadata::cli::CommandStub.

global::System.Collections.Generic.List<vmware.vapi.metadata.cli.CommandTypes.Identity> vmware::vapi::metadata::cli::Command::List ( string  path,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns the identifiers of all commands, or commands in a specific namespace.

Exceptions:
vmware.vapi.std.errors.NotFoundif a namespace corresponding to path doesn't exist.
Parameters:
pathThe dot-separated path of the namespace for which command identifiers should be returned. If null identifiers of all commands registered with the infrastructure will be returned.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Identifiers of the requested commands.

Implemented in vmware::vapi::metadata::cli::CommandStub.

global::System.Collections.Generic.List<vmware.vapi.metadata.cli.CommandTypes.Identity> vmware::vapi::metadata::cli::Command::List ( string  path)

Returns the identifiers of all commands, or commands in a specific namespace.

Exceptions:
vmware.vapi.std.errors.NotFoundif a namespace corresponding to path doesn't exist.
Parameters:
pathThe dot-separated path of the namespace for which command identifiers should be returned. If null identifiers of all commands registered with the infrastructure will be returned.
Returns:
Identifiers of the requested commands.

Implemented in vmware::vapi::metadata::cli::CommandStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vapi.metadata.cli.CommandTypes.Identity> > vmware::vapi::metadata::cli::Command::ListAsync ( string  path)

Returns the identifiers of all commands, or commands in a specific namespace.

Exceptions:
vmware.vapi.std.errors.NotFoundif a namespace corresponding to path doesn't exist.
Parameters:
pathThe dot-separated path of the namespace for which command identifiers should be returned. If null identifiers of all commands registered with the infrastructure will be returned.
Returns:
Identifiers of the requested commands.

Implemented in vmware::vapi::metadata::cli::CommandStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vapi.metadata.cli.CommandTypes.Identity> > vmware::vapi::metadata::cli::Command::ListAsync ( string  path,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns the identifiers of all commands, or commands in a specific namespace.

Exceptions:
vmware.vapi.std.errors.NotFoundif a namespace corresponding to path doesn't exist.
Parameters:
pathThe dot-separated path of the namespace for which command identifiers should be returned. If null identifiers of all commands registered with the infrastructure will be returned.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Identifiers of the requested commands.

Implemented in vmware::vapi::metadata::cli::CommandStub.


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