com.vmware.vstats

Interface CounterSets

All Superinterfaces:

CounterSetsTypes, Service

All Known Implementing Classes:

CounterSetsStub

public interface CounterSets
extends Service, CounterSetsTypes

The CounterSets interface provides methods for accessing groupings of counters. Counter-sets allow consumers to use groups of counters. The counters may relate to different resource types. When an AcqSpecs record refers to a counter-set, only the relevant counters apply. 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.CounterSetsTypes

CounterSetsTypes.Info

Field Summary

Fields inherited from interface com.vmware.vstats.CounterSetsTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
CounterSetsTypes.Info	get(java.lang.String counterSet) Returns information about a specific counter set.
void	get(java.lang.String counterSet, AsyncCallback<CounterSetsTypes.Info> asyncCallback) Returns information about a specific counter set.
void	get(java.lang.String counterSet, AsyncCallback<CounterSetsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a specific counter set.
CounterSetsTypes.Info	get(java.lang.String counterSet, InvocationConfig invocationConfig) Returns information about a specific counter set.
java.util.List<CounterSetsTypes.Info>	list() Returns information about all the counter sets.
void	list(AsyncCallback<java.util.List<CounterSetsTypes.Info>> asyncCallback) Returns information about all the counter sets.
void	list(AsyncCallback<java.util.List<CounterSetsTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Returns information about all the counter sets.
java.util.List<CounterSetsTypes.Info>	list(InvocationConfig invocationConfig) Returns information about all the counter sets.

Method Detail

list

java.util.List<CounterSetsTypes.Info> list()

Returns information about all the counter sets. 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 counter sets.

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<CounterSetsTypes.Info> list(InvocationConfig invocationConfig)

Returns information about all the counter sets. 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 counter sets.

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<CounterSetsTypes.Info>> asyncCallback)

Returns information about all the counter sets. 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 counter sets.

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<CounterSetsTypes.Info>> asyncCallback,
          InvocationConfig invocationConfig)

Returns information about all the counter sets. 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 counter sets.

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.

get

CounterSetsTypes.Info get(java.lang.String counterSet)

Returns information about a specific counter set. 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:

counterSet - identifier of the counter set to retrieve. The parameter must be an identifier for the resource type: com.vmware.vstats.model.CounterSet.

Returns:

Information about the desired CounterSet.

Throws:

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

InvalidArgument - if counterSet is invalid.

NotFound - if the requested counter set could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

get

CounterSetsTypes.Info get(java.lang.String counterSet,
                          InvocationConfig invocationConfig)

Returns information about a specific counter set. 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:

counterSet - identifier of the counter set to retrieve. The parameter must be an identifier for the resource type: com.vmware.vstats.model.CounterSet.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the desired CounterSet.

Throws:

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

InvalidArgument - if counterSet is invalid.

NotFound - if the requested counter set could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

get

void get(java.lang.String counterSet,
         AsyncCallback<CounterSetsTypes.Info> asyncCallback)

Returns information about a specific counter set. 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:
Information about the desired CounterSet.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if counterSet is invalid.
NotFound - if the requested counter set could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have sufficient privileges.

Parameters:

counterSet - identifier of the counter set to retrieve. The parameter must be an identifier for the resource type: com.vmware.vstats.model.CounterSet.

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

get

void get(java.lang.String counterSet,
         AsyncCallback<CounterSetsTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns information about a specific counter set. 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:
Information about the desired CounterSet.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if counterSet is invalid.
NotFound - if the requested counter set could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have sufficient privileges.

Parameters:

counterSet - identifier of the counter set to retrieve. The parameter must be an identifier for the resource type: com.vmware.vstats.model.CounterSet.

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

invocationConfig - Configuration for the method invocation.