com.vmware.vstats

Class CounterMetadataStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vstats.CounterMetadataStub

All Implemented Interfaces:

Service, CounterMetadata, CounterMetadataTypes

public class CounterMetadataStub
extends com.vmware.vapi.internal.bindings.Stub
implements CounterMetadata

Remote stub implementation of the CounterMetadata API service.

WARNING: Internal class, subject to change in future versions.

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 class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.vstats.CounterMetadataTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
CounterMetadataStub(ApiProvider apiProvider, StubConfigurationBase config)
CounterMetadataStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

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.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CounterMetadataStub

public CounterMetadataStub(ApiProvider apiProvider,
                           com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                           StubConfigurationBase config)

CounterMetadataStub

public CounterMetadataStub(ApiProvider apiProvider,
                           StubConfigurationBase config)

Method Detail

list

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

Description copied from interface: CounterMetadata

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.

Specified by:

list in interface CounterMetadata

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.

list

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

Description copied from interface: CounterMetadata

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.

Specified by:

list in interface CounterMetadata

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.

list

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

Description copied from interface: CounterMetadata

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.

Specified by:

list in interface CounterMetadata

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

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

Description copied from interface: CounterMetadata

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.

Specified by:

list in interface CounterMetadata

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

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

Description copied from interface: CounterMetadata

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.

Specified by:

getDefault in interface CounterMetadata

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.

getDefault

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

Description copied from interface: CounterMetadata

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.

Specified by:

getDefault in interface CounterMetadata

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.

getDefault

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

Description copied from interface: CounterMetadata

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.

Specified by:

getDefault in interface CounterMetadata

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

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

Description copied from interface: CounterMetadata

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.

Specified by:

getDefault in interface CounterMetadata

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

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

Description copied from interface: CounterMetadata

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.

Specified by:

get in interface CounterMetadata

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.

get

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

Description copied from interface: CounterMetadata

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.

Specified by:

get in interface CounterMetadata

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.

get

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

Description copied from interface: CounterMetadata

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.

Specified by:

get in interface CounterMetadata

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

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

Description copied from interface: CounterMetadata

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.

Specified by:

get in interface CounterMetadata

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.