public final class VmToolsMonitoringSettings extends java.lang.Object implements java.io.Serializable, StaticStructure
vim.cluster.VmToolsMonitoringSettings
data object contains virtual
machine monitoring settings that are used by the Virtual Machine Health
Monitoring Service. The Service checks the VMware Tools heartbeat of a virtual
machine. If heartbeats have not been received within a specified time interval,
the Service declares the virtual machine as failed and resets the virtual
machine. All fields are optional. In case of a reconfiguration, fields left
unset are not changed.Modifier and Type | Class and Description |
---|---|
static class |
VmToolsMonitoringSettings.Builder
Builder class for
VmToolsMonitoringSettings . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
VmToolsMonitoringSettings()
Default constructor.
|
protected |
VmToolsMonitoringSettings(StructValue __dynamicStructureFields) |
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(java.lang.Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
java.lang.String |
_getCanonicalName()
Returns the canonical name of the structure.
|
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.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(java.lang.String fieldName)
Get a dynamic field value, doesn't allow access to static fields (which
have getters/setters).
|
java.util.Set<java.lang.String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.StructType |
_getType()
WARNING: Internal method, subject to change in future versions.
|
boolean |
_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Checks if the runtime type name of this structure matches the type
represented by the specified binding class.
|
static VmToolsMonitoringSettings |
_newInstance(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 VmToolsMonitoringSettings |
_newInstance2(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism. |
void |
_setDynamicField(java.lang.String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
protected void |
_updateDataValue(StructValue structValue) |
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(java.lang.Object obj) |
java.lang.Boolean |
getClusterSettings()
Flag indicating whether to use the cluster settings or the per VM settings.
|
java.lang.Boolean |
getEnabled()
Flag indicating whether or not the Virtual Machine Health Monitoring service is
enabled.
|
java.lang.Long |
getFailureInterval()
If no heartbeat has been received for at least the specified number of seconds,
the virtual machine is declared as failed.
|
java.lang.Long |
getMaxFailures()
Maximum number of failures and automated resets allowed during the time that
getMaxFailureWindow()
specifies. |
java.lang.Long |
getMaxFailureWindow()
The number of seconds for the window during which up to
getMaxFailures()
resets can occur before automated responses stop. |
java.lang.Long |
getMinUpTime()
The number of seconds for the virtual machine's heartbeats to stabilize after
the virtual machine has been powered on.
|
int |
hashCode() |
void |
setClusterSettings(java.lang.Boolean clusterSettings)
Flag indicating whether to use the cluster settings or the per VM settings.
|
void |
setEnabled(java.lang.Boolean enabled)
Flag indicating whether or not the Virtual Machine Health Monitoring service is
enabled.
|
void |
setFailureInterval(java.lang.Long failureInterval)
If no heartbeat has been received for at least the specified number of seconds,
the virtual machine is declared as failed.
|
void |
setMaxFailures(java.lang.Long maxFailures)
Maximum number of failures and automated resets allowed during the time that
getMaxFailureWindow()
specifies. |
void |
setMaxFailureWindow(java.lang.Long maxFailureWindow)
The number of seconds for the window during which up to
getMaxFailures()
resets can occur before automated responses stop. |
void |
setMinUpTime(java.lang.Long minUpTime)
The number of seconds for the virtual machine's heartbeats to stabilize after
the virtual machine has been powered on.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public VmToolsMonitoringSettings()
protected VmToolsMonitoringSettings(StructValue __dynamicStructureFields)
public java.lang.Boolean getEnabled()
The Server does not use this property.
public void setEnabled(java.lang.Boolean enabled)
The Server does not use this property.
enabled
- New value for the property.public java.lang.Boolean getClusterSettings()
The default value is true.
public void setClusterSettings(java.lang.Boolean clusterSettings)
The default value is true.
clusterSettings
- New value for the property.public java.lang.Long getFailureInterval()
The default value is 30.
public void setFailureInterval(java.lang.Long failureInterval)
The default value is 30.
failureInterval
- New value for the property.public java.lang.Long getMinUpTime()
The default value is 120.
public void setMinUpTime(java.lang.Long minUpTime)
The default value is 120.
minUpTime
- New value for the property.public java.lang.Long getMaxFailures()
getMaxFailureWindow()
specifies. If getMaxFailureWindow()
is -1 (no window), this represents the absolute number of failures after which
automated response is stopped.
If a virtual machine exceeds this threshold, in-depth problem analysis is usually needed.
The default value is 3.
public void setMaxFailures(java.lang.Long maxFailures)
getMaxFailureWindow()
specifies. If getMaxFailureWindow()
is -1 (no window), this represents the absolute number of failures after which
automated response is stopped.
If a virtual machine exceeds this threshold, in-depth problem analysis is usually needed.
The default value is 3.
maxFailures
- New value for the property.public java.lang.Long getMaxFailureWindow()
getMaxFailures()
resets can occur before automated responses stop.
If set to -1, no failure window is specified.
The default value is -1.
public void setMaxFailureWindow(java.lang.Long maxFailureWindow)
getMaxFailures()
resets can occur before automated responses stop.
If set to -1, no failure window is specified.
The default value is -1.
maxFailureWindow
- New value for the property.public com.vmware.vapi.bindings.type.StructType _getType()
StaticStructure
StructType
instance representing the static bindings
type for this Structure
._getType
in interface StaticStructure
StructType
public StructValue _getDataValue()
Structure
Structure
represented in the dynamic
DataValue
model.
Attempts to change the returned StructValue
representation are not required to change the state of this structure.
Actually the behavior is implementation dependent and is unspecified.
In general the returned value shouldn't be changed.
_getDataValue
in interface Structure
StructValue
representing this structureprotected void _updateDataValue(StructValue structValue)
public void _validate()
StaticStructure
Structure
.
More precisely, for each union: given value of the discriminant/tag
field (@UnionTag
in the IDL) of an union in this structure,
validates that:
_validate
in interface StaticStructure
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
StaticStructure
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.
toString
in interface StaticStructure
toString
in class java.lang.Object
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Structure
This can be used as efficient check to determine if this instance
can be successfully converted
to the target
type.
_hasTypeNameOf
in interface Structure
clazz
- bindings class for the target structure; must not be null
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(java.lang.String fieldName, DataValue fieldValue)
StaticStructure
_setDynamicField
in interface StaticStructure
fieldName
- canonical name of the dynamic field to setfieldValue
- the value of the fieldpublic DataValue _getDynamicField(java.lang.String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic java.util.Set<java.lang.String> _getDynamicFieldNames()
StaticStructure
_getDynamicFieldNames
in interface StaticStructure
public static com.vmware.vapi.bindings.type.StructType _getClassType()
StructType
instance representing the static bindings
type for this Structure
.public java.lang.String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static java.lang.String _getCanonicalTypeName()
_getCanonicalName()
.public static VmToolsMonitoringSettings _newInstance(StructValue structValue)
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.StructType
public static VmToolsMonitoringSettings _newInstance2(StructValue structValue)