com.vmware.vstats

Class AcqSpecsTypes.Info

java.lang.Object

com.vmware.vstats.AcqSpecsTypes.Info

All Implemented Interfaces:

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

Enclosing interface:

AcqSpecsTypes

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

The Info class is the information about an acquisition specification. It specifies the statistical data that should be collected at desired sampling rates. It designates the resources and their counters which should be sampled, and a desired sampling rate. 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	AcqSpecsTypes.Info.Builder Builder class for AcqSpecsTypes.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 AcqSpecsTypes.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 AcqSpecsTypes.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)
AcqSpecsTypes.CounterSpec	getCounters() Designates the counter(s) to be sampled.
java.lang.Long	getExpiration() Expiration time for this acquisition specification represented as Unix UTC number of seconds (since epoch).
java.lang.String	getId() Acquisition specification identifier.
java.lang.Long	getInterval() Desired sampling rate in seconds.
java.lang.String	getMemo_() Consumer provided text about this Acquisition Specification.
java.util.List<RsrcId>	getResources() A set of resource identifiers representing a single resource to be monitored.
AcqSpecsTypes.Status	getStatus() Acquisition Specification status.
int	hashCode()
void	setCounters(AcqSpecsTypes.CounterSpec counters) Designates the counter(s) to be sampled.
void	setExpiration(java.lang.Long expiration) Expiration time for this acquisition specification represented as Unix UTC number of seconds (since epoch).
void	setId(java.lang.String id) Acquisition specification identifier.
void	setInterval(java.lang.Long interval) Desired sampling rate in seconds.
void	setMemo_(java.lang.String memo_) Consumer provided text about this Acquisition Specification.
void	setResources(java.util.List<RsrcId> resources) A set of resource identifiers representing a single resource to be monitored.
void	setStatus(AcqSpecsTypes.Status status) Acquisition Specification status.
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

getId

public java.lang.String getId()

Acquisition specification identifier. 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.AcqSpec. 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.AcqSpec.

setId

public void setId(java.lang.String id)

Acquisition specification identifier. 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:

id - 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.AcqSpec. 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.AcqSpec.

getCounters

public AcqSpecsTypes.CounterSpec getCounters()

Designates the counter(s) to be sampled. 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.

setCounters

public void setCounters(AcqSpecsTypes.CounterSpec counters)

Designates the counter(s) to be sampled. 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:

counters - New value for the property.

getResources

public java.util.List<RsrcId> getResources()

A set of resource identifiers representing a single resource to be monitored. 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.

setResources

public void setResources(java.util.List<RsrcId> resources)

A set of resource identifiers representing a single resource to be monitored. 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:

resources - New value for the property.

getInterval

public java.lang.Long getInterval()

Desired sampling rate in seconds. 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 this property is null, default interval is 10 seconds.

Returns:

The current value of the property.

setInterval

public void setInterval(java.lang.Long interval)

Desired sampling rate in seconds. 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 this property is null, default interval is 10 seconds.

Parameters:

interval - New value for the property.

getExpiration

public java.lang.Long getExpiration()

Expiration time for this acquisition specification represented as Unix UTC number of seconds (since epoch). 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 this property is null or 0, default expiration duration is 100 minutes.

Returns:

The current value of the property.

setExpiration

public void setExpiration(java.lang.Long expiration)

Expiration time for this acquisition specification represented as Unix UTC number of seconds (since epoch). 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 this property is null or 0, default expiration duration is 100 minutes.

Parameters:

expiration - New value for the property.

getMemo_

public java.lang.String getMemo_()

Consumer provided text about this Acquisition Specification. 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.

setMemo_

public void setMemo_(java.lang.String memo_)

Consumer provided text about this Acquisition Specification. 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:

memo_ - New value for the property.

getStatus

public AcqSpecsTypes.Status getStatus()

Acquisition Specification 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(AcqSpecsTypes.Status status)

Acquisition Specification 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 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 AcqSpecsTypes.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 AcqSpecsTypes.Info _newInstance2(com.vmware.vapi.data.StructValue structValue)

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