SizeParams

java.lang.Object
- com.vmware.vcenter.ovf.SizeParams

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class SizeParams
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The SizeParams class contains estimates of the download and deployment sizes.
This information is based on the file references and the ovf:DiskSection in the OVF descriptor.

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 SizeParams.Builder
Builder class for SizeParams.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SizeParams.Builder` Builder class for `SizeParams`.

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

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

Constructor Summary

Constructors
Modifier Constructor and Description

SizeParams()
Default constructor.

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 SizeParams`	`_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 SizeParams`	`_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.Long`	`getApproximateDownloadSize()` A best guess as to the total amount of data that must be transferred to download the OVF package.
`java.lang.Long`	`getApproximateFlatDeploymentSize()` A best guess as to the total amount of space required to deploy the OVF package if using flat disks.
`java.lang.Long`	`getApproximateSparseDeploymentSize()` A best guess as to the total amount of space required to deploy the OVF package using sparse disks.
`java.lang.String`	`getType()` Unique identifier describing the type of the OVF parameters.
`java.lang.Boolean`	`getVariableDiskSize()` Whether the OVF uses variable disk sizes.
`int`	`hashCode()`
`void`	`setApproximateDownloadSize(java.lang.Long approximateDownloadSize)` A best guess as to the total amount of data that must be transferred to download the OVF package.
`void`	`setApproximateFlatDeploymentSize(java.lang.Long approximateFlatDeploymentSize)` A best guess as to the total amount of space required to deploy the OVF package if using flat disks.
`void`	`setApproximateSparseDeploymentSize(java.lang.Long approximateSparseDeploymentSize)` A best guess as to the total amount of space required to deploy the OVF package using sparse disks.
`void`	`setType(java.lang.String type)` Unique identifier describing the type of the OVF parameters.
`void`	`setVariableDiskSize(java.lang.Boolean variableDiskSize)` Whether the OVF uses variable disk sizes.
`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
  - SizeParams
```
public SizeParams()
```
    Default constructor.
  - SizeParams
```
protected SizeParams(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getApproximateDownloadSize
```
public java.lang.Long getApproximateDownloadSize()
```
    A best guess as to the total amount of data that must be transferred to download the OVF package.
    This may be inaccurate due to disk compression etc.
    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. It will be null if there is insufficient information to provide a proper estimate.
    
    Returns:
    
    The current value of the property.
  - setApproximateDownloadSize
```
public void setApproximateDownloadSize(java.lang.Long approximateDownloadSize)
```
    A best guess as to the total amount of data that must be transferred to download the OVF package.
    This may be inaccurate due to disk compression etc.
    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. It will be null if there is insufficient information to provide a proper estimate.
    
    Parameters:
    
    approximateDownloadSize - New value for the property.
  - getApproximateFlatDeploymentSize
```
public java.lang.Long getApproximateFlatDeploymentSize()
```
    A best guess as to the total amount of space required to deploy the OVF package if using flat disks. 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. It will be null if there is insufficient information to provide a proper estimate.
    
    Returns:
    
    The current value of the property.
  - setApproximateFlatDeploymentSize
```
public void setApproximateFlatDeploymentSize(java.lang.Long approximateFlatDeploymentSize)
```
    A best guess as to the total amount of space required to deploy the OVF package if using flat disks. 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. It will be null if there is insufficient information to provide a proper estimate.
    
    Parameters:
    
    approximateFlatDeploymentSize - New value for the property.
  - getApproximateSparseDeploymentSize
```
public java.lang.Long getApproximateSparseDeploymentSize()
```
    A best guess as to the total amount of space required to deploy the OVF package using sparse disks. 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. It will be null if there is insufficient information to provide a proper estimate.
    
    Returns:
    
    The current value of the property.
  - setApproximateSparseDeploymentSize
```
public void setApproximateSparseDeploymentSize(java.lang.Long approximateSparseDeploymentSize)
```
    A best guess as to the total amount of space required to deploy the OVF package using sparse disks. 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. It will be null if there is insufficient information to provide a proper estimate.
    
    Parameters:
    
    approximateSparseDeploymentSize - New value for the property.
  - getVariableDiskSize
```
public java.lang.Boolean getVariableDiskSize()
```
    Whether the OVF uses variable disk sizes.
    For empty disks, rather than specifying a fixed virtual disk capacity, the capacity may be given using a reference to a ovf:Property element in a ovf:ProductSection element in OVF package.
    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. If null or false, the OVF does not use variable disk sizes.
    
    Returns:
    
    The current value of the property.
  - setVariableDiskSize
```
public void setVariableDiskSize(java.lang.Boolean variableDiskSize)
```
    Whether the OVF uses variable disk sizes.
    For empty disks, rather than specifying a fixed virtual disk capacity, the capacity may be given using a reference to a ovf:Property element in a ovf:ProductSection element in OVF package.
    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. If null or false, the OVF does not use variable disk sizes.
    
    Parameters:
    
    variableDiskSize - New value for the property.
  - getType
```
public java.lang.String getType()
```
    Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. 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.
  - setType
```
public void setType(java.lang.String type)
```
    Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. 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:
    
    type - 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 SizeParams _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 SizeParams _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class SizeParams

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

SizeParams

SizeParams

Method Detail

getApproximateDownloadSize

setApproximateDownloadSize

getApproximateFlatDeploymentSize

setApproximateFlatDeploymentSize

getApproximateSparseDeploymentSize

setApproximateSparseDeploymentSize

getVariableDiskSize

setVariableDiskSize

getType

setType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2