public static final class LibraryItemsTypes.CreateSpec extends java.lang.Object implements java.io.Serializable, StaticStructure
CreateSpec
class defines the information required to create a
library item containing a virtual machine template. This class was added in
vSphere API 6.7 U1.Modifier and Type | Class and Description |
---|---|
static class |
LibraryItemsTypes.CreateSpec.Builder
Builder class for
LibraryItemsTypes.CreateSpec . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
LibraryItemsTypes.CreateSpec()
Default constructor.
|
protected |
LibraryItemsTypes.CreateSpec(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 LibraryItemsTypes.CreateSpec |
_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.String |
getDescription()
Description of the library item.
|
LibraryItemsTypes.CreateSpecDiskStorage |
getDiskStorage()
Storage specification for the virtual machine template's disks.
|
java.util.Map<java.lang.String,LibraryItemsTypes.CreateSpecDiskStorage> |
getDiskStorageOverrides()
Storage specification for individual disks in the virtual machine template.
|
java.lang.String |
getLibrary()
Identifier of the library in which the new library item should be created.
|
java.lang.String |
getName()
Name of the library item.
|
LibraryItemsTypes.CreatePlacementSpec |
getPlacement()
Information used to place the virtual machine template.
|
java.lang.String |
getSourceVm()
Identifier of the source virtual machine to create the library item from.
|
LibraryItemsTypes.CreateSpecVmHomeStorage |
getVmHomeStorage()
Storage location for the virtual machine template's configuration and log files.
|
int |
hashCode() |
void |
setDescription(java.lang.String description)
Description of the library item.
|
void |
setDiskStorage(LibraryItemsTypes.CreateSpecDiskStorage diskStorage)
Storage specification for the virtual machine template's disks.
|
void |
setDiskStorageOverrides(java.util.Map<java.lang.String,LibraryItemsTypes.CreateSpecDiskStorage> diskStorageOverrides)
Storage specification for individual disks in the virtual machine template.
|
void |
setLibrary(java.lang.String library)
Identifier of the library in which the new library item should be created.
|
void |
setName(java.lang.String name)
Name of the library item.
|
void |
setPlacement(LibraryItemsTypes.CreatePlacementSpec placement)
Information used to place the virtual machine template.
|
void |
setSourceVm(java.lang.String sourceVm)
Identifier of the source virtual machine to create the library item from.
|
void |
setVmHomeStorage(LibraryItemsTypes.CreateSpecVmHomeStorage vmHomeStorage)
Storage location for the virtual machine template's configuration and log files.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected final StructValue __dynamicStructureFields
public LibraryItemsTypes.CreateSpec()
protected LibraryItemsTypes.CreateSpec(StructValue __dynamicStructureFields)
public java.lang.String getSourceVm()
VirtualMachine
. When methods return a
value of this class as a return value, the property will be an identifier for
the resource type: VirtualMachine
.public void setSourceVm(java.lang.String sourceVm)
sourceVm
- 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: VirtualMachine
. When methods return a
value of this class as a return value, the property will be an identifier for
the resource type: VirtualMachine
.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 newly created library item has the same description as the
source virtual machine.public void setDescription(java.lang.String description)
null
, the newly created library item has the same description as the
source virtual machine.description
- New value for the property.public java.lang.String getLibrary()
com.vmware.content.Library
. When
methods return a value of this class as a return value, the property will be an
identifier for the resource type: com.vmware.content.Library
.public void setLibrary(java.lang.String library)
library
- 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.content.Library
. When
methods return a value of this class as a return value, the property will be an
identifier for the resource type: com.vmware.content.Library
.public LibraryItemsTypes.CreateSpecVmHomeStorage getVmHomeStorage()
null
, the virtual machine template's configuration and log files are
placed on the default storage backing associated with the library specified by
getLibrary()
.public void setVmHomeStorage(LibraryItemsTypes.CreateSpecVmHomeStorage vmHomeStorage)
null
, the virtual machine template's configuration and log files are
placed on the default storage backing associated with the library specified by
getLibrary()
.vmHomeStorage
- New value for the property.public LibraryItemsTypes.CreateSpecDiskStorage getDiskStorage()
getDiskStorageOverrides()
and getDiskStorage()
are
null
, the virtual machine template's disks are placed in the default
storage backing associated with the library specified by getLibrary()
.
If getDiskStorageOverrides()
is null
and getDiskStorage()
is specified, all of the virtual machine template'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 placed in the default storage backing associated
with the library specified by getLibrary()
.
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.CreateSpecDiskStorage diskStorage)
getDiskStorageOverrides()
and getDiskStorage()
are
null
, the virtual machine template's disks are placed in the default
storage backing associated with the library specified by getLibrary()
.
If getDiskStorageOverrides()
is null
and getDiskStorage()
is specified, all of the virtual machine template'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 placed in the default storage backing associated
with the library specified by getLibrary()
.
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.CreateSpecDiskStorage> getDiskStorageOverrides()
getDiskStorageOverrides()
and getDiskStorage()
are
null
, the virtual machine template's disks are placed in the default
storage backing associated with the library specified by getLibrary()
.
If getDiskStorageOverrides()
is null
and getDiskStorage()
is specified, all of the virtual machine template'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 placed in the default storage backing associated
with the library specified by getLibrary()
.
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.CreateSpecDiskStorage> diskStorageOverrides)
getDiskStorageOverrides()
and getDiskStorage()
are
null
, the virtual machine template's disks are placed in the default
storage backing associated with the library specified by getLibrary()
.
If getDiskStorageOverrides()
is null
and getDiskStorage()
is specified, all of the virtual machine template'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 placed in the default storage backing associated
with the library specified by getLibrary()
.
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.CreatePlacementSpec getPlacement()
null
, the system will place the virtual machine template on a suitable
resource.
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 result in disjoint placement, the operation will fail.
public void setPlacement(LibraryItemsTypes.CreatePlacementSpec placement)
null
, the system will place the virtual machine template on a suitable
resource.
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 result in disjoint placement, the operation will fail.
placement
- 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 LibraryItemsTypes.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