flowserv.model.parameter.string module
Declarations for string parameter values. String parameters do not add any additional properties to the base parameter class.
- class flowserv.model.parameter.string.String(name: str, index: Optional[int] = 0, label: Optional[str] = None, help: Optional[str] = None, default: Optional[str] = None, required: Optional[bool] = False, group: Optional[str] = None)
Bases:
flowserv.model.parameter.base.ParameterString parameter type.
- cast(value: Any) str
Convert the given value into a string value.
- Parameters
value (any) – User-provided value for a template parameter.
- Return type
sting
- static from_dict(doc: Dict, validate: Optional[bool] = True) flowserv.model.parameter.string.String
Get string parameter instance from a given dictionary serialization.
- Parameters
doc (dict) – Dictionary serialization for string parameter delaration.
validate (bool, default=True) – Validate the serialized object if True.
- Return type
- Raises