Note params spec. When used, the end user will be able to select a note from the list of note available in the lab.
The accessible value will be NoteResource.
Attributes
PRIVATE_VISIBILITY: LiteralPROTECTED_VISIBILITY: LiteralPUBLIC_VISIBILITY: Literaladditional_info: Optionalallowed_values: Optionaldefault_value: Optionalhuman_name: Optionaloptional: boolshort_description: Optionalunit: Optionalvisibility: LiteralFunctions
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| optional | bool | False | See default value optional[str] |
| visibility | Literal | public | Visibility of the param, see doc on type paramspecvisibilty for more info paramspecvisibilty |
| human_name | Optional | Select note | Human readable name of the param, showed in the interface [str] |
| short_description | Optional | Description of the param, showed in the interface [str] |
Method call before the value is used (in task or view) to apply some transformation if needed by the ParamSpec. This does not affect the value in the database.
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| value | Any |
Return type:
Optional |
Return type:
ParamSpecType |
Override this method to return the model type to use
Return type:
Type |
Return type:
ParamSpecDTO |
Validate the value of the param and return the modified value if needed. This method is called when the param is set in the config before saving it in the database. The returned value must be serializable in json.l
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| value | Any |
Return type:
str |
Return type:
ParamSpec |
Return type:
str |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| spec_dto | ParamSpecDTO |
Return type:
ParamSpec |