VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::vstats::Metrics Interface Reference

The Metrics interface provides method to list metrics. More...

Inherited by vmware::vstats::MetricsStub.

List of all members.

Public Member Functions

global::System.Collections.Generic.List
< vmware.vstats.MetricsTypes.Summary
List ()
 Returns list of available Metrics as supplied by the discovered providers.
global::System.Collections.Generic.List
< vmware.vstats.MetricsTypes.Summary
List (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns list of available Metrics as supplied by the discovered providers.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vstats.MetricsTypes.Summary > > 
ListAsync ()
 Returns list of available Metrics as supplied by the discovered providers.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vstats.MetricsTypes.Summary > > 
ListAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns list of available Metrics as supplied by the discovered providers.

Detailed Description

The Metrics interface provides method to list metrics.

A metric is a fundamental concept. It means a measurable aspect or property. For instance, temperature, count, velocity, data size, bandwidth. Warning: This interface is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.


Member Function Documentation

global::System.Collections.Generic.List<vmware.vstats.MetricsTypes.Summary> vmware::vstats::Metrics::List ( )

Returns list of available Metrics as supplied by the discovered providers.

Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have sufficient privileges.
Returns:
List of Metrics.

Implemented in vmware::vstats::MetricsStub.

global::System.Collections.Generic.List<vmware.vstats.MetricsTypes.Summary> vmware::vstats::Metrics::List ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns list of available Metrics as supplied by the discovered providers.

Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have sufficient privileges.
Returns:
List of Metrics.

Implemented in vmware::vstats::MetricsStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vstats.MetricsTypes.Summary> > vmware::vstats::Metrics::ListAsync ( )

Returns list of available Metrics as supplied by the discovered providers.

Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have sufficient privileges.
Returns:
List of Metrics.

Implemented in vmware::vstats::MetricsStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vstats.MetricsTypes.Summary> > vmware::vstats::Metrics::ListAsync ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns list of available Metrics as supplied by the discovered providers.

Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have sufficient privileges.
Returns:
List of Metrics.

Implemented in vmware::vstats::MetricsStub.


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