com.vmware.vstats

Interface Counters

All Superinterfaces:

CountersTypes, Service

All Known Implementing Classes:

CountersStub

public interface Counters
extends Service, CountersTypes

The Counters interface provides methods to perform various Counter related operations. Counter is derived from metric. It applies the metric to a particular class of a resource. 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.CountersTypes

CountersTypes.FilterSpec, CountersTypes.Info

Field Summary

Fields inherited from interface com.vmware.vstats.CountersTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
CountersTypes.Info	get(java.lang.String cid) Returns information about a specific Counter.
void	get(java.lang.String cid, AsyncCallback<CountersTypes.Info> asyncCallback) Returns information about a specific Counter.
void	get(java.lang.String cid, AsyncCallback<CountersTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a specific Counter.
CountersTypes.Info	get(java.lang.String cid, InvocationConfig invocationConfig) Returns information about a specific Counter.
java.util.List<CountersTypes.Info>	list(CountersTypes.FilterSpec filter) Returns information about all counters matching the filter parameters.
void	list(CountersTypes.FilterSpec filter, AsyncCallback<java.util.List<CountersTypes.Info>> asyncCallback) Returns information about all counters matching the filter parameters.
void	list(CountersTypes.FilterSpec filter, AsyncCallback<java.util.List<CountersTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Returns information about all counters matching the filter parameters.
java.util.List<CountersTypes.Info>	list(CountersTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about all counters matching the filter parameters.

Method Detail

list

java.util.List<CountersTypes.Info> list(CountersTypes.FilterSpec filter)

Returns information about all counters matching the filter parameters. 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 - Filters the returned records. When null no filtering will be applied.

Returns:

List of Counters.

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.

list

java.util.List<CountersTypes.Info> list(CountersTypes.FilterSpec filter,
                                        InvocationConfig invocationConfig)

Returns information about all counters matching the filter parameters. 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 - Filters the returned records. When null no filtering will be applied.

invocationConfig - Configuration for the method invocation.

Returns:

List of Counters.

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.

list

void list(CountersTypes.FilterSpec filter,
          AsyncCallback<java.util.List<CountersTypes.Info>> asyncCallback)

Returns information about all counters matching the filter parameters. 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 Counters.

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 - Filters the returned records. When null no filtering will be applied.

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

list

void list(CountersTypes.FilterSpec filter,
          AsyncCallback<java.util.List<CountersTypes.Info>> asyncCallback,
          InvocationConfig invocationConfig)

Returns information about all counters matching the filter parameters. 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 Counters.

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 - Filters the returned records. When null no filtering will be applied.

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

invocationConfig - Configuration for the method invocation.

get

CountersTypes.Info get(java.lang.String cid)

Returns information about 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.

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

Parameters:

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

Returns:

Information about the requested counter.

Throws:

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

InvalidArgument - if cid is invalid.

NotFound - if Counter could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

get

CountersTypes.Info get(java.lang.String cid,
                       InvocationConfig invocationConfig)

Returns information about 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.

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:

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

invocationConfig - Configuration for the method invocation.

Returns:

Information about the requested counter.

Throws:

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

InvalidArgument - if cid is invalid.

NotFound - if Counter 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 cid,
         AsyncCallback<CountersTypes.Info> asyncCallback)

Returns information about 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.

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

Invocation Result:
Information about the requested counter.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if cid is invalid.
NotFound - if Counter could not be located.
Unauthenticated - if the user can not be authenticated.
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.

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

get

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

Returns information about 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.

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 requested counter.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if cid is invalid.
NotFound - if Counter could not be located.
Unauthenticated - if the user can not be authenticated.
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.

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

invocationConfig - Configuration for the method invocation.