VariableManager

class VariableJsonSchema

Variable JSON Schema

Canonical

kortex_api.autogen.messages.VariableManager_pb2.VariableJsonSchema

Parameters

• schema_key (str) – The schema unique key

• json_schema (str) – The parseable json schema string

• friendly_name (str) – The schema friendly name

class VariableJsonSchemaList

Variable JSON Schema List

Canonical

kortex_api.autogen.messages.VariableManager_pb2.VariableJsonSchemaList

Parameters

json_schemas (VariableJsonSchema [ ]) – The variable JSON schema list

class VariableHandle

Variable Handle

Canonical

kortex_api.autogen.messages.VariableManager_pb2.VariableHandle

Parameters

• namespace_handle (NamespaceHandle) – Namespace handle

• identifier (str) – Variable identifier

class Variable

Variable Instance

Canonical

kortex_api.autogen.messages.VariableManager_pb2.Variable

Parameters

• handle (VariableHandle) – Variable Handle

• type (VariableType) – Variable Type

• bool_value (bool) – Boolean value (only filled if type is VARIABLE_TYPE_BOOL)

• number_value (float) – Number value (only filled if type is VARIABLE_TYPE_NUMBER)

• string_value (str) – String value (only filled if type is VARIABLE_TYPE_STRING)

• json_value (str) – JSON value (only filled if type is VARIABLE_TYPE_JSON)

• schema_key (str) – Schema key to use to type/describe a json variable. (only filled if type is VARIABLE_TYPE_JSON)

• flags (str [ ]) – Flags indicating special variables such as: home, retract, packaging. More could be added in the future.

• is_system (bool) – True if variable is system variable

• unit (str) – Variable unit. (only filled if type is VARIABLE_TYPE_NUMBER)

class NamespaceHandle

Namespace Handle

Canonical

kortex_api.autogen.messages.VariableManager_pb2.NamespaceHandle

Parameters

identifier (str) – Namespace identifier

class Namespaces

Namespaces

Canonical

kortex_api.autogen.messages.VariableManager_pb2.Namespaces

Parameters

namespaces (NamespaceHandle [ ]) – Namespaces

class DeleteNamespaceHandle

Delete Namespace Handle

Canonical

kortex_api.autogen.messages.VariableManager_pb2.DeleteNamespaceHandle

Parameters

• handle (NamespaceHandle) – Namespace Handle

• recursive (bool) – Indicates if we execute recursive deletion to sub-namespaces.

class NamespaceVariables

Namespace Variables

Canonical

kortex_api.autogen.messages.VariableManager_pb2.NamespaceVariables

Parameters

• handle (NamespaceHandle) – Namespace Handle

• variables (Variable [ ]) – List of variables within the namespace

class NamespaceVariablesList

List of Namespace Variables

Canonical

kortex_api.autogen.messages.VariableManager_pb2.NamespaceVariablesList

Parameters

namespace_variables (NamespaceVariables [ ]) – Namespace variables

class ConfigurationChangeNotification

Notification about a change in the configuration of variables & namespaces

Canonical

kortex_api.autogen.messages.VariableManager_pb2.ConfigurationChangeNotification

Parameters

• event (ConfigurationChangeEvent) – Event triggered

• timestamp (Timestamp) – This field is deprecated and will be removed in a future release

• user_handle (UserProfileHandle) – This field is deprecated and will be removed in a future release

• generic_info (NotificationInformation) – Generic notification information

• changed_variables (NamespaceVariablesList) – List of changed variables by namespace. Part of the event_info Oneof.

• deleted_variables (NamespaceVariablesList) –

  List of deleted variables by namespace. Part of the event_info Oneof.

• deleted_namespaces (Namespaces) –

  List of deleted namespaces. Part of the event_info Oneof.

class VariableJsonSchemasChangeNotification

Notification about an update in the avaialble variable JSON schemas

Canonical

kortex_api.autogen.messages.VariableManager_pb2.VariableJsonSchemasChangeNotification

Parameters

• json_schemas_list (VariableJsonSchemaList) – The variable JSON schema list

• generic_info (NotificationInformation) – Generic notification information

class InterpolateString

String to interpolate

Canonical

kortex_api.autogen.messages.VariableManager_pb2.InterpolateString

Parameters

interpolate_string (str) – String to interpolate