com.vmware.vcenter.ovf

Class Property.Builder

java.lang.Object

com.vmware.vcenter.ovf.Property.Builder

Enclosing class:

Property

public static final class Property.Builder
extends java.lang.Object

Builder class for Property.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of Property.

Method Summary

Modifier and Type	Method and Description
Property	build()
Property.Builder	setCategory(java.lang.String category) If this is set to a non-empty string, this property starts a new category.
Property.Builder	setClassId(java.lang.String classId) The classId of this OVF property.
Property.Builder	setDescription(java.lang.String description) A description of this OVF property.
Property.Builder	setId(java.lang.String id) The identifier of this OVF property.
Property.Builder	setInstanceId(java.lang.String instanceId) The instanceId of this OVF property.
Property.Builder	setLabel(java.lang.String label) The display name of this OVF property.
Property.Builder	setType(java.lang.String type) The type of this OVF property.
Property.Builder	setUiOptional(java.lang.Boolean uiOptional) Whether a category is UI optional.
Property.Builder	setValue(java.lang.String value) The OVF property value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of Property.

Method Detail

setClassId

public Property.Builder 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.

setId

public Property.Builder 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.

setInstanceId

public Property.Builder 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.

setCategory

public Property.Builder 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.

setUiOptional

public Property.Builder setUiOptional(java.lang.Boolean uiOptional)

Whether a category is UI optional. This is only used if this property starts a new category (see Property.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.

setLabel

public Property.Builder 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.

setDescription

public Property.Builder 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.

setType

public Property.Builder 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.

setValue

public Property.Builder 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.

build

public Property build()