com.vmware.vcenter.ovf

Class ScaleOutGroup

java.lang.Object

com.vmware.vcenter.ovf.ScaleOutGroup

All Implemented Interfaces:

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

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

The ScaleOutGroup class contains information about a scale-out group.

It allows a virtual system collection to contain a set of children that are homogeneous with respect to a prototypical virtual system or virtual system collection. It shall cause the deployment function to replicate the prototype a number of times, thus allowing the number of instantiated virtual systems to be configured dynamically at deployment time.

This is based on the ovf2:ScaleOutSection.

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).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScaleOutGroup() Default constructor.
protected	ScaleOutGroup(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 ScaleOutGroup	_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 ScaleOutGroup	_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	getDescription() The description of the scale-out group.
java.lang.String	getId() The identifier of the scale-out group.
java.lang.Long	getInstanceCount() The scaling factor to use.
java.lang.Long	getMaximumInstanceCount() The maximum scaling factor.
java.lang.Long	getMinimumInstanceCount() The minimum scaling factor.
int	hashCode()
void	setDescription(java.lang.String description) The description of the scale-out group.
void	setId(java.lang.String id) The identifier of the scale-out group.
void	setInstanceCount(java.lang.Long instanceCount) The scaling factor to use.
void	setMaximumInstanceCount(java.lang.Long maximumInstanceCount) The maximum scaling factor.
void	setMinimumInstanceCount(java.lang.Long minimumInstanceCount) The minimum scaling factor.
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

ScaleOutGroup

public ScaleOutGroup()

Default constructor.

ScaleOutGroup

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

Method Detail

getId

public java.lang.String getId()

The identifier of the scale-out group. This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Returns:

The current value of the property.

setId

public void setId(java.lang.String id)

The identifier of the scale-out group. This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Parameters:

id - New value for the property.

getDescription

public java.lang.String getDescription()

The description of the scale-out group. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Returns:

The current value of the property.

setDescription

public void setDescription(java.lang.String description)

The description of the scale-out group. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Parameters:

description - New value for the property.

getInstanceCount

public java.lang.Long getInstanceCount()

The scaling factor to use. It defines the number of replicas of the prototypical virtual system or virtual system collection. This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Returns:

The current value of the property.

setInstanceCount

public void setInstanceCount(java.lang.Long instanceCount)

The scaling factor to use. It defines the number of replicas of the prototypical virtual system or virtual system collection. This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Parameters:

instanceCount - New value for the property.

getMinimumInstanceCount

public java.lang.Long getMinimumInstanceCount()

The minimum scaling factor. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package. This will be 1 if there is no explicit limit.

Returns:

The current value of the property.

setMinimumInstanceCount

public void setMinimumInstanceCount(java.lang.Long minimumInstanceCount)

The minimum scaling factor. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package. This will be 1 if there is no explicit limit.

Parameters:

minimumInstanceCount - New value for the property.

getMaximumInstanceCount

public java.lang.Long getMaximumInstanceCount()

The maximum scaling factor. This property is not used in the input parameters when deploying an OVF package. This property is optional in the result when retrieving information about an OVF package. This will be null if there is no explicit limit.

Returns:

The current value of the property.

setMaximumInstanceCount

public void setMaximumInstanceCount(java.lang.Long maximumInstanceCount)

The maximum scaling factor. This property is not used in the input parameters when deploying an OVF package. This property is optional in the result when retrieving information about an OVF package. This will be null if there is no explicit limit.

Parameters:

maximumInstanceCount - 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 ScaleOutGroup _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 ScaleOutGroup _newInstance2(com.vmware.vapi.data.StructValue structValue)

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