public static final class ClusterTypes.UndeploySpec extends java.lang.Object implements java.io.Serializable, StaticStructure
UndeploySpec
class contains the undeploy specification for a VCHA
cluster. This class was added in vSphere API 6.7 U1.Modifier and Type | Class and Description |
---|---|
static class |
ClusterTypes.UndeploySpec.Builder
Builder class for
ClusterTypes.UndeploySpec . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
ClusterTypes.UndeploySpec()
Default constructor.
|
protected |
ClusterTypes.UndeploySpec(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 that the runtime type name matches the type name from the binding
class.
|
static ClusterTypes.UndeploySpec |
_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. |
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 |
getForceDelete()
Flag controlling in what circumstances the virtual machines will be deleted.
|
CredentialsSpec |
getVcSpec()
Contains the active node's management vCenter server credentials.
|
ClusterTypes.VmInfo |
getVms()
Contains virtual machine information for the passive and witness virtual
machines.
|
int |
hashCode() |
void |
setForceDelete(java.lang.Boolean forceDelete)
Flag controlling in what circumstances the virtual machines will be deleted.
|
void |
setVcSpec(CredentialsSpec vcSpec)
Contains the active node's management vCenter server credentials.
|
void |
setVms(ClusterTypes.VmInfo vms)
Contains virtual machine information for the passive and witness virtual
machines.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected final StructValue __dynamicStructureFields
public ClusterTypes.UndeploySpec()
protected ClusterTypes.UndeploySpec(StructValue __dynamicStructureFields)
public CredentialsSpec getVcSpec()
null
, then the active vCenter server is assumed to be managed by
itself.public void setVcSpec(CredentialsSpec vcSpec)
null
, then the active vCenter server is assumed to be managed by
itself.vcSpec
- New value for the property.public java.lang.Boolean getForceDelete()
getVms()
property will be
ignored, the VCHA cluster specific information is removed, and the passive and
witness virtual machines will be deleted.getVms()
property contains the
information identifying the passive and witness virtual machines.getVms()
property
is set, then it will be validated prior to deleting the passive and witness
virtual machines and VCHA cluster specific information is removed.getVms()
property is
null
, then the passive and witness virtual machines will not be deleted.
The customer should delete them in order to cleanup completely. VCHA cluster
specific information is removed.null
, the getVms()
property contains the
information identifying the passive and witness virtual machines. getVms()
property is
set, then it will be validated prior to deleting the passive and witness virtual
machines. VCHA cluster specific information is removed.getVms()
property is null
, then the passive and witness virtual machines will not be deleted. The
customer should delete them in order to cleanup completely. VCHA cluster
specific information is removed.public void setForceDelete(java.lang.Boolean forceDelete)
getVms()
property will be
ignored, the VCHA cluster specific information is removed, and the passive and
witness virtual machines will be deleted.getVms()
property contains the
information identifying the passive and witness virtual machines.getVms()
property
is set, then it will be validated prior to deleting the passive and witness
virtual machines and VCHA cluster specific information is removed.getVms()
property is
null
, then the passive and witness virtual machines will not be deleted.
The customer should delete them in order to cleanup completely. VCHA cluster
specific information is removed.null
, the getVms()
property contains the
information identifying the passive and witness virtual machines. getVms()
property is
set, then it will be validated prior to deleting the passive and witness virtual
machines. VCHA cluster specific information is removed.getVms()
property is null
, then the passive and witness virtual machines will not be deleted. The
customer should delete them in order to cleanup completely. VCHA cluster
specific information is removed.forceDelete
- New value for the property.public ClusterTypes.VmInfo getVms()
If set, the getForceDelete()
property
controls whether this information is validated.
getForceDelete()
property is
true, then this information is ignored, VCHA cluster specific information is
removed and the passive and witness virtual machines will be deleted.getForceDelete()
property is null
or false, then this information is validated prior to
deleting the passive and witness virtual machines. VCHA cluster specific
information is removed.null
, the getForceDelete()
property
controls the deletion of the passive and witness virtual machines. getForceDelete()
property is true, then the passive and witness virtual machines will be deleted.
VCHA cluster specific information is removed. getForceDelete()
property is
null
or false, then the passive and witness virtual machines will not be
deleted. The customer should delete them in order to cleanup completely. VCHA
cluster specific information is removed. public void setVms(ClusterTypes.VmInfo vms)
If set, the getForceDelete()
property
controls whether this information is validated.
getForceDelete()
property is
true, then this information is ignored, VCHA cluster specific information is
removed and the passive and witness virtual machines will be deleted.getForceDelete()
property is null
or false, then this information is validated prior to
deleting the passive and witness virtual machines. VCHA cluster specific
information is removed.null
, the getForceDelete()
property
controls the deletion of the passive and witness virtual machines. getForceDelete()
property is true, then the passive and witness virtual machines will be deleted.
VCHA cluster specific information is removed. getForceDelete()
property is
null
or false, then the passive and witness virtual machines will not be
deleted. The customer should delete them in order to cleanup completely. VCHA
cluster specific information is removed. vms
- 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
_hasTypeNameOf
in interface Structure
clazz
- type of the result structure. cannot 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 ClusterTypes.UndeploySpec _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