Menu
Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version
Publication date

Mar 9, 2022

Confidentiality
Public
Reactions
1
Share

LabModelParam

Lab model param spec. When used, the end user will be able to select a lab from the list of labs available in the system. The config stores only the lab model id.

The accessible value in task is a LabDTOWithCredentials containing the lab info and its resolved credentials data.

Attributes
PRIVATE_VISIBILITY: LiteralPROTECTED_VISIBILITY: LiteralPUBLIC_VISIBILITY: Literaladditional_info: dict | Nonedefault_value: Optionalhuman_name: str | Noneoptional: boolshort_description: str | Nonevisibility: Literal
Functions
__init__
optional : bool - False
See default value
visibility : Literal - public
Visibility of the param, see doc on type ParamSpecVisibilty for more info
human_name : str | None
Human readable name of the param, showed in the interface
short_description : str | None
Description of the param, showed in the interface
build

Retrieve the LabModel by id and return its DTO with credentials.

value : Any
Return type : gws_core.lab.lab_model.lab_dto.LabDTOWithCredentials | None
get_default_value
Return type : Any
to_dto
Return type : ParamSpecDTO
to_simple_dto
Return type : ParamSpecSimpleDTO
validate

Extract the id from LabModel, dict, or string.

value : Any
Return type : str
empty @classmethod
Return type : ParamSpec
get_additional_infos @classmethod
Return type : dict[str, gws_core.config.param.param_types.ParamSpecDTO] | None
get_default_value_param_spec @classmethod
Return type : LabModelParam
get_str_type @classmethod
Return type : ParamSpecTypeStr
load_from_dto @classmethod
spec_dto : ParamSpecDTO
Return type : ParamSpec
to_param_spec_info_specs @classmethod
Return type : ParamSpecInfoSpecs
Shine Logo
Technical bricks to reuse or customize

Have you developed a brick?

Share it to accelerate projects for the entire community.