public static final class LibraryItemTypes.DeploymentTarget extends java.lang.Object implements java.io.Serializable, StaticStructure
DeploymentTarget
class describes the location (target) where a
virtual machine or virtual appliance should be deployed. It is used in the
deploy()
and filter()
methods. See LibraryItem.deploy(java.lang.String, java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget, com.vmware.vcenter.ovf.LibraryItemTypes.ResourcePoolDeploymentSpec)
and LibraryItem.filter(java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget)
.Modifier and Type | Class and Description |
---|---|
static class |
LibraryItemTypes.DeploymentTarget.Builder
Builder class for
LibraryItemTypes.DeploymentTarget . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
LibraryItemTypes.DeploymentTarget()
Default constructor.
|
protected |
LibraryItemTypes.DeploymentTarget(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 LibraryItemTypes.DeploymentTarget |
_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 |
getFolderId()
Identifier of the vCenter folder that should contain the virtual machine or
virtual appliance.
|
java.lang.String |
getHostId()
Identifier of the target host on which the virtual machine or virtual appliance
will run.
|
java.lang.String |
getResourcePoolId()
Identifier of the resource pool to which the virtual machine or virtual
appliance should be attached.
|
int |
hashCode() |
void |
setFolderId(java.lang.String folderId)
Identifier of the vCenter folder that should contain the virtual machine or
virtual appliance.
|
void |
setHostId(java.lang.String hostId)
Identifier of the target host on which the virtual machine or virtual appliance
will run.
|
void |
setResourcePoolId(java.lang.String resourcePoolId)
Identifier of the resource pool to which the virtual machine or virtual
appliance should be attached.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected final StructValue __dynamicStructureFields
public LibraryItemTypes.DeploymentTarget()
protected LibraryItemTypes.DeploymentTarget(StructValue __dynamicStructureFields)
public java.lang.String getResourcePoolId()
ResourcePool
. When methods return a
value of this class as a return value, the property will be an identifier for
the resource type: ResourcePool
.public void setResourcePoolId(java.lang.String resourcePoolId)
resourcePoolId
- 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: ResourcePool
. When methods return a
value of this class as a return value, the property will be an identifier for
the resource type: ResourcePool
.public java.lang.String getHostId()
getResourcePoolId()
.
If null
, the server will automatically select a target host from the
resource pool if getResourcePoolId()
is a
stand-alone host or a cluster with Distributed Resource Scheduling (DRS)
enabled.HostSystem
. When methods return a
value of this class as a return value, the property will be an identifier for
the resource type: HostSystem
.public void setHostId(java.lang.String hostId)
getResourcePoolId()
.
If null
, the server will automatically select a target host from the
resource pool if getResourcePoolId()
is a
stand-alone host or a cluster with Distributed Resource Scheduling (DRS)
enabled.hostId
- 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: HostSystem
. When methods return a
value of this class as a return value, the property will be an identifier for
the resource type: HostSystem
.public java.lang.String getFolderId()
null
, the server will choose the deployment folder.Folder
. When methods return a value of
this class as a return value, the property will be an identifier for the
resource type: Folder
.public void setFolderId(java.lang.String folderId)
null
, the server will choose the deployment folder.folderId
- 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: Folder
. When methods return a value of
this class as a return value, the property will be an identifier for the
resource type: Folder
.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 LibraryItemTypes.DeploymentTarget _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