vmware::vstats::Data Interface Reference

The Data interface provides methods to query measurement and statistic data. More...

Inherited by vmware::vstats::DataStub.

List of all members.

Public Member Functions
vmware.vstats.DataTypes.DataPointsResult	QueryDataPoints (vmware.vstats.DataTypes.FilterSpec filter)
	Returns Data.DataPointsResult matching the filter parameters.
vmware.vstats.DataTypes.DataPointsResult	QueryDataPoints (vmware.vstats.DataTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns Data.DataPointsResult matching the filter parameters.
global::System.Threading.Tasks.Task < vmware.vstats.DataTypes.DataPointsResult >	QueryDataPointsAsync (vmware.vstats.DataTypes.FilterSpec filter)
	Returns Data.DataPointsResult matching the filter parameters.
global::System.Threading.Tasks.Task < vmware.vstats.DataTypes.DataPointsResult >	QueryDataPointsAsync (vmware.vstats.DataTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns Data.DataPointsResult matching the filter parameters.

---

Detailed Description

The Data interface provides methods to query measurement and statistic data.

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.DataTypes.DataPointsResult vmware::vstats::Data::QueryDataPoints

(

vmware.vstats.DataTypes.FilterSpec

filter

)

Returns Data.DataPointsResult matching the filter parameters.

/vstats/data/dp?types=VM&types=VCPU

/vstats/data/dp?rsrcs=type.HOST=host-16&rsrcs=type.VM=vm-31 . 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.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

filter

Specification to match DataPoints. When set filtering will be applied to the result.

Returns:

Data points matching the filter.

Implemented in vmware::vstats::DataStub.

vmware.vstats.DataTypes.DataPointsResult vmware::vstats::Data::QueryDataPoints	(	vmware.vstats.DataTypes.FilterSpec	filter,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns Data.DataPointsResult matching the filter parameters.

/vstats/data/dp?types=VM&types=VCPU

/vstats/data/dp?rsrcs=type.HOST=host-16&rsrcs=type.VM=vm-31 . 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.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

filter	Specification to match DataPoints. When set filtering will be applied to the result.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Data points matching the filter.

Implemented in vmware::vstats::DataStub.

global::System.Threading.Tasks.Task<vmware.vstats.DataTypes.DataPointsResult> vmware::vstats::Data::QueryDataPointsAsync

(

vmware.vstats.DataTypes.FilterSpec

filter

)

Returns Data.DataPointsResult matching the filter parameters.

/vstats/data/dp?types=VM&types=VCPU

/vstats/data/dp?rsrcs=type.HOST=host-16&rsrcs=type.VM=vm-31 . 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.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

filter

Specification to match DataPoints. When set filtering will be applied to the result.

Returns:

Data points matching the filter.

Implemented in vmware::vstats::DataStub.

global::System.Threading.Tasks.Task<vmware.vstats.DataTypes.DataPointsResult> vmware::vstats::Data::QueryDataPointsAsync	(	vmware.vstats.DataTypes.FilterSpec	filter,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns Data.DataPointsResult matching the filter parameters.

/vstats/data/dp?types=VM&types=VCPU

/vstats/data/dp?rsrcs=type.HOST=host-16&rsrcs=type.VM=vm-31 . 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.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have sufficient privileges.

Parameters:

filter	Specification to match DataPoints. When set filtering will be applied to the result.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Data points matching the filter.

Implemented in vmware::vstats::DataStub.

---

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

• Data.cs