vmware::vstats::CounterMetadata Interface Reference

The CounterMetadata interface provides access to the different historical editions of counters. More...

Inherited by vmware::vstats::CounterMetadataStub.

List of all members.

Public Member Functions
global::System.Collections.Generic.List < vmware.vstats.CounterMetadataTypes.Info >	List (string cid, vmware.vstats.CounterMetadataTypes.FilterSpec filter)
	Returns information about all counter metadata records for a specific Counter.
global::System.Collections.Generic.List < vmware.vstats.CounterMetadataTypes.Info >	List (string cid, vmware.vstats.CounterMetadataTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about all counter metadata records for a specific Counter.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vstats.CounterMetadataTypes.Info > >	ListAsync (string cid, vmware.vstats.CounterMetadataTypes.FilterSpec filter)
	Returns information about all counter metadata records for a specific Counter.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vstats.CounterMetadataTypes.Info > >	ListAsync (string cid, vmware.vstats.CounterMetadataTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about all counter metadata records for a specific Counter.
global::System.Collections.Generic.List < vmware.vstats.CounterMetadataTypes.Info >	GetDefault (string cid)
	This method returns the "default" CounterMetadata.
global::System.Collections.Generic.List < vmware.vstats.CounterMetadataTypes.Info >	GetDefault (string cid, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	This method returns the "default" CounterMetadata.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vstats.CounterMetadataTypes.Info > >	GetDefaultAsync (string cid)
	This method returns the "default" CounterMetadata.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vstats.CounterMetadataTypes.Info > >	GetDefaultAsync (string cid, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	This method returns the "default" CounterMetadata.
vmware.vstats.CounterMetadataTypes.Info	Get (string cid, string mid)
	Returns information about a specific CounterMetadata.
vmware.vstats.CounterMetadataTypes.Info	Get (string cid, string mid, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about a specific CounterMetadata.
global::System.Threading.Tasks.Task < vmware.vstats.CounterMetadataTypes.Info >	GetAsync (string cid, string mid)
	Returns information about a specific CounterMetadata.
global::System.Threading.Tasks.Task < vmware.vstats.CounterMetadataTypes.Info >	GetAsync (string cid, string mid, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about a specific CounterMetadata.

---

Detailed Description

The CounterMetadata interface provides access to the different historical editions of counters.

As computing platforms evolve over time the measurement units for different characteristics of the systems change. As such changes occur, counters will receive different editions reflected in a new metadata record. For example computer memory had changes from kilobytes through megabytes into gigabytes. 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.CounterMetadataTypes.Info vmware::vstats::CounterMetadata::Get	(	string	cid,
		string	mid
	)

Returns information about a specific CounterMetadata.

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.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if Counter or CounterMetadata could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

cid	Counter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
mid	CounterMetadata ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.CounterMetadata .

Returns:

Information about the desired CounterMetadata.

Implemented in vmware::vstats::CounterMetadataStub.

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

Returns information about a specific CounterMetadata.

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.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if Counter or CounterMetadata could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

cid	Counter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
mid	CounterMetadata ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.CounterMetadata .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Information about the desired CounterMetadata.

Implemented in vmware::vstats::CounterMetadataStub.

global::System.Threading.Tasks.Task<vmware.vstats.CounterMetadataTypes.Info> vmware::vstats::CounterMetadata::GetAsync	(	string	cid,
		string	mid
	)

Returns information about a specific CounterMetadata.

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.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if Counter or CounterMetadata could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

cid	Counter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
mid	CounterMetadata ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.CounterMetadata .

Returns:

Information about the desired CounterMetadata.

Implemented in vmware::vstats::CounterMetadataStub.

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

Returns information about a specific CounterMetadata.

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.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if Counter or CounterMetadata could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

cid	Counter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
mid	CounterMetadata ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.CounterMetadata .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Information about the desired CounterMetadata.

Implemented in vmware::vstats::CounterMetadataStub.

global::System.Collections.Generic.List<vmware.vstats.CounterMetadataTypes.Info> vmware::vstats::CounterMetadata::GetDefault

(

string

cid

)

This method returns the "default" CounterMetadata.

A Counter has at least one related metadata object. Usually, stats providers (for example hosts) are in agreement about the default metadata. In this case the returned list has a single metadata object.

Sometimes, when providers are in "disagreement" about the default, then the returned list would include all the possible "defaults". This potential ambiguity isn't a real issue because consumers of the vStats API rarely need to specify the "mid" of metadata. Therefore, this API is used primarily for informational purposes.. 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.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if cid is invalid.
vmware.vapi.std.errors.NotFound	if Counter could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

cid	Counter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .

Returns:

List of counter metadata records.

Implemented in vmware::vstats::CounterMetadataStub.

global::System.Collections.Generic.List<vmware.vstats.CounterMetadataTypes.Info> vmware::vstats::CounterMetadata::GetDefault	(	string	cid,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

This method returns the "default" CounterMetadata.

A Counter has at least one related metadata object. Usually, stats providers (for example hosts) are in agreement about the default metadata. In this case the returned list has a single metadata object.

Sometimes, when providers are in "disagreement" about the default, then the returned list would include all the possible "defaults". This potential ambiguity isn't a real issue because consumers of the vStats API rarely need to specify the "mid" of metadata. Therefore, this API is used primarily for informational purposes.. 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.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if cid is invalid.
vmware.vapi.std.errors.NotFound	if Counter could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

cid	Counter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

List of counter metadata records.

Implemented in vmware::vstats::CounterMetadataStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vstats.CounterMetadataTypes.Info> > vmware::vstats::CounterMetadata::GetDefaultAsync	(	string	cid,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

This method returns the "default" CounterMetadata.

A Counter has at least one related metadata object. Usually, stats providers (for example hosts) are in agreement about the default metadata. In this case the returned list has a single metadata object.

Sometimes, when providers are in "disagreement" about the default, then the returned list would include all the possible "defaults". This potential ambiguity isn't a real issue because consumers of the vStats API rarely need to specify the "mid" of metadata. Therefore, this API is used primarily for informational purposes.. 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.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if cid is invalid.
vmware.vapi.std.errors.NotFound	if Counter could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

cid	Counter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

List of counter metadata records.

Implemented in vmware::vstats::CounterMetadataStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vstats.CounterMetadataTypes.Info> > vmware::vstats::CounterMetadata::GetDefaultAsync

(

string

cid

)

This method returns the "default" CounterMetadata.

A Counter has at least one related metadata object. Usually, stats providers (for example hosts) are in agreement about the default metadata. In this case the returned list has a single metadata object.

Sometimes, when providers are in "disagreement" about the default, then the returned list would include all the possible "defaults". This potential ambiguity isn't a real issue because consumers of the vStats API rarely need to specify the "mid" of metadata. Therefore, this API is used primarily for informational purposes.. 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.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if cid is invalid.
vmware.vapi.std.errors.NotFound	if Counter could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

cid	Counter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .

Returns:

List of counter metadata records.

Implemented in vmware::vstats::CounterMetadataStub.

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

Returns information about all counter metadata records for 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.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if Counter could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

cid	Counter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
filter	Filter specification. When null no filtering will be performed.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

List of counter metadata for the specified counter.

Implemented in vmware::vstats::CounterMetadataStub.

global::System.Collections.Generic.List<vmware.vstats.CounterMetadataTypes.Info> vmware::vstats::CounterMetadata::List	(	string	cid,
		vmware.vstats.CounterMetadataTypes.FilterSpec	filter
	)

Returns information about all counter metadata records for 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.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if Counter could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

cid	Counter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
filter	Filter specification. When null no filtering will be performed.

Returns:

List of counter metadata for the specified counter.

Implemented in vmware::vstats::CounterMetadataStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vstats.CounterMetadataTypes.Info> > vmware::vstats::CounterMetadata::ListAsync	(	string	cid,
		vmware.vstats.CounterMetadataTypes.FilterSpec	filter
	)

Returns information about all counter metadata records for 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.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if Counter could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

cid	Counter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
filter	Filter specification. When null no filtering will be performed.

Returns:

List of counter metadata for the specified counter.

Implemented in vmware::vstats::CounterMetadataStub.

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

Returns information about all counter metadata records for 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.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if Counter could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

cid	Counter ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter .
filter	Filter specification. When null no filtering will be performed.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

List of counter metadata for the specified counter.

Implemented in vmware::vstats::CounterMetadataStub.

---

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

• CounterMetadata.cs