A value, whether configured or measured.
Fields
Name |
Type |
Description |
Required |
|---|---|---|---|
dataContent |
String |
Additional data for the value, normally used for sending large amounts of data. When the ValidatorType is a RESOURCE, this indicates the field that you want to display to the user |
No |
defaultText |
String |
Text that is to be displayed as a placeholder instead of the default value |
No |
defaultValue |
String |
The default value |
No |
description |
String |
A user-friendly description given to the value |
No |
descriptionDetails |
Lua defined details on how the value is displayed through describe resource. |
No |
|
hidden |
Boolean |
The boolean used to hide |
No |
key |
String |
The name of the configured value |
Yes |
measureType |
The type of unit used with the value |
No |
|
name |
String |
A user-friendly name given to the value |
Yes |
readOnly |
Boolean |
The value is read only |
No |
recheckOnChange |
Boolean |
State if the API should be queried for necessery values if this value is changed. |
No |
remembered |
Boolean |
State if the value shoudl be remembered by the browser auto-complete fields |
No |
required |
Boolean |
The value is required or not |
No |
validator |
A Validator object. Only values that match the validator can be set. |
No |
|
value |
String |
Value that going to be measured or configured |
Yes |
valueConstraint |
boolean |
State if this value is used to constrain another value and not define its own value. Used for secondary product offers like IMAGE_INSTANCE's permitted RAM and permitted CPU |
No |
Remarks
Note that key names have are to a certain extent magic: if the Value corresponds to a resource, for a resource, the key may use the following format: <RESOURCETYPE-ENUM.field>, which will automatically link it to the field name within the resource. For instance, to define ram in the server, use the key name SERVER.ram, which will automatically link to the ram value within the Server object. Alternatively, any alphanumeric string may be used
Note that Values cannot be queried via FQL.
PHP Example
$newValue->dataContent = "String Value"
$newValue->defaultText = "String Value"
$newValue->defaultValue = "String Value"
$newValue->description = "String Value"
$newValue->descriptionDetails = $ValueDescriptionDetailsObject
$newValue->hidden = TRUE
$newValue->key = "String Value"
$newValue->measureType = "MeasureType Value"
$newValue->name = "String Value"
$newValue->readOnly = TRUE
$newValue->recheckOnChange = TRUE
$newValue->remembered = TRUE
$newValue->required = TRUE
$newValue->validator = $ValueValidatorObject
$newValue->value = "String Value"
$newValue->valueConstraint = TRUE