public final class ClusterPrecheckResult extends java.lang.Object implements java.io.Serializable, StaticStructure
PrecheckResult
class contains properties that describe precheck
status of applying the desired document to a group of hosts. 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.Modifier and Type | Class and Description |
---|---|
static class |
ClusterPrecheckResult.Builder
Builder class for
ClusterPrecheckResult . |
static class |
ClusterPrecheckResult.Status
The
Status enumeration class contains the possible statuses of the
Precheck API on the cluster. |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
ClusterPrecheckResult()
Default constructor.
|
protected |
ClusterPrecheckResult(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 ClusterPrecheckResult |
_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 ClusterPrecheckResult |
_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.String |
getCommit()
This identifier refers to the commit action of importing the desired
configuration document.
|
java.util.Calendar |
getEndTime()
Precheck completion time.
|
java.util.Set<java.lang.String> |
getFailedHosts()
Hosts in this cluster where the precheck failed to run.
|
java.util.Map<java.lang.String,HostInfo> |
getHostInfo()
Map of host IDs to hostname.
|
java.util.Map<java.lang.String,HostPrecheckResult> |
getHostPrecheck()
Map of host IDs to their precheck results.
|
StatusInfo |
getPrecheckResult()
This field represents the precheck results on the cluster, if any one host in
the cluster needs to be put in maintenance mode or to be rebooted.
|
java.util.List<LocalizableMessage> |
getRemediationNotes()
Static notes to the user describing steps that will be taken during remediation.
|
java.util.List<LocalizableMessage> |
getRemediationSummary()
Summarizing remediation stating number of hosts needing reboot and maintenance
mode during remediation and number of precheck errors on host and cluster.
|
java.util.Set<java.lang.String> |
getSkippedHosts()
Hosts in this cluster where the precheck was not tried because the host was
disconnected.
|
java.lang.String |
getSoftwareCommit()
The current commit ID for the software associated with the cluster.
|
ClusterPrecheckResult.Status |
getStatus()
Overall status of precheck on the cluster.
|
java.util.Set<java.lang.String> |
getSuccessfulHosts()
Hosts in this cluster where the precheck was sucessfully run.
|
LocalizableMessage |
getSummary()
Summarizing precheck operation on the host and cluster.
|
int |
hashCode() |
void |
setCommit(java.lang.String commit)
This identifier refers to the commit action of importing the desired
configuration document.
|
void |
setEndTime(java.util.Calendar endTime)
Precheck completion time.
|
void |
setFailedHosts(java.util.Set<java.lang.String> failedHosts)
Hosts in this cluster where the precheck failed to run.
|
void |
setHostInfo(java.util.Map<java.lang.String,HostInfo> hostInfo)
Map of host IDs to hostname.
|
void |
setHostPrecheck(java.util.Map<java.lang.String,HostPrecheckResult> hostPrecheck)
Map of host IDs to their precheck results.
|
void |
setPrecheckResult(StatusInfo precheckResult)
This field represents the precheck results on the cluster, if any one host in
the cluster needs to be put in maintenance mode or to be rebooted.
|
void |
setRemediationNotes(java.util.List<LocalizableMessage> remediationNotes)
Static notes to the user describing steps that will be taken during remediation.
|
void |
setRemediationSummary(java.util.List<LocalizableMessage> remediationSummary)
Summarizing remediation stating number of hosts needing reboot and maintenance
mode during remediation and number of precheck errors on host and cluster.
|
void |
setSkippedHosts(java.util.Set<java.lang.String> skippedHosts)
Hosts in this cluster where the precheck was not tried because the host was
disconnected.
|
void |
setSoftwareCommit(java.lang.String softwareCommit)
The current commit ID for the software associated with the cluster.
|
void |
setStatus(ClusterPrecheckResult.Status status)
Overall status of precheck on the cluster.
|
void |
setSuccessfulHosts(java.util.Set<java.lang.String> successfulHosts)
Hosts in this cluster where the precheck was sucessfully run.
|
void |
setSummary(LocalizableMessage summary)
Summarizing precheck operation on the host and cluster.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public ClusterPrecheckResult()
protected ClusterPrecheckResult(StructValue __dynamicStructureFields)
public ClusterPrecheckResult.Status getStatus()
public void setStatus(ClusterPrecheckResult.Status status)
status
- New value for the property.public java.lang.String getCommit()
com.vmware.esx.settings.commit
. When
methods return a value of this class as a return value, the property will be an
identifier for the resource type: com.vmware.esx.settings.commit
.public void setCommit(java.lang.String commit)
commit
- 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.esx.settings.commit
. When
methods return a value of this class as a return value, the property will be an
identifier for the resource type: com.vmware.esx.settings.commit
.public java.lang.String getSoftwareCommit()
com.vmware.esx.settings.commit
. When
methods return a value of this class as a return value, the property will be an
identifier for the resource type: com.vmware.esx.settings.commit
.public void setSoftwareCommit(java.lang.String softwareCommit)
softwareCommit
- 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.esx.settings.commit
. When
methods return a value of this class as a return value, the property will be an
identifier for the resource type: com.vmware.esx.settings.commit
.public java.util.Calendar getEndTime()
public void setEndTime(java.util.Calendar endTime)
endTime
- New value for the property.public LocalizableMessage getSummary()
public void setSummary(LocalizableMessage summary)
summary
- New value for the property.public java.util.List<LocalizableMessage> getRemediationSummary()
public void setRemediationSummary(java.util.List<LocalizableMessage> remediationSummary)
remediationSummary
- New value for the property.public java.util.List<LocalizableMessage> getRemediationNotes()
public void setRemediationNotes(java.util.List<LocalizableMessage> remediationNotes)
remediationNotes
- New value for the property.public java.util.Map<java.lang.String,HostInfo> getHostInfo()
Map
must be an identifier for the resource type: HostSystem
. When methods return a value of this class as a return value, the
key in the property Map
will be an identifier for the resource
type: HostSystem
.public void setHostInfo(java.util.Map<java.lang.String,HostInfo> hostInfo)
hostInfo
- New value for the property.
When clients pass a value of this class as a parameter, the key in the property
Map
must be an identifier for the resource type: HostSystem
. When methods return a value of this class as a return value, the
key in the property Map
will be an identifier for the resource
type: HostSystem
.public java.util.Map<java.lang.String,HostPrecheckResult> getHostPrecheck()
getStatus()
is ERROR, This field will contain Validation errors or Host Impact and Health
Check errors. If getStatus()
is OK, This field will contain Impact and Health Check information.
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.Map
must be an identifier for the resource type: HostSystem
. When methods return a value of this class as a return value, the
key in the property Map
will be an identifier for the resource
type: HostSystem
.public void setHostPrecheck(java.util.Map<java.lang.String,HostPrecheckResult> hostPrecheck)
getStatus()
is ERROR, This field will contain Validation errors or Host Impact and Health
Check errors. If getStatus()
is OK, This field will contain Impact and Health Check information.
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.hostPrecheck
- New value for the property.
When clients pass a value of this class as a parameter, the key in the property
Map
must be an identifier for the resource type: HostSystem
. When methods return a value of this class as a return value, the
key in the property Map
will be an identifier for the resource
type: HostSystem
.public StatusInfo getPrecheckResult()
public void setPrecheckResult(StatusInfo precheckResult)
precheckResult
- New value for the property.public java.util.Set<java.lang.String> getSuccessfulHosts()
HostSystem
. When methods
return a value of this class as a return value, the property will contain
identifiers for the resource type: HostSystem
.public void setSuccessfulHosts(java.util.Set<java.lang.String> successfulHosts)
successfulHosts
- New value for the property.
When clients pass a value of this class as a parameter, the property must
contain identifiers for the resource type: HostSystem
. When methods
return a value of this class as a return value, the property will contain
identifiers for the resource type: HostSystem
.public java.util.Set<java.lang.String> getFailedHosts()
HostSystem
. When methods
return a value of this class as a return value, the property will contain
identifiers for the resource type: HostSystem
.public void setFailedHosts(java.util.Set<java.lang.String> failedHosts)
failedHosts
- New value for the property.
When clients pass a value of this class as a parameter, the property must
contain identifiers for the resource type: HostSystem
. When methods
return a value of this class as a return value, the property will contain
identifiers for the resource type: HostSystem
.public java.util.Set<java.lang.String> getSkippedHosts()
HostSystem
. When methods
return a value of this class as a return value, the property will contain
identifiers for the resource type: HostSystem
.public void setSkippedHosts(java.util.Set<java.lang.String> skippedHosts)
skippedHosts
- New value for the property.
When clients pass a value of this class as a parameter, the property must
contain identifiers for the resource type: HostSystem
. When methods
return a value of this class as a return value, the property will contain
identifiers for the resource type: HostSystem
.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 ClusterPrecheckResult _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 ClusterPrecheckResult _newInstance2(StructValue structValue)