com.vmware.vcenter

Class VMTypes.RegisterSpec

java.lang.Object

com.vmware.vcenter.VMTypes.RegisterSpec

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

Enclosing interface:

VMTypes

public static final class VMTypes.RegisterSpec
extends java.lang.Object
implements java.io.Serializable, StaticStructure

The RegisterSpec class contains information used to create a virtual machine from existing virtual machine files on storage.

The location of the virtual machine files on storage must be specified by providing either getDatastore() and getPath() or by providing getDatastorePath(). If getDatastore() and getPath() are Set, getDatastorePath() must be null, and if getDatastorePath() is Set, getDatastore() and getPath() must be null.

. This class was added in vSphere API 6.8.7.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VMTypes.RegisterSpec.Builder Builder class for VMTypes.RegisterSpec.

Field Summary

Fields

Modifier and Type	Field and Description
protected StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	RegisterSpec() Default constructor.
protected	RegisterSpec(StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends Structure> T	_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 VMTypes.RegisterSpec	_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 VMTypes.RegisterSpec	_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	getDatastore() Identifier of the datastore on which the virtual machine's configuration state is stored.
java.lang.String	getDatastorePath() Datastore path for the virtual machine's configuration file in the format "[datastore name] path".
java.lang.String	getName() Virtual machine name.
java.lang.String	getPath() Path to the virtual machine's configuration file on the datastore corresponding to {@link #datastore).
VMTypes.RegisterPlacementSpec	getPlacement() Virtual machine placement information.
int	hashCode()
void	setDatastore(java.lang.String datastore) Identifier of the datastore on which the virtual machine's configuration state is stored.
void	setDatastorePath(java.lang.String datastorePath) Datastore path for the virtual machine's configuration file in the format "[datastore name] path".
void	setName(java.lang.String name) Virtual machine name.
void	setPath(java.lang.String path) Path to the virtual machine's configuration file on the datastore corresponding to {@link #datastore).
void	setPlacement(VMTypes.RegisterPlacementSpec placement) Virtual machine placement information.
java.lang.String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__dynamicStructureFields

protected StructValue __dynamicStructureFields

Constructor Detail

RegisterSpec

public RegisterSpec()

Default constructor.

RegisterSpec

protected RegisterSpec(StructValue __dynamicStructureFields)

Method Detail

getDatastore

public java.lang.String getDatastore()

Identifier of the datastore on which the virtual machine's configuration state is stored. This property was added in vSphere API 6.8.7. If null, getPath() must also be null and getDatastorePath() must be Set.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: Datastore. When methods return a value of this class as a return value, the property will be an identifier for the resource type: Datastore.

setDatastore

public void setDatastore(java.lang.String datastore)

Identifier of the datastore on which the virtual machine's configuration state is stored. This property was added in vSphere API 6.8.7. If null, getPath() must also be null and getDatastorePath() must be Set.

Parameters:

datastore - 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: Datastore. When methods return a value of this class as a return value, the property will be an identifier for the resource type: Datastore.

getPath

public java.lang.String getPath()

Path to the virtual machine's configuration file on the datastore corresponding to #datastore). This property was added in vSphere API 6.8.7. If {@code null}, {@link com.vmware.vcenter.VMTypes.RegisterSpec#getDatastore} must also be {@code null} and {@link com.vmware.vcenter.VMTypes.RegisterSpec#getDatastorePath} must be {@link java.util.Set}.

Returns:

The current value of the property.

setPath

public void setPath(java.lang.String path)

Path to the virtual machine's configuration file on the datastore corresponding to #datastore). This property was added in vSphere API 6.8.7. If {@code null}, {@link com.vmware.vcenter.VMTypes.RegisterSpec#getDatastore} must also be {@code null} and {@link com.vmware.vcenter.VMTypes.RegisterSpec#getDatastorePath} must be {@link java.util.Set}.

Parameters:

path - New value for the property.

getDatastorePath

public java.lang.String getDatastorePath()

Datastore path for the virtual machine's configuration file in the format "[datastore name] path". For example "[storage1] Test-VM/Test-VM.vmx". This property was added in vSphere API 6.8.7. If null, both getDatastore() and getPath() must be Set.

Returns:

The current value of the property.

setDatastorePath

public void setDatastorePath(java.lang.String datastorePath)

Datastore path for the virtual machine's configuration file in the format "[datastore name] path". For example "[storage1] Test-VM/Test-VM.vmx". This property was added in vSphere API 6.8.7. If null, both getDatastore() and getPath() must be Set.

Parameters:

datastorePath - New value for the property.

getName

public java.lang.String getName()

Virtual machine name. This property was added in vSphere API 6.8.7. If null, the display name from the virtual machine's configuration file will be used.

Returns:

The current value of the property.

setName

public void setName(java.lang.String name)

Virtual machine name. This property was added in vSphere API 6.8.7. If null, the display name from the virtual machine's configuration file will be used.

Parameters:

name - New value for the property.

getPlacement

public VMTypes.RegisterPlacementSpec getPlacement()

Virtual machine placement information. This property was added in vSphere API 6.8.7. This property is currently required. In the future, if this property is null, the system will attempt to choose suitable resources on which to place the virtual machine.

Returns:

The current value of the property.

setPlacement

public void setPlacement(VMTypes.RegisterPlacementSpec placement)

Virtual machine placement information. This property was added in vSphere API 6.8.7. This property is currently required. In the future, if this property is null, the system will attempt to choose suitable resources on which to place the virtual machine.

Parameters:

placement - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Description copied from interface: StaticStructure

WARNING: Internal method, 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

_updateDataValue

protected void _updateDataValue(StructValue structValue)

_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(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.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 java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)

Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.

This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo

public <T extends Structure> T _convertTo(java.lang.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(java.lang.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(java.lang.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 java.util.Set<java.lang.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 method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public java.lang.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 java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static VMTypes.RegisterSpec _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.

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

_newInstance2

public static VMTypes.RegisterSpec _newInstance2(StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.