public static final class LastApplyResultTypes.ApplyResult extends java.lang.Object implements java.io.Serializable, StaticStructure
ApplyResult
class contains properties that describe the result of an
apply method.Modifier and Type | Class and Description |
---|---|
static class |
LastApplyResultTypes.ApplyResult.Builder
Builder class for
LastApplyResultTypes.ApplyResult . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
ApplyResult()
Default constructor.
|
protected |
ApplyResult(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 dynamic filed value.
|
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 LastApplyResultTypes.ApplyResult |
_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 LastApplyResultTypes.ApplyResult |
_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()
The identifier of the commit used to fetch the desired software document to be
applied to all hosts within the cluster.
|
java.util.Set<java.lang.String> |
getFailedHosts()
Hosts in this cluster to which the desired software document specified by the
getCommit()
failed to be applied to. |
java.util.Map<java.lang.String,HostInfo> |
getHostInfo()
Information of the hosts in this cluster to which the desired software document
specified by the
getCommit()
should be applied to. |
java.util.Map<java.lang.String,LastApplyResultTypes.ApplyStatus> |
getHostStatus()
Status of the hosts in this cluster to which the desired software document
specified by the
getCommit()
was applied to. |
java.util.Set<java.lang.String> |
getSkippedHosts()
Hosts in this cluster that were skipped by the apply method.
|
LastApplyResultTypes.ApplyStatus |
getStatus()
Specifies the aggregated status of the apply method.
|
java.util.Set<java.lang.String> |
getSuccessfulHosts()
Hosts in this cluster to which the desired software document specified by the
getCommit()
has been successfully applied to. |
int |
hashCode() |
void |
setCommit(java.lang.String commit)
The identifier of the commit used to fetch the desired software document to be
applied to all hosts within the cluster.
|
void |
setFailedHosts(java.util.Set<java.lang.String> failedHosts)
Hosts in this cluster to which the desired software document specified by the
getCommit()
failed to be applied to. |
void |
setHostInfo(java.util.Map<java.lang.String,HostInfo> hostInfo)
Information of the hosts in this cluster to which the desired software document
specified by the
getCommit()
should be applied to. |
void |
setHostStatus(java.util.Map<java.lang.String,LastApplyResultTypes.ApplyStatus> hostStatus)
Status of the hosts in this cluster to which the desired software document
specified by the
getCommit()
was applied to. |
void |
setSkippedHosts(java.util.Set<java.lang.String> skippedHosts)
Hosts in this cluster that were skipped by the apply method.
|
void |
setStatus(LastApplyResultTypes.ApplyStatus status)
Specifies the aggregated status of the apply method.
|
void |
setSuccessfulHosts(java.util.Set<java.lang.String> successfulHosts)
Hosts in this cluster to which the desired software document specified by the
getCommit()
has been successfully applied to. |
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public ApplyResult()
protected ApplyResult(StructValue __dynamicStructureFields)
public LastApplyResultTypes.ApplyStatus getStatus()
public void setStatus(LastApplyResultTypes.ApplyStatus 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.util.Map<java.lang.String,HostInfo> getHostInfo()
getCommit()
should be applied to.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)
getCommit()
should be applied to.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,LastApplyResultTypes.ApplyStatus> getHostStatus()
getCommit()
was applied to. Hosts on which the apply method was sucessful are specified by
getSuccessfulHosts()
.
Hosts on which the apply method failed are specified by getFailedHosts()
.
Hosts which were skipped by the apply method are specified by getSkippedHosts()
.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 setHostStatus(java.util.Map<java.lang.String,LastApplyResultTypes.ApplyStatus> hostStatus)
getCommit()
was applied to. Hosts on which the apply method was sucessful are specified by
getSuccessfulHosts()
.
Hosts on which the apply method failed are specified by getFailedHosts()
.
Hosts which were skipped by the apply method are specified by getSkippedHosts()
.hostStatus
- 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.Set<java.lang.String> getSuccessfulHosts()
getCommit()
has been successfully applied to.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)
getCommit()
has been successfully applied to.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()
getCommit()
failed to be applied to.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)
getCommit()
failed to be applied to.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 LastApplyResultTypes.ApplyResult _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 LastApplyResultTypes.ApplyResult _newInstance2(StructValue structValue)