public static final class LibraryItemsTypes.DeploySpec extends java.lang.Object implements java.io.Serializable, StaticStructure
DeploySpec
class defines the deployment parameters that can be
specified for the deploy()
method. This class was added in vSphere API
6.8.Modifier and Type | Class and Description |
---|---|
static class |
LibraryItemsTypes.DeploySpec.Builder
Builder class for
LibraryItemsTypes.DeploySpec . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
DeploySpec()
Default constructor.
|
protected |
DeploySpec(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 LibraryItemsTypes.DeploySpec |
_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 LibraryItemsTypes.DeploySpec |
_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 |
getDescription()
Description of the deployed virtual machine.
|
LibraryItemsTypes.DeploySpecDiskStorage |
getDiskStorage()
Storage specification for the deployed virtual machine's disks.
|
java.util.Map<java.lang.String,LibraryItemsTypes.DeploySpecDiskStorage> |
getDiskStorageOverrides()
Storage specification for individual disks in the deployed virtual machine.
|
LibraryItemsTypes.GuestCustomizationSpec |
getGuestCustomization()
Guest customization spec to apply to the deployed virtual machine.
|
LibraryItemsTypes.HardwareCustomizationSpec |
getHardwareCustomization()
Hardware customization spec which specifies updates to the deployed virtual
machine.
|
java.lang.String |
getName()
Name of the deployed virtual machine.
|
LibraryItemsTypes.DeployPlacementSpec |
getPlacement()
Information used to place the deployed virtual machine.
|
java.lang.Boolean |
getPoweredOn()
Specifies whether the deployed virtual machine should be powered on after
deployment.
|
LibraryItemsTypes.DeploySpecVmHomeStorage |
getVmHomeStorage()
Storage location for the deployed virtual machine's configuration and log files.
|
int |
hashCode() |
void |
setDescription(java.lang.String description)
Description of the deployed virtual machine.
|
void |
setDiskStorage(LibraryItemsTypes.DeploySpecDiskStorage diskStorage)
Storage specification for the deployed virtual machine's disks.
|
void |
setDiskStorageOverrides(java.util.Map<java.lang.String,LibraryItemsTypes.DeploySpecDiskStorage> diskStorageOverrides)
Storage specification for individual disks in the deployed virtual machine.
|
void |
setGuestCustomization(LibraryItemsTypes.GuestCustomizationSpec guestCustomization)
Guest customization spec to apply to the deployed virtual machine.
|
void |
setHardwareCustomization(LibraryItemsTypes.HardwareCustomizationSpec hardwareCustomization)
Hardware customization spec which specifies updates to the deployed virtual
machine.
|
void |
setName(java.lang.String name)
Name of the deployed virtual machine.
|
void |
setPlacement(LibraryItemsTypes.DeployPlacementSpec placement)
Information used to place the deployed virtual machine.
|
void |
setPoweredOn(java.lang.Boolean poweredOn)
Specifies whether the deployed virtual machine should be powered on after
deployment.
|
void |
setVmHomeStorage(LibraryItemsTypes.DeploySpecVmHomeStorage vmHomeStorage)
Storage location for the deployed virtual machine's configuration and log files.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public DeploySpec()
protected DeploySpec(StructValue __dynamicStructureFields)
public java.lang.String getName()
public void setName(java.lang.String name)
name
- New value for the property.public java.lang.String getDescription()
null
, the deployed virtual machine has the same description as the
source library item.public void setDescription(java.lang.String description)
null
, the deployed virtual machine has the same description as the
source library item.description
- New value for the property.public LibraryItemsTypes.DeploySpecVmHomeStorage getVmHomeStorage()
null
, the deployed virtual machine's configuration and log files are
created with the same storage spec as the source virtual machine template's
configuration and log files.public void setVmHomeStorage(LibraryItemsTypes.DeploySpecVmHomeStorage vmHomeStorage)
null
, the deployed virtual machine's configuration and log files are
created with the same storage spec as the source virtual machine template's
configuration and log files.vmHomeStorage
- New value for the property.public LibraryItemsTypes.DeploySpecDiskStorage getDiskStorage()
getDiskStorageOverrides()
and getDiskStorage()
are
null
, the deployed virtual machine's disks are created with the same
storage spec as the corresponding disks in the source virtual machine template
contained in the library item.
If getDiskStorageOverrides()
is
null
and getDiskStorage()
is specified, all of the deployed
virtual machine's disks are created with the storage spec specified by getDiskStorage()
.
If getDiskStorageOverrides()
is specified
and getDiskStorage()
is null
, disks with identifiers that are
not in getDiskStorageOverrides()
are created with the same storage spec
as the corresponding disks in the source virtual machine template contained in
the library item.
If both getDiskStorageOverrides()
and getDiskStorage()
are specified, disks with identifiers that are not in getDiskStorageOverrides()
are created with the storage spec specified by getDiskStorage()
.
public void setDiskStorage(LibraryItemsTypes.DeploySpecDiskStorage diskStorage)
getDiskStorageOverrides()
and getDiskStorage()
are
null
, the deployed virtual machine's disks are created with the same
storage spec as the corresponding disks in the source virtual machine template
contained in the library item.
If getDiskStorageOverrides()
is
null
and getDiskStorage()
is specified, all of the deployed
virtual machine's disks are created with the storage spec specified by getDiskStorage()
.
If getDiskStorageOverrides()
is specified
and getDiskStorage()
is null
, disks with identifiers that are
not in getDiskStorageOverrides()
are created with the same storage spec
as the corresponding disks in the source virtual machine template contained in
the library item.
If both getDiskStorageOverrides()
and getDiskStorage()
are specified, disks with identifiers that are not in getDiskStorageOverrides()
are created with the storage spec specified by getDiskStorage()
.
diskStorage
- New value for the property.public java.util.Map<java.lang.String,LibraryItemsTypes.DeploySpecDiskStorage> getDiskStorageOverrides()
getDiskStorageOverrides()
and getDiskStorage()
are
null
, the deployed virtual machine's disks are created with the same
storage spec as the corresponding disks in the source virtual machine template
contained in the library item.
If getDiskStorageOverrides()
is
null
and getDiskStorage()
is specified, all of the deployed
virtual machine's disks are created with the storage spec specified by getDiskStorage()
.
If getDiskStorageOverrides()
is specified
and getDiskStorage()
is null
, disks with identifiers that are
not in getDiskStorageOverrides()
are created with the same storage spec
as the corresponding disks in the source virtual machine template contained in
the library item.
If both getDiskStorageOverrides()
and getDiskStorage()
are specified, disks with identifiers that are not in getDiskStorageOverrides()
are created with the storage spec specified by getDiskStorage()
.
Map
must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk
. 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: com.vmware.vcenter.vm.hardware.Disk
.public void setDiskStorageOverrides(java.util.Map<java.lang.String,LibraryItemsTypes.DeploySpecDiskStorage> diskStorageOverrides)
getDiskStorageOverrides()
and getDiskStorage()
are
null
, the deployed virtual machine's disks are created with the same
storage spec as the corresponding disks in the source virtual machine template
contained in the library item.
If getDiskStorageOverrides()
is
null
and getDiskStorage()
is specified, all of the deployed
virtual machine's disks are created with the storage spec specified by getDiskStorage()
.
If getDiskStorageOverrides()
is specified
and getDiskStorage()
is null
, disks with identifiers that are
not in getDiskStorageOverrides()
are created with the same storage spec
as the corresponding disks in the source virtual machine template contained in
the library item.
If both getDiskStorageOverrides()
and getDiskStorage()
are specified, disks with identifiers that are not in getDiskStorageOverrides()
are created with the storage spec specified by getDiskStorage()
.
diskStorageOverrides
- 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: com.vmware.vcenter.vm.hardware.Disk
. 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: com.vmware.vcenter.vm.hardware.Disk
.public LibraryItemsTypes.DeployPlacementSpec getPlacement()
null
, the system will use the values from the source virtual machine template
contained in the library item.
If specified, each property will be used for placement. If the properties result in disjoint placement, the operation will fail. If the properties along with the placement values of the source virtual machine template result in disjoint placement, the operation will fail.
public void setPlacement(LibraryItemsTypes.DeployPlacementSpec placement)
null
, the system will use the values from the source virtual machine template
contained in the library item.
If specified, each property will be used for placement. If the properties result in disjoint placement, the operation will fail. If the properties along with the placement values of the source virtual machine template result in disjoint placement, the operation will fail.
placement
- New value for the property.public java.lang.Boolean getPoweredOn()
null
, the virtual machine will not be powered on after deployment.public void setPoweredOn(java.lang.Boolean poweredOn)
null
, the virtual machine will not be powered on after deployment.poweredOn
- New value for the property.public LibraryItemsTypes.GuestCustomizationSpec getGuestCustomization()
null
, the guest operating system is not customized after deployment.public void setGuestCustomization(LibraryItemsTypes.GuestCustomizationSpec guestCustomization)
null
, the guest operating system is not customized after deployment.guestCustomization
- New value for the property.public LibraryItemsTypes.HardwareCustomizationSpec getHardwareCustomization()
null
, the deployed virtual machine has the same hardware
configuration as the source virtual machine template contained in the library
item.public void setHardwareCustomization(LibraryItemsTypes.HardwareCustomizationSpec hardwareCustomization)
null
, the deployed virtual machine has the same hardware
configuration as the source virtual machine template contained in the library
item.hardwareCustomization
- 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
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 LibraryItemsTypes.DeploySpec _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 LibraryItemsTypes.DeploySpec _newInstance2(StructValue structValue)