kappa_sdk.user_tasks.ParametersDictionary#
- class kappa_sdk.user_tasks.ParametersDictionary(*args, **kwargs)[source]#
Defines a protocol for a dictionary-like object with specific parameter types and behavior.
The ParametersDictionary protocol is used to describe an interface for objects that act as dictionaries, providing methods to get, set, and access key-value pairs where the keys are strings, and the values can be one of a defined set of types.
Methods
Access to the class like a real dictionary :returns:
key,valuesofthe classGet only the keys (parameter names) of the parameters :returns:
Keysofthe parametersGet only the values of the parameters :returns:
Valuesofthe parameters- __getitem__(parameter_name)[source]#
Gets the value of the user task parameter identified by its name.
- Parameters:
parameter_name (
str) – The name of the user task parameter.- Return type:
bool | UUID | datetime | float | int | str | None
- __setitem__(parameter_name, value)[source]#
Sets the value of the user task parameter identified by its name.
- Parameters:
parameter_name (
str) – The name of the user task parameter.value (bool | UUID | datetime | float | int | str | None)
- Return type:
None
- items()[source]#
Access to the class like a real dictionary :returns:
key,valuesofthe class- Return type:
ItemsView[str, Any]
- keys()[source]#
Get only the keys (parameter names) of the parameters :returns:
Keysofthe parameters- Return type:
KeysView[str]
- values()[source]#
Get only the values of the parameters :returns:
Valuesofthe parameters- Return type:
List[Any]
- __init__(*args, **kwargs)#