com.vmware.vstats

Interface Metrics

All Superinterfaces:

MetricsTypes, Service

All Known Implementing Classes:

MetricsStub

public interface Metrics
extends Service, MetricsTypes

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.

Nested Class Summary

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

MetricsTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vstats.MetricsTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.util.List<MetricsTypes.Summary>	list() Returns list of available Metrics as supplied by the discovered providers.
void	list(AsyncCallback<java.util.List<MetricsTypes.Summary>> asyncCallback) Returns list of available Metrics as supplied by the discovered providers.
void	list(AsyncCallback<java.util.List<MetricsTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns list of available Metrics as supplied by the discovered providers.
java.util.List<MetricsTypes.Summary>	list(InvocationConfig invocationConfig) Returns list of available Metrics as supplied by the discovered providers.

Method Detail

list

java.util.List<MetricsTypes.Summary> 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.

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

Returns:

List of Metrics.

Throws:

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

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

list

java.util.List<MetricsTypes.Summary> list(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.

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:

invocationConfig - Configuration for the method invocation.

Returns:

List of Metrics.

Throws:

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

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

list

void list(AsyncCallback<java.util.List<MetricsTypes.Summary>> asyncCallback)

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.

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

Invocation Result:
List of Metrics.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have sufficient privileges.

Parameters:

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

list

void list(AsyncCallback<java.util.List<MetricsTypes.Summary>> asyncCallback,
          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.

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:
List of Metrics.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have sufficient privileges.

Parameters:

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

invocationConfig - Configuration for the method invocation.