public static final class BootTypes.CreateSpec extends Object implements Serializable, StaticStructure
CreateSpec
class describes settings used when booting a virtual
machine.Modifier and Type | Class and Description |
---|---|
static class |
BootTypes.CreateSpec.Builder
Builder class for
BootTypes.CreateSpec . |
Constructor and Description |
---|
BootTypes.CreateSpec()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
String |
_getCanonicalName()
Returns the canonical name of the structure.
|
static String |
_getCanonicalTypeName()
Returns the canonical type name.
|
static com.vmware.vapi.bindings.type.StructType |
_getClassType()
WARNING: Internal API, subject to change in future versions.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(String fieldName)
Get dynamic filed value.
|
Set<String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.StructType |
_getType()
WARNING: Internal API, subject to change in future versions.
|
boolean |
_hasTypeNameOf(Class<? extends Structure> clazz)
Checks that the runtime type name matches the type name from the binding
class.
|
static BootTypes.CreateSpec |
_newInstance(StructValue structValue)
WARNING: Internal API, 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(String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(Object obj) |
Long |
getDelay()
Delay in milliseconds before beginning the firmware boot process when the
virtual machine is powered on.
|
Boolean |
getEfiLegacyBoot()
Flag indicating whether to use EFI legacy boot mode.
|
Boolean |
getEnterSetupMode()
Flag indicating whether the firmware boot process should automatically enter
setup mode the next time the virtual machine boots.
|
BootTypes.NetworkProtocol |
getNetworkProtocol()
Protocol to use when attempting to boot the virtual machine over the network.
|
Boolean |
getRetry()
Flag indicating whether the virtual machine should automatically retry the boot
process after a failure.
|
Long |
getRetryDelay()
Delay in milliseconds before retrying the boot process after a failure;
applicable only when
BootTypes.Info.getRetry() is true. |
BootTypes.Type |
getType()
Firmware type to be used by the virtual machine.
|
int |
hashCode() |
void |
setDelay(Long delay)
Delay in milliseconds before beginning the firmware boot process when the
virtual machine is powered on.
|
void |
setEfiLegacyBoot(Boolean efiLegacyBoot)
Flag indicating whether to use EFI legacy boot mode.
|
void |
setEnterSetupMode(Boolean enterSetupMode)
Flag indicating whether the firmware boot process should automatically enter
setup mode the next time the virtual machine boots.
|
void |
setNetworkProtocol(BootTypes.NetworkProtocol networkProtocol)
Protocol to use when attempting to boot the virtual machine over the network.
|
void |
setRetry(Boolean retry)
Flag indicating whether the virtual machine should automatically retry the boot
process after a failure.
|
void |
setRetryDelay(Long retryDelay)
Delay in milliseconds before retrying the boot process after a failure;
applicable only when
BootTypes.Info.getRetry() is true. |
void |
setType(BootTypes.Type type)
Firmware type to be used by the virtual machine.
|
String |
toString()
Returns a string representation of this structure.
|
public BootTypes.Type getType()
null
, defaults to value that is recommended for the guest OS and is
supported for the virtual hardware version.public void setType(BootTypes.Type type)
null
, defaults to value that is recommended for the guest OS and is
supported for the virtual hardware version.type
- New value for the property.public Boolean getEfiLegacyBoot()
null
, defaults to value that is recommended for the guest OS and is
supported for the virtual hardware version.public void setEfiLegacyBoot(Boolean efiLegacyBoot)
null
, defaults to value that is recommended for the guest OS and is
supported for the virtual hardware version.efiLegacyBoot
- New value for the property.public BootTypes.NetworkProtocol getNetworkProtocol()
null
, defaults to a system defined default value.public void setNetworkProtocol(BootTypes.NetworkProtocol networkProtocol)
null
, defaults to a system defined default value.networkProtocol
- New value for the property.public Long getDelay()
null
, default value is 0.public void setDelay(Long delay)
null
, default value is 0.delay
- New value for the property.public Boolean getRetry()
null
, default value is false.public void setRetry(Boolean retry)
null
, default value is false.retry
- New value for the property.public Long getRetryDelay()
BootTypes.Info.getRetry()
is true.
If null
, default value is 10000.public void setRetryDelay(Long retryDelay)
BootTypes.Info.getRetry()
is true.
If null
, default value is 10000.retryDelay
- New value for the property.public Boolean getEnterSetupMode()
null
, the value is unchanged.public void setEnterSetupMode(Boolean enterSetupMode)
null
, the value is unchanged.enterSetupMode
- 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 structurepublic 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 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 Object
public boolean _hasTypeNameOf(Class<? extends Structure> clazz)
Structure
_hasTypeNameOf
in interface Structure
clazz
- type of the result structure. cannot be null.public <T extends Structure> T _convertTo(Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(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(String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic Set<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 String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static String _getCanonicalTypeName()
_getCanonicalName()
.public static BootTypes.CreateSpec _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
Copyright © 2016. All Rights Reserved.