com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion

Class CreateSpec

java.lang.Object

com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion.CreateSpec

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class CreateSpec
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The CreateSpec class contains information used to create a new vMotion policy that applies when a host is evacuated, see Policies.create(com.vmware.vapi.bindings.Structure), in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. All virtual machines that share the tag indicated by getVmTag() will be vMotioned from a host whenever the host is evacuated by vCenter. If vCenter cannot migrate a virtual machine, then it will remain running on its current host. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateSpec.Builder Builder class for CreateSpec.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	CreateSpec() Default constructor.
protected	CreateSpec(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
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.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static CreateSpec	_newInstance(com.vmware.vapi.data.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 CreateSpec	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
java.lang.String	getCapability() Identifier of the capability this policy is based on.
java.lang.String	getDescription() Description of the policy.
java.lang.String	getName() Name of the policy.
java.lang.String	getVmTag() Identifier of a tag that can be associated with a virtual machine.
int	hashCode()
void	setDescription(java.lang.String description) Description of the policy.
void	setName(java.lang.String name) Name of the policy.
void	setVmTag(java.lang.String vmTag) Identifier of a tag that can be associated with a virtual machine.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

CreateSpec

public CreateSpec()

Default constructor.

CreateSpec

protected CreateSpec(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Detail

getVmTag

public java.lang.String getVmTag()

Identifier of a tag that can be associated with a virtual machine. Virtual machines with this tag will be vMotioned from a host if vCenter requires to evacuate the host. If vMotion is not feasible, then the virtual machine will remain running on its current host. Warning: This property is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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: com.vmware.cis.tagging.Tag:VirtualMachine. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine.

setVmTag

public void setVmTag(java.lang.String vmTag)

Identifier of a tag that can be associated with a virtual machine. Virtual machines with this tag will be vMotioned from a host if vCenter requires to evacuate the host. If vMotion is not feasible, then the virtual machine will remain running on its current host. Warning: This property is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Parameters:

vmTag - 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.cis.tagging.Tag:VirtualMachine. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine.

getCapability

public java.lang.String getCapability()

Identifier of the capability this policy is based on. The value of this property is automatically populated to "com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion". if null, then the name of capability class will be used to distinguish the policy type.

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: com.vmware.vcenter.compute.policies.Capability. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.

getName

public java.lang.String getName()

Name of the policy. The name needs to be unique within this vCenter server.

Returns:

The current value of the property.

setName

public void setName(java.lang.String name)

Name of the policy. The name needs to be unique within this vCenter server.

Parameters:

name - New value for the property.

getDescription

public java.lang.String getDescription()

Description of the policy.

Returns:

The current value of the property.

setDescription

public void setDescription(java.lang.String description)

Description of the policy.

Parameters:

description - New value for the property.

_getType

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

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.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()

Specified by:

toString in interface com.vmware.vapi.bindings.StaticStructure

Overrides:

toString in class java.lang.Object

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

_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()

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static CreateSpec _newInstance(com.vmware.vapi.data.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 CreateSpec _newInstance2(com.vmware.vapi.data.StructValue structValue)

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