com.vmware.vstats

Interface CounterMetadata

All Superinterfaces:

CounterMetadataTypes, Service

All Known Implementing Classes:

CounterMetadataStub

public interface CounterMetadata
extends Service, CounterMetadataTypes

The CounterMetadata interface provides access to the different historical editions of counters. As computing platforms evolve over time the measurement units for different characteristics of the systems change. As such changes occur, counters will receive different editions reflected in a new metadata record. For example computer memory had changes from kilobytes through megabytes into gigabytes. 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.CounterMetadataTypes

CounterMetadataTypes.CounterEditionStatus, CounterMetadataTypes.FilterSpec, CounterMetadataTypes.Info, CounterMetadataTypes.MetricUnits, CounterMetadataTypes.SampleType, CounterMetadataTypes.UnitsFactor

Field Summary

Fields inherited from interface com.vmware.vstats.CounterMetadataTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
CounterMetadataTypes.Info	get(java.lang.String cid, java.lang.String mid) Returns information about a specific CounterMetadata.
void	get(java.lang.String cid, java.lang.String mid, AsyncCallback<CounterMetadataTypes.Info> asyncCallback) Returns information about a specific CounterMetadata.
void	get(java.lang.String cid, java.lang.String mid, AsyncCallback<CounterMetadataTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a specific CounterMetadata.
CounterMetadataTypes.Info	get(java.lang.String cid, java.lang.String mid, InvocationConfig invocationConfig) Returns information about a specific CounterMetadata.
java.util.List<CounterMetadataTypes.Info>	getDefault(java.lang.String cid) This method returns the "default" CounterMetadata.
void	getDefault(java.lang.String cid, AsyncCallback<java.util.List<CounterMetadataTypes.Info>> asyncCallback) This method returns the "default" CounterMetadata.
void	getDefault(java.lang.String cid, AsyncCallback<java.util.List<CounterMetadataTypes.Info>> asyncCallback, InvocationConfig invocationConfig) This method returns the "default" CounterMetadata.
java.util.List<CounterMetadataTypes.Info>	getDefault(java.lang.String cid, InvocationConfig invocationConfig) This method returns the "default" CounterMetadata.
java.util.List<CounterMetadataTypes.Info>	list(java.lang.String cid, CounterMetadataTypes.FilterSpec filter) Returns information about all counter metadata records for a specific Counter.
void	list(java.lang.String cid, CounterMetadataTypes.FilterSpec filter, AsyncCallback<java.util.List<CounterMetadataTypes.Info>> asyncCallback) Returns information about all counter metadata records for a specific Counter.
void	list(java.lang.String cid, CounterMetadataTypes.FilterSpec filter, AsyncCallback<java.util.List<CounterMetadataTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Returns information about all counter metadata records for a specific Counter.
java.util.List<CounterMetadataTypes.Info>	list(java.lang.String cid, CounterMetadataTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about all counter metadata records for a specific Counter.

Method Detail

list

java.util.List<CounterMetadataTypes.Info> list(java.lang.String cid,
                                               CounterMetadataTypes.FilterSpec filter)

Returns information about all counter metadata records for 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.

filter - Filter specification. When null no filtering will be performed.

Returns:

List of counter metadata for the specified counter.

Throws:

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

InvalidArgument - if any of the specified parameters are 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.

list

java.util.List<CounterMetadataTypes.Info> list(java.lang.String cid,
                                               CounterMetadataTypes.FilterSpec filter,
                                               InvocationConfig invocationConfig)

Returns information about all counter metadata records for 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.

filter - Filter specification. When null no filtering will be performed.

invocationConfig - Configuration for the method invocation.

Returns:

List of counter metadata for the specified counter.

Throws:

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

InvalidArgument - if any of the specified parameters are 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.

list

void list(java.lang.String cid,
          CounterMetadataTypes.FilterSpec filter,
          AsyncCallback<java.util.List<CounterMetadataTypes.Info>> asyncCallback)

Returns information about all counter metadata records for 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:
List of counter metadata for the specified counter.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if any of the specified parameters are 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.

filter - Filter specification. When null no filtering will be performed.

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

list

void list(java.lang.String cid,
          CounterMetadataTypes.FilterSpec filter,
          AsyncCallback<java.util.List<CounterMetadataTypes.Info>> asyncCallback,
          InvocationConfig invocationConfig)

Returns information about all counter metadata records for 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:
List of counter metadata for the specified counter.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if any of the specified parameters are 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.

filter - Filter specification. When null no filtering will be performed.

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

invocationConfig - Configuration for the method invocation.

getDefault

java.util.List<CounterMetadataTypes.Info> getDefault(java.lang.String cid)

This method returns the "default" CounterMetadata. A Counter has at least one related metadata object. Usually, stats providers (for example hosts) are in agreement about the default metadata. In this case the returned list has a single metadata object.

Sometimes, when providers are in "disagreement" about the default, then the returned list would include all the possible "defaults". This potential ambiguity isn't a real issue because consumers of the vStats API rarely need to specify the "mid" of metadata. Therefore, this API is used primarily for informational purposes.

. 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:

List of counter metadata records.

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.

getDefault

java.util.List<CounterMetadataTypes.Info> getDefault(java.lang.String cid,
                                                     InvocationConfig invocationConfig)

This method returns the "default" CounterMetadata. A Counter has at least one related metadata object. Usually, stats providers (for example hosts) are in agreement about the default metadata. In this case the returned list has a single metadata object.

Sometimes, when providers are in "disagreement" about the default, then the returned list would include all the possible "defaults". This potential ambiguity isn't a real issue because consumers of the vStats API rarely need to specify the "mid" of metadata. Therefore, this API is used primarily for informational purposes.

. 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:

List of counter metadata records.

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.

getDefault

void getDefault(java.lang.String cid,
                AsyncCallback<java.util.List<CounterMetadataTypes.Info>> asyncCallback)

This method returns the "default" CounterMetadata. A Counter has at least one related metadata object. Usually, stats providers (for example hosts) are in agreement about the default metadata. In this case the returned list has a single metadata object.

Sometimes, when providers are in "disagreement" about the default, then the returned list would include all the possible "defaults". This potential ambiguity isn't a real issue because consumers of the vStats API rarely need to specify the "mid" of metadata. Therefore, this API is used primarily for informational purposes.

. 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 metadata records.

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.

getDefault

void getDefault(java.lang.String cid,
                AsyncCallback<java.util.List<CounterMetadataTypes.Info>> asyncCallback,
                InvocationConfig invocationConfig)

This method returns the "default" CounterMetadata. A Counter has at least one related metadata object. Usually, stats providers (for example hosts) are in agreement about the default metadata. In this case the returned list has a single metadata object.

Sometimes, when providers are in "disagreement" about the default, then the returned list would include all the possible "defaults". This potential ambiguity isn't a real issue because consumers of the vStats API rarely need to specify the "mid" of metadata. Therefore, this API is used primarily for informational purposes.

. 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 metadata records.

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.

get

CounterMetadataTypes.Info get(java.lang.String cid,
                              java.lang.String mid)

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

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

Returns:

Information about the desired CounterMetadata.

Throws:

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

InvalidArgument - if any of the specified parameters are invalid.

NotFound - if Counter or CounterMetadata could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

get

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

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

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

invocationConfig - Configuration for the method invocation.

Returns:

Information about the desired CounterMetadata.

Throws:

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

InvalidArgument - if any of the specified parameters are invalid.

NotFound - if Counter or CounterMetadata 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,
         java.lang.String mid,
         AsyncCallback<CounterMetadataTypes.Info> asyncCallback)

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

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if any of the specified parameters are invalid.
NotFound - if Counter or CounterMetadata 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.

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

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

get

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

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

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if any of the specified parameters are invalid.
NotFound - if Counter or CounterMetadata 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.

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

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

invocationConfig - Configuration for the method invocation.