Property

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class Property
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The Property class contains the information about a property in an OVF package.
A property is uniquely identified by its [classid.]id[.instanceid] fully-qualified name (see getClassId(), getId(), and getInstanceId()). If multiple properties in an OVF package have the same fully-qualified name, then the property is excluded and cannot be set. We do warn about this during import.

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

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

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

Property()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`Property()` Default constructor.
`protected`	`Property(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 Property`	`_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 Property`	`_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`	`getCategory()` If this is set to a non-empty string, this property starts a new category.
`java.lang.String`	`getClassId()` The classId of this OVF property.
`java.lang.String`	`getDescription()` A description of this OVF property.
`java.lang.String`	`getId()` The identifier of this OVF property.
`java.lang.String`	`getInstanceId()` The instanceId of this OVF property.
`java.lang.String`	`getLabel()` The display name of this OVF property.
`java.lang.String`	`getType()` The type of this OVF property.
`java.lang.Boolean`	`getUiOptional()` Whether a category is UI optional.
`java.lang.String`	`getValue()` The OVF property value.
`int`	`hashCode()`
`void`	`setCategory(java.lang.String category)` If this is set to a non-empty string, this property starts a new category.
`void`	`setClassId(java.lang.String classId)` The classId of this OVF property.
`void`	`setDescription(java.lang.String description)` A description of this OVF property.
`void`	`setId(java.lang.String id)` The identifier of this OVF property.
`void`	`setInstanceId(java.lang.String instanceId)` The instanceId of this OVF property.
`void`	`setLabel(java.lang.String label)` The display name of this OVF property.
`void`	`setType(java.lang.String type)` The type of this OVF property.
`void`	`setUiOptional(java.lang.Boolean uiOptional)` Whether a category is UI optional.
`void`	`setValue(java.lang.String value)` The OVF property value.
`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
  - Property
```
public Property()
```
    Default constructor.
  - Property
```
protected Property(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getClassId
```
public java.lang.String getClassId()
```
    The classId of this OVF property. 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.
  - setClassId
```
public void setClassId(java.lang.String classId)
```
    The classId of this OVF property. 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:
    
    classId - New value for the property.
  - getId
```
public java.lang.String getId()
```
    The identifier of this OVF property. 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 this OVF property. 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.
  - getInstanceId
```
public java.lang.String getInstanceId()
```
    The instanceId of this OVF property. 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.
  - setInstanceId
```
public void setInstanceId(java.lang.String instanceId)
```
    The instanceId of this OVF property. 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:
    
    instanceId - New value for the property.
  - getCategory
```
public java.lang.String getCategory()
```
    If this is set to a non-empty string, this property starts a new category. 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, the property is in the same category as the previous item, otherwise, it starts a new category.
    
    Returns:
    
    The current value of the property.
  - setCategory
```
public void setCategory(java.lang.String category)
```
    If this is set to a non-empty string, this property starts a new category. 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, the property is in the same category as the previous item, otherwise, it starts a new category.
    
    Parameters:
    
    category - New value for the property.
  - getUiOptional
```
public java.lang.Boolean getUiOptional()
```
    Whether a category is UI optional. This is only used if this property starts a new category (see getCategory()).
    The value is stored in an optional attribute vmw:uioptional to the ovf:Category element. The default value is false. If this value is true, the properties within this category are optional. The UI renders this as a group with a check box, and the group is grayed out until the check box is selected. When the check box is selected, the input values are read and used in deployment. If properties within the same category specify conflicting values the default is used. Only implemented in vSphere Web Client 5.1 and later as of Nov 2012.
    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.
    
    Returns:
    
    The current value of the property.
  - setUiOptional
```
public void setUiOptional(java.lang.Boolean uiOptional)
```
    Whether a category is UI optional. This is only used if this property starts a new category (see getCategory()).
    The value is stored in an optional attribute vmw:uioptional to the ovf:Category element. The default value is false. If this value is true, the properties within this category are optional. The UI renders this as a group with a check box, and the group is grayed out until the check box is selected. When the check box is selected, the input values are read and used in deployment. If properties within the same category specify conflicting values the default is used. Only implemented in vSphere Web Client 5.1 and later as of Nov 2012.
    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.
    
    Parameters:
    
    uiOptional - New value for the property.
  - getLabel
```
public java.lang.String getLabel()
```
    The display name of this OVF property. 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.
  - setLabel
```
public void setLabel(java.lang.String label)
```
    The display name of this OVF property. 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:
    
    label - New value for the property.
  - getDescription
```
public java.lang.String getDescription()
```
    A description of this OVF property. 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.
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    A description of this OVF property. 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.
    
    Parameters:
    
    description - New value for the property.
  - getType
```
public java.lang.String getType()
```
    The type of this OVF property. Refer to the configuration of a virtual appliance/virtual machine for the valid values. 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.
  - setType
```
public void setType(java.lang.String type)
```
    The type of this OVF property. Refer to the configuration of a virtual appliance/virtual machine for the valid values. 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:
    
    type - New value for the property.
  - getValue
```
public java.lang.String getValue()
```
    The OVF property value. This contains the default value from ovf:defaultValue if ovf:value is not present when read. 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.
  - setValue
```
public void setValue(java.lang.String value)
```
    The OVF property value. This contains the default value from ovf:defaultValue if ovf:value is not present when read. 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:
    
    value - 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 Property _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 Property _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class Property

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

Property

Property

Method Detail

getClassId

setClassId

getId

setId

getInstanceId

setInstanceId

getCategory

setCategory

getUiOptional

setUiOptional

getLabel

setLabel

getDescription

setDescription

getType

setType

getValue

setValue

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2