com.vmware.vstats

Class MetricsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vstats.MetricsStub

All Implemented Interfaces:

Service, Metrics, MetricsTypes

public class MetricsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Metrics

Remote stub implementation of the Metrics API service.

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

Nested Class Summary

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

MetricsTypes.Summary

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.vstats.MetricsTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Constructor Summary

Constructors

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

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.

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

MetricsStub

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

MetricsStub

public MetricsStub(ApiProvider apiProvider,
                   StubConfigurationBase config)

Method Detail

list

public java.util.List<MetricsTypes.Summary> list()

Description copied from interface: Metrics

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.

Specified by:

list in interface Metrics

Returns:

List of Metrics.

list

public java.util.List<MetricsTypes.Summary> list(InvocationConfig invocationConfig)

Description copied from interface: Metrics

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.

Specified by:

list in interface Metrics

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

List of Metrics.

list

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

Description copied from interface: Metrics

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.

Specified by:

list in interface Metrics

Parameters:

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

list

public void list(AsyncCallback<java.util.List<MetricsTypes.Summary>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Metrics

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.

Specified by:

list in interface Metrics

Parameters:

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

invocationConfig - Configuration for the method invocation.