Credentials params spec. When used, the end user will be able to select a credentials from the list of credentials available in the lab. The config stores only the credentials name but not the credentials data (key, password). The credentials data is retrieved from the credentials service just before the execution of the task or view.
The accessible value in task in a dictionary, it depends on the credentials type. See the documentation of the credentials type for more info.
Attributes
PRIVATE_VISIBILITY: LiteralPROTECTED_VISIBILITY: LiteralPUBLIC_VISIBILITY: Literaladditional_info: Optionalallowed_values: Optionaldefault_value: Optionalhuman_name: Optionaloptional: boolshort_description: Optionalunit: Optionalvisibility: LiteralFunctions
| Name | Type | Default value | Description |
|---|---|---|---|
| credentials_type | CredentialsType | Type of credentials to use for this param (if empty, any credentials can be used) | |
| 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 credentials | 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.
| Name | Type | Default value | Description |
|---|---|---|---|
| value | Any |
dict |
ParamSpecType |
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
| Name | Type | Default value | Description |
|---|---|---|---|
| value | Any |
str |
ParamSpec |
str |
| Name | Type | Default value | Description |
|---|---|---|---|
| spec_dto | ParamSpecDTO |
ParamSpec |