public static final class SubscriptionsTypes.PlacementInfo extends java.lang.Object implements java.io.Serializable, StaticStructure
PlacementInfo
class contains the placement information for the
subscribed library's virtual machine template library items. The PlacementInfo
class is only applicable for the virtual machine template library
items of the subscribed library. This class was added in vSphere API 6.7.2.Modifier and Type | Class and Description |
---|---|
static class |
SubscriptionsTypes.PlacementInfo.Builder
Builder class for
SubscriptionsTypes.PlacementInfo . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
PlacementInfo()
Default constructor.
|
protected |
PlacementInfo(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 SubscriptionsTypes.PlacementInfo |
_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 SubscriptionsTypes.PlacementInfo |
_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 |
getCluster()
Cluster onto which the virtual machine template should be placed.
|
java.lang.String |
getFolder()
Virtual machine folder into which the virtual machine template should be placed.
|
java.lang.String |
getHost()
Host onto which the virtual machine template should be placed.
|
java.lang.String |
getNetwork()
Network that backs the virtual Ethernet adapters in the virtual machine
template.
|
java.lang.String |
getResourcePool()
Resource pool into which the virtual machine template should be placed.
|
int |
hashCode() |
void |
setCluster(java.lang.String cluster)
Cluster onto which the virtual machine template should be placed.
|
void |
setFolder(java.lang.String folder)
Virtual machine folder into which the virtual machine template should be placed.
|
void |
setHost(java.lang.String host)
Host onto which the virtual machine template should be placed.
|
void |
setNetwork(java.lang.String network)
Network that backs the virtual Ethernet adapters in the virtual machine
template.
|
void |
setResourcePool(java.lang.String resourcePool)
Resource pool into which the virtual machine template should be placed.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public PlacementInfo()
protected PlacementInfo(StructValue __dynamicStructureFields)
public java.lang.String getFolder()
null
if the subscribed library associated with the
subscription does not have a virtual machine folder.Folder:VCenter
. When methods return a
value of this class as a return value, the property will be an identifier for
the resource type: Folder:VCenter
.public void setFolder(java.lang.String folder)
null
if the subscribed library associated with the
subscription does not have a virtual machine folder.folder
- 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:VCenter
. When methods return a
value of this class as a return value, the property will be an identifier for
the resource type: Folder:VCenter
.public java.lang.String getCluster()
null
if the subscribed library associated with the
subscription does not have a cluster.ClusterComputeResource:VCenter
. When
methods return a value of this class as a return value, the property will be an
identifier for the resource type: ClusterComputeResource:VCenter
.public void setCluster(java.lang.String cluster)
null
if the subscribed library associated with the
subscription does not have a cluster.cluster
- 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: ClusterComputeResource:VCenter
. When
methods return a value of this class as a return value, the property will be an
identifier for the resource type: ClusterComputeResource:VCenter
.public java.lang.String getResourcePool()
null
if the subscribed library associated with the
subscription does not have a resource pool.ResourcePool:VCenter
. When methods
return a value of this class as a return value, the property will be an
identifier for the resource type: ResourcePool:VCenter
.public void setResourcePool(java.lang.String resourcePool)
null
if the subscribed library associated with the
subscription does not have a resource pool.resourcePool
- 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:VCenter
. When methods
return a value of this class as a return value, the property will be an
identifier for the resource type: ResourcePool:VCenter
.public java.lang.String getHost()
getHost()
and getResourcePool()
are both specified, getResourcePool()
must belong to getHost()
. If getHost()
and
getCluster()
are both specified, getHost()
must be a member of
getCluster()
. This property was added in vSphere API 6.7.2.
The property will be null
if the subscribed library associated with the
subscription does not have a host.HostSystem:VCenter
. When methods
return a value of this class as a return value, the property will be an
identifier for the resource type: HostSystem:VCenter
.public void setHost(java.lang.String host)
getHost()
and getResourcePool()
are both specified, getResourcePool()
must belong to getHost()
. If getHost()
and
getCluster()
are both specified, getHost()
must be a member of
getCluster()
. This property was added in vSphere API 6.7.2.
The property will be null
if the subscribed library associated with the
subscription does not have a host.host
- 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:VCenter
. When methods
return a value of this class as a return value, the property will be an
identifier for the resource type: HostSystem:VCenter
.public java.lang.String getNetwork()
null
if the subscribed library associated with the
subscription does not have a network.Network:VCenter
. When methods return a
value of this class as a return value, the property will be an identifier for
the resource type: Network:VCenter
.public void setNetwork(java.lang.String network)
null
if the subscribed library associated with the
subscription does not have a network.network
- 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: Network:VCenter
. When methods return a
value of this class as a return value, the property will be an identifier for
the resource type: Network:VCenter
.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 SubscriptionsTypes.PlacementInfo _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 SubscriptionsTypes.PlacementInfo _newInstance2(StructValue structValue)