com.vmware.vstats

Class CounterMetadataTypes.Info

java.lang.Object

com.vmware.vstats.CounterMetadataTypes.Info

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

Enclosing interface:

CounterMetadataTypes

public static final class CounterMetadataTypes.Info
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The Info class contains information about CounterMetadata. It represents edition of the Counter. Warning: This class 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 Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CounterMetadataTypes.Info.Builder Builder class for CounterMetadataTypes.Info.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	Info() Default constructor.
protected	Info(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
static java.lang.String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal method, subject to change in future versions.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static CounterMetadataTypes.Info	_newInstance(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
static CounterMetadataTypes.Info	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
java.lang.String	getCid() Counter Id.
java.lang.String	getMid() Metadata Id.
java.lang.String	getPid() ID of the respective provider.
CounterMetadataTypes.UnitsFactor	getScale() Additional multiplier factors to be used with units.
CounterMetadataTypes.CounterEditionStatus	getStatus() Counter Edition status.
CounterMetadataTypes.SampleType	getType() Numeric properties of the sampled data.
CounterMetadataTypes.MetricUnits	getUnits() The units of the measurement.
UserInfo	getUserInfo() Human legible localizable text about the counter.
int	hashCode()
void	setCid(java.lang.String cid) Counter Id.
void	setMid(java.lang.String mid) Metadata Id.
void	setPid(java.lang.String pid) ID of the respective provider.
void	setScale(CounterMetadataTypes.UnitsFactor scale) Additional multiplier factors to be used with units.
void	setStatus(CounterMetadataTypes.CounterEditionStatus status) Counter Edition status.
void	setType(CounterMetadataTypes.SampleType type) Numeric properties of the sampled data.
void	setUnits(CounterMetadataTypes.MetricUnits units) The units of the measurement.
void	setUserInfo(UserInfo userInfo) Human legible localizable text about the counter.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

Info

public Info()

Default constructor.

Info

protected Info(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Detail

getCid

public java.lang.String getCid()

Counter Id. Warning: This property 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.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Counter. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vstats.model.Counter.

setCid

public void setCid(java.lang.String cid)

Counter Id. Warning: This property 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.

Parameters:

cid - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Counter. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vstats.model.Counter.

getMid

public java.lang.String getMid()

Metadata Id. Warning: This property 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.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.CounterMetadata. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vstats.model.CounterMetadata.

setMid

public void setMid(java.lang.String mid)

Metadata Id. Warning: This property 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.

Parameters:

mid - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.CounterMetadata. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vstats.model.CounterMetadata.

getStatus

public CounterMetadataTypes.CounterEditionStatus getStatus()

Counter Edition status. Warning: This property 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.

Returns:

The current value of the property.

setStatus

public void setStatus(CounterMetadataTypes.CounterEditionStatus status)

Counter Edition status. Warning: This property 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.

Parameters:

status - New value for the property.

getType

public CounterMetadataTypes.SampleType getType()

Numeric properties of the sampled data. Warning: This property 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.

Returns:

The current value of the property.

setType

public void setType(CounterMetadataTypes.SampleType type)

Numeric properties of the sampled data. Warning: This property 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.

Parameters:

type - New value for the property.

getUnits

public CounterMetadataTypes.MetricUnits getUnits()

The units of the measurement. Warning: This property 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.

Returns:

The current value of the property.

setUnits

public void setUnits(CounterMetadataTypes.MetricUnits units)

The units of the measurement. Warning: This property 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.

Parameters:

units - New value for the property.

getScale

public CounterMetadataTypes.UnitsFactor getScale()

Additional multiplier factors to be used with units. Warning: This property 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. When null default of ONE is used.

Returns:

The current value of the property.

setScale

public void setScale(CounterMetadataTypes.UnitsFactor scale)

Additional multiplier factors to be used with units. Warning: This property 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. When null default of ONE is used.

Parameters:

scale - New value for the property.

getUserInfo

public UserInfo getUserInfo()

Human legible localizable text about the counter. Warning: This property 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. This property is null in the current version.

Returns:

The current value of the property.

setUserInfo

public void setUserInfo(UserInfo userInfo)

Human legible localizable text about the counter. Warning: This property 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. This property is null in the current version.

Parameters:

userInfo - New value for the property.

getPid

public java.lang.String getPid()

ID of the respective provider. Warning: This property 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. This property is null in the current version.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Provider. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vstats.model.Provider.

setPid

public void setPid(java.lang.String pid)

ID of the respective provider. Warning: This property 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. This property is null in the current version.

Parameters:

pid - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Provider. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vstats.model.Provider.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface com.vmware.vapi.bindings.StaticStructure

Overrides:

toString in class java.lang.Object

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

_getClassType

public static com.vmware.vapi.bindings.type.StructType _getClassType()

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

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public java.lang.String _getCanonicalName()

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static CounterMetadataTypes.Info _newInstance(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2

public static CounterMetadataTypes.Info _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.