com.vmware.vstats

Class CounterMetadataTypes.SampleType

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<CounterMetadataTypes.SampleType>

com.vmware.vstats.CounterMetadataTypes.SampleType

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CounterMetadataTypes

public static final class CounterMetadataTypes.SampleType
extends ApiEnumeration<CounterMetadataTypes.SampleType>

Type of the sampled data. Warning: This enumeration 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.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CounterMetadataTypes.SampleType.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static CounterMetadataTypes.SampleType	ABSOLUTE Absolute value samples.
static CounterMetadataTypes.SampleType	DELTA Delta samples.
static CounterMetadataTypes.SampleType	FRACTION Fraction samples.
static CounterMetadataTypes.SampleType	LOGN Log(n) samples.
static CounterMetadataTypes.SampleType	RATE Rate samples.
static CounterMetadataTypes.SampleType	RAW Raw samples.

Method Summary

Modifier and Type	Method and Description
CounterMetadataTypes.SampleType.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static CounterMetadataTypes.SampleType	valueOf(java.lang.String name) Returns the enumeration constant for the specified name.
static CounterMetadataTypes.SampleType[]	values() Retrieve all enumeration constants pre-defined by this enumeration class.

Methods inherited from class com.vmware.vapi.bindings.ApiEnumeration

buildNameMap, equals, hashCode, name, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RAW

public static final CounterMetadataTypes.SampleType RAW

Raw samples. The value unprocessed as-is sampled. Warning: This constant field 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.

ABSOLUTE

public static final CounterMetadataTypes.SampleType ABSOLUTE

Absolute value samples. Represents an actual value of the counter. Warning: This constant field 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.

FRACTION

public static final CounterMetadataTypes.SampleType FRACTION

Fraction samples. Implies range from 0.00 to 1.00. Warning: This constant field 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.

RATE

public static final CounterMetadataTypes.SampleType RATE

Rate samples. Represents a value that has been normalized over the time period. Warning: This constant field 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.

DELTA

public static final CounterMetadataTypes.SampleType DELTA

Delta samples. Represents an amount of change for the counter between the current time-stamp and the last time-stamp when the counter was sampled. Warning: This constant field 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.

LOGN

public static final CounterMetadataTypes.SampleType LOGN

Log(n) samples. A natural logarithm of the value. Warning: This constant field 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.

Method Detail

values

public static CounterMetadataTypes.SampleType[] values()

Retrieve all enumeration constants pre-defined by this enumeration class.

Additional instances might exist at runtime, for example to represent a new constant added to this enumeration class in subsequent version of the API. Such new constant is represented as instance of CounterMetadataTypes.SampleType but is not pre-defined.

Returns:

Array of all pre-defined enumeration constants. Never null.

valueOf

public static CounterMetadataTypes.SampleType valueOf(java.lang.String name)

Returns the enumeration constant for the specified name.

If the name matches exactly the identifier used to declare an enumeration constant from this enumeration class, the constant in question will be returned.

Otherwise, a new instance of CounterMetadataTypes.SampleType will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the CounterMetadataTypes.SampleType.Values._UNKNOWN enum constant from the native Java enum.

Parameters:

name - The name of the constant to return. Must not be null.

Returns:

Enumeration constant for the specified name. Never null.

isUnknown

public boolean isUnknown()

Checks if this enumeration constant is unknown. Unknown is a constant that is not one of the pre-defined ones for this enumeration class. Also see valueOf(java.lang.String) and values().

Returns:

true if this constant is unknown, and false otherwise.

getEnumValue

public CounterMetadataTypes.SampleType.Values getEnumValue()

Returns a native Java enum constant representing this enumeration constant. The result is useful for usual handling of Java enum, for example it can be used in switch statements.

If this enumeration constant is unknown, then CounterMetadataTypes.SampleType.Values._UNKNOWN enum constant is returned.

The native Java enum is CounterMetadataTypes.SampleType.Values.

Returns:

The Java enum constant. Never null.