com.vmware.vstats

Interface Data

All Superinterfaces:

DataTypes, Service

All Known Implementing Classes:

DataStub

public interface Data
extends Service, DataTypes

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.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vstats.DataTypes

DataTypes.DataPoint, DataTypes.DataPointsResult, DataTypes.FilterSpec

Field Summary

Fields inherited from interface com.vmware.vstats.DataTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
DataTypes.DataPointsResult	queryDataPoints(DataTypes.FilterSpec filter) Returns DataTypes.DataPointsResult matching the filter parameters.
void	queryDataPoints(DataTypes.FilterSpec filter, AsyncCallback<DataTypes.DataPointsResult> asyncCallback) Returns DataTypes.DataPointsResult matching the filter parameters.
void	queryDataPoints(DataTypes.FilterSpec filter, AsyncCallback<DataTypes.DataPointsResult> asyncCallback, InvocationConfig invocationConfig) Returns DataTypes.DataPointsResult matching the filter parameters.
DataTypes.DataPointsResult	queryDataPoints(DataTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns DataTypes.DataPointsResult matching the filter parameters.

Method Detail

queryDataPoints

DataTypes.DataPointsResult queryDataPoints(DataTypes.FilterSpec filter)

Returns DataTypes.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.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

filter - Specification to match DataPoints. When Set filtering will be applied to the result.

Returns:

Data points matching the filter.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if any of the specified parameters are invalid.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

queryDataPoints

DataTypes.DataPointsResult queryDataPoints(DataTypes.FilterSpec filter,
                                           InvocationConfig invocationConfig)

Returns DataTypes.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.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

filter - Specification to match DataPoints. When Set filtering will be applied to the result.

invocationConfig - Configuration for the method invocation.

Returns:

Data points matching the filter.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if any of the specified parameters are invalid.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

queryDataPoints

void queryDataPoints(DataTypes.FilterSpec filter,
                     AsyncCallback<DataTypes.DataPointsResult> asyncCallback)

Returns DataTypes.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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Data points matching the filter.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if any of the specified parameters are invalid.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have sufficient privileges.

Parameters:

filter - Specification to match DataPoints. When Set filtering will be applied to the result.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

queryDataPoints

void queryDataPoints(DataTypes.FilterSpec filter,
                     AsyncCallback<DataTypes.DataPointsResult> asyncCallback,
                     InvocationConfig invocationConfig)

Returns DataTypes.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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Data points matching the filter.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if any of the specified parameters are invalid.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have sufficient privileges.

Parameters:

filter - Specification to match DataPoints. When Set filtering will be applied to the result.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.