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

The Counters interface provides methods to perform various Counter related operations. More...

Inherited by vmware::vstats::CountersStub.

List of all members.

Public Member Functions

global::System.Collections.Generic.List
< vmware.vstats.CountersTypes.Info
List (vmware.vstats.CountersTypes.FilterSpec filter)
 Returns information about all counters matching the filter parameters.
global::System.Collections.Generic.List
< vmware.vstats.CountersTypes.Info
List (vmware.vstats.CountersTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about all counters matching the filter parameters.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vstats.CountersTypes.Info > > 
ListAsync (vmware.vstats.CountersTypes.FilterSpec filter)
 Returns information about all counters matching the filter parameters.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vstats.CountersTypes.Info > > 
ListAsync (vmware.vstats.CountersTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about all counters matching the filter parameters.
vmware.vstats.CountersTypes.Info Get (string cid)
 Returns information about a specific Counter.
vmware.vstats.CountersTypes.Info Get (string cid, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about a specific Counter.
global::System.Threading.Tasks.Task
< vmware.vstats.CountersTypes.Info
GetAsync (string cid)
 Returns information about a specific Counter.
global::System.Threading.Tasks.Task
< vmware.vstats.CountersTypes.Info
GetAsync (string cid, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about a specific Counter.

Detailed Description

The Counters interface provides methods to perform various Counter related operations.

Counter is derived from metric. It applies the metric to a particular class of a resource. 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

vmware.vstats.CountersTypes.Info vmware::vstats::Counters::Get ( string  cid)

Returns information about a specific Counter.

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.InvalidArgumentif cid is invalid.
vmware.vapi.std.errors.NotFoundif Counter could not be located.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have sufficient privileges.
Parameters:
cidCounter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
Returns:
Information about the requested counter.

Implemented in vmware::vstats::CountersStub.

vmware.vstats.CountersTypes.Info vmware::vstats::Counters::Get ( string  cid,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns information about a specific Counter.

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.InvalidArgumentif cid is invalid.
vmware.vapi.std.errors.NotFoundif Counter could not be located.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have sufficient privileges.
Parameters:
cidCounter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Information about the requested counter.

Implemented in vmware::vstats::CountersStub.

global::System.Threading.Tasks.Task<vmware.vstats.CountersTypes.Info> vmware::vstats::Counters::GetAsync ( string  cid,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns information about a specific Counter.

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.InvalidArgumentif cid is invalid.
vmware.vapi.std.errors.NotFoundif Counter could not be located.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have sufficient privileges.
Parameters:
cidCounter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Information about the requested counter.

Implemented in vmware::vstats::CountersStub.

global::System.Threading.Tasks.Task<vmware.vstats.CountersTypes.Info> vmware::vstats::Counters::GetAsync ( string  cid)

Returns information about a specific Counter.

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.InvalidArgumentif cid is invalid.
vmware.vapi.std.errors.NotFoundif Counter could not be located.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have sufficient privileges.
Parameters:
cidCounter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
Returns:
Information about the requested counter.

Implemented in vmware::vstats::CountersStub.

global::System.Collections.Generic.List<vmware.vstats.CountersTypes.Info> vmware::vstats::Counters::List ( vmware.vstats.CountersTypes.FilterSpec  filter,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns information about all counters matching the filter parameters.

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.InvalidArgumentif any of the specified parameters are invalid.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have sufficient privileges.
Parameters:
filterFilters the returned records. When null no filtering will be applied.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
List of Counters.

Implemented in vmware::vstats::CountersStub.

global::System.Collections.Generic.List<vmware.vstats.CountersTypes.Info> vmware::vstats::Counters::List ( vmware.vstats.CountersTypes.FilterSpec  filter)

Returns information about all counters matching the filter parameters.

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.InvalidArgumentif any of the specified parameters are invalid.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have sufficient privileges.
Parameters:
filterFilters the returned records. When null no filtering will be applied.
Returns:
List of Counters.

Implemented in vmware::vstats::CountersStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vstats.CountersTypes.Info> > vmware::vstats::Counters::ListAsync ( vmware.vstats.CountersTypes.FilterSpec  filter)

Returns information about all counters matching the filter parameters.

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.InvalidArgumentif any of the specified parameters are invalid.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have sufficient privileges.
Parameters:
filterFilters the returned records. When null no filtering will be applied.
Returns:
List of Counters.

Implemented in vmware::vstats::CountersStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vstats.CountersTypes.Info> > vmware::vstats::Counters::ListAsync ( vmware.vstats.CountersTypes.FilterSpec  filter,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns information about all counters matching the filter parameters.

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.InvalidArgumentif any of the specified parameters are invalid.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have sufficient privileges.
Parameters:
filterFilters the returned records. When null no filtering will be applied.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
List of Counters.

Implemented in vmware::vstats::CountersStub.


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