BootTypes.UpdateSpec (VMware-vSphere-Automation-SDK-Java-6.5.0)

java.lang.Object
- com.vmware.vcenter.vm.hardware.BootTypes.UpdateSpec

All Implemented Interfaces:

StaticStructure, Structure, Serializable

Enclosing interface:

BootTypes
```
public static final class BootTypes.UpdateSpec
extends Object
implements Serializable, StaticStructure
```
The UpdateSpec class describes the updates to the settings used when booting a virtual machine.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BootTypes.UpdateSpec.Builder
Builder class for BootTypes.UpdateSpec.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BootTypes.UpdateSpec.Builder` Builder class for `BootTypes.UpdateSpec`.

Constructor Summary

Constructors
Constructor and Description

BootTypes.UpdateSpec()
Default constructor.

Constructors
Constructor and Description
`BootTypes.UpdateSpec()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`<T extends Structure> T`	`_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.UpdateSpec`	`_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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BootTypes.UpdateSpec
```
public BootTypes.UpdateSpec()
```
    Default constructor.
- Method Detail
  - getType
```
public BootTypes.Type getType()
```
    Firmware type to be used by the virtual machine. If null, the value is unchanged.
    
    Returns:
    The current value of the property.
  - setType
```
public void setType(BootTypes.Type type)
```
    Firmware type to be used by the virtual machine. If null, the value is unchanged.
    
    Parameters:
    type - New value for the property.
  - getEfiLegacyBoot
```
public Boolean getEfiLegacyBoot()
```
    Flag indicating whether to use EFI legacy boot mode. If null, the value is unchanged.
    
    Returns:
    The current value of the property.
  - setEfiLegacyBoot
```
public void setEfiLegacyBoot(Boolean efiLegacyBoot)
```
    Flag indicating whether to use EFI legacy boot mode. If null, the value is unchanged.
    
    Parameters:
    efiLegacyBoot - New value for the property.
  - getNetworkProtocol
```
public BootTypes.NetworkProtocol getNetworkProtocol()
```
    Protocol to use when attempting to boot the virtual machine over the network. If null, the value is unchanged.
    
    Returns:
    The current value of the property.
  - setNetworkProtocol
```
public void setNetworkProtocol(BootTypes.NetworkProtocol networkProtocol)
```
    Protocol to use when attempting to boot the virtual machine over the network. If null, the value is unchanged.
    
    Parameters:
    networkProtocol - New value for the property.
  - getDelay
```
public Long getDelay()
```
    Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode. If null, the value is unchanged.
    
    Returns:
    The current value of the property.
  - setDelay
```
public void setDelay(Long delay)
```
    Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode. If null, the value is unchanged.
    
    Parameters:
    delay - New value for the property.
  - getRetry
```
public Boolean getRetry()
```
    Flag indicating whether the virtual machine should automatically retry the boot process after a failure. If null, the value is unchanged.
    
    Returns:
    The current value of the property.
  - setRetry
```
public void setRetry(Boolean retry)
```
    Flag indicating whether the virtual machine should automatically retry the boot process after a failure. If null, the value is unchanged.
    
    Parameters:
    retry - New value for the property.
  - getRetryDelay
```
public Long getRetryDelay()
```
    Delay in milliseconds before retrying the boot process after a failure; applicable only when BootTypes.Info.getRetry() is true. If null, the value is unchanged.
    
    Returns:
    The current value of the property.
  - setRetryDelay
```
public void setRetryDelay(Long retryDelay)
```
    Delay in milliseconds before retrying the boot process after a failure; applicable only when BootTypes.Info.getRetry() is true. If null, the value is unchanged.
    
    Parameters:
    retryDelay - New value for the property.
  - getEnterSetupMode
```
public Boolean getEnterSetupMode()
```
    Flag indicating whether the firmware boot process should automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode. If null, the value is unchanged.
    
    Returns:
    The current value of the property.
  - setEnterSetupMode
```
public void setEnterSetupMode(Boolean enterSetupMode)
```
    Flag indicating whether the firmware boot process should automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode. If null, the value is unchanged.
    
    Parameters:
    enterSetupMode - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Description copied from interface: StaticStructure
    
    WARNING: Internal API, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
    
    Specified by:
    
    _getType in interface StaticStructure
    
    Returns:
    the static bindings StructType
  - _getDataValue
```
public StructValue _getDataValue()
```
    Description copied from interface: Structure
    
    Returns this 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.
    
    Specified by:
    
    _getDataValue in interface Structure
    
    Returns:
    StructValue representing this structure
  - _validate
```
public void _validate()
```
    Description copied from interface: StaticStructure
    
    Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding 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:
  - all fields of the union required for that value of the discriminant are set
  - fields of the union that are not allowed for that value of the discriminant are not set
  - any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:: _validate in interface StaticStructure

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.
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.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class Object

Returns:
a string representation of this static structure instance

_hasTypeNameOf
```
public boolean _hasTypeNameOf(Class<? extends Structure> clazz)
```
Description copied from interface: Structure

Checks that the runtime type name matches the type name from the binding class.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:
clazz - type of the result structure. cannot be null.

Returns:
true if this structures type name matches exactly the provided class type name.

_convertTo
```
public <T extends Structure> T _convertTo(Class<T> clazz)
```
Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:
clazz - type of the result structure. cannot be null.

Returns:
an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField
```
public void _setDynamicField(String fieldName,
                    DataValue fieldValue)
```
Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:
fieldName - canonical name of the dynamic field to set
fieldValue - the value of the field

_getDynamicField
```
public DataValue _getDynamicField(String fieldName)
```
Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:
fieldName - the canonical name of the dynamic field

Returns:
the DataValue of the dynamic field

_getDynamicFieldNames
```
public Set<String> _getDynamicFieldNames()
```
Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:
set of the canonical field names for the dynamic fields

_getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
WARNING: Internal API, subject to change in future versions.

Returns:
StructType instance representing the static bindings type for this Structure.

_getCanonicalName
```
public String _getCanonicalName()
```
Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:
canonical name

_getCanonicalTypeName
```
public static String _getCanonicalTypeName()
```
Returns the canonical type name. See _getCanonicalName().

Returns:
canonical type name

_newInstance
```
public static BootTypes.UpdateSpec _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.

Parameters:
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.

Returns:
the static bindings StructType

Class BootTypes.UpdateSpec

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BootTypes.UpdateSpec

Method Detail

getType

setType

getEfiLegacyBoot

setEfiLegacyBoot

getNetworkProtocol

setNetworkProtocol

getDelay

setDelay

getRetry

setRetry

getRetryDelay

setRetryDelay

getEnterSetupMode

setEnterSetupMode

_getType

_getDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance