com.vmware.vcenter.namespace_management.stats

Interface TimeSeries

All Superinterfaces:

Service, TimeSeriesTypes

All Known Implementing Classes:

TimeSeriesStub

public interface TimeSeries
extends Service, TimeSeriesTypes

The TimeSeries interface provides methods to gather statistical values for clusters, namespaces and pods.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespace_management.stats.TimeSeriesTypes

TimeSeriesTypes.PodIdentifier, TimeSeriesTypes.Spec, TimeSeriesTypes.TimeSeries

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.stats.TimeSeriesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.util.List<TimeSeriesTypes.TimeSeries>	get(TimeSeriesTypes.Spec spec) Gather statistical values for a cluster, namespace, or pod.
void	get(TimeSeriesTypes.Spec spec, AsyncCallback<java.util.List<TimeSeriesTypes.TimeSeries>> asyncCallback) Gather statistical values for a cluster, namespace, or pod.
void	get(TimeSeriesTypes.Spec spec, AsyncCallback<java.util.List<TimeSeriesTypes.TimeSeries>> asyncCallback, InvocationConfig invocationConfig) Gather statistical values for a cluster, namespace, or pod.
java.util.List<TimeSeriesTypes.TimeSeries>	get(TimeSeriesTypes.Spec spec, InvocationConfig invocationConfig) Gather statistical values for a cluster, namespace, or pod.

Method Detail

get

java.util.List<TimeSeriesTypes.TimeSeries> get(TimeSeriesTypes.Spec spec)

Gather statistical values for a cluster, namespace, or pod.

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

Parameters:

spec - Specification of the statistical values that should be returned.

Returns:

A list of TimeSeries values for each counter specified in the request.

Throws:

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

InvalidArgument - if the start time in TimeSeriesTypes.Spec.getStart() is invalid, or the end time in TimeSeriesTypes.Spec.getEnd() is invalid.

NotFound - if the specified cluster in TimeSeriesTypes.Spec.getCluster() or the namespace in TimeSeriesTypes.Spec.getNamespace() or TimeSeriesTypes.Spec.getPod() does not exist.

Unsupported - if the specified cluster in TimeSeriesTypes.Spec.getCluster() is not enabled for Namespaces.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

java.util.List<TimeSeriesTypes.TimeSeries> get(TimeSeriesTypes.Spec spec,
                                               InvocationConfig invocationConfig)

Gather statistical values for a cluster, namespace, or pod.

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:

spec - Specification of the statistical values that should be returned.

invocationConfig - Configuration for the method invocation.

Returns:

A list of TimeSeries values for each counter specified in the request.

Throws:

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

InvalidArgument - if the start time in TimeSeriesTypes.Spec.getStart() is invalid, or the end time in TimeSeriesTypes.Spec.getEnd() is invalid.

NotFound - if the specified cluster in TimeSeriesTypes.Spec.getCluster() or the namespace in TimeSeriesTypes.Spec.getNamespace() or TimeSeriesTypes.Spec.getPod() does not exist.

Unsupported - if the specified cluster in TimeSeriesTypes.Spec.getCluster() is not enabled for Namespaces.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

void get(TimeSeriesTypes.Spec spec,
         AsyncCallback<java.util.List<TimeSeriesTypes.TimeSeries>> asyncCallback)

Gather statistical values for a cluster, namespace, or pod.

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

Invocation Result:
A list of TimeSeries values for each counter specified in the request.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the start time in TimeSeriesTypes.Spec.getStart() is invalid, or the end time in TimeSeriesTypes.Spec.getEnd() is invalid.
NotFound - if the specified cluster in TimeSeriesTypes.Spec.getCluster() or the namespace in TimeSeriesTypes.Spec.getNamespace() or TimeSeriesTypes.Spec.getPod() does not exist.
Unsupported - if the specified cluster in TimeSeriesTypes.Spec.getCluster() is not enabled for Namespaces.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

spec - Specification of the statistical values that should be returned.

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

get

void get(TimeSeriesTypes.Spec spec,
         AsyncCallback<java.util.List<TimeSeriesTypes.TimeSeries>> asyncCallback,
         InvocationConfig invocationConfig)

Gather statistical values for a cluster, namespace, or pod.

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:
A list of TimeSeries values for each counter specified in the request.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the start time in TimeSeriesTypes.Spec.getStart() is invalid, or the end time in TimeSeriesTypes.Spec.getEnd() is invalid.
NotFound - if the specified cluster in TimeSeriesTypes.Spec.getCluster() or the namespace in TimeSeriesTypes.Spec.getNamespace() or TimeSeriesTypes.Spec.getPod() does not exist.
Unsupported - if the specified cluster in TimeSeriesTypes.Spec.getCluster() is not enabled for Namespaces.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

spec - Specification of the statistical values that should be returned.

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

invocationConfig - Configuration for the method invocation.