Representation of an add-on parameter.
Name | Type | Description | Notes |
---|---|---|---|
kind | str | Indicates the type of this object. Will be 'AddOnParameter' if this is a complete object or 'AddOnParameterLink' if it is just a link. | [optional] |
id | str | Unique identifier of the object. | [optional] |
href | str | Self link. | [optional] |
addon | AddOn | [optional] | |
conditions | list[AddOnRequirement] | Conditions in which this parameter is valid for | [optional] |
default_value | str | Indicates the value default for the add-on parameter. | [optional] |
description | str | Description of the add-on parameter. | [optional] |
editable | bool | Indicates if this parameter can be edited after creation. | [optional] |
editable_direction | str | Restricts if the parameter can be upscaled/downscaled Expected values are "up", "down", or "" (no restriction). | [optional] |
enabled | bool | Indicates if this parameter is enabled for the add-on. | [optional] |
name | str | Name of the add-on parameter. | [optional] |
options | list[AddOnParameterOption] | List of options for the add-on parameter value. | [optional] |
required | bool | Indicates if this parameter is required by the add-on. | [optional] |
validation | str | Validation rule for the add-on parameter. | [optional] |
validation_err_msg | str | Error message to return should the parameter be invalid. | [optional] |
value_type | str | Type of value of the add-on parameter. | [optional] |