Property (vSphere Automation SDK for Java 7.0.1.0)

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

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable
```
public final class Property
extends java.lang.Object
implements java.io.Serializable, 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 StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

Property()
Default constructor.

protected Property(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`Property()` Default constructor.
`protected`	`Property(StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 Property`	`_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 Property`	`_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`	`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()` 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
  - Property
```
public Property()
```
    Default constructor.
  - Property
```
protected Property(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()
```
    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 Property _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 Property _newInstance2(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