class Mapping

August 13, 2019 ยท View on GitHub

Member values

Member nameData typeDescriptionUsage
handleMappingHandleMapping handle (do not set on createMapping() call)To set handle, you simply assign a value directly to a field within handle. You can also use the parent message's HasField() method to check if a message type field value has been set.
namestrMapping friendly nameYou can manipulate the field name as if it were a regular field. To clear the value of name and reset it to the default value for its type, you call the ClearField() method of the Message interface.
controller_identifierintAssociated controller identifierYou can manipulate the field controller_identifier as if it were a regular field. To clear the value of controller_identifier and reset it to the default value for its type, you call the ClearField() method of the Message interface.
active_map_group_handleMapGroupHandleCurrently active map group (not implemented yet)To set active_map_group_handle, you simply assign a value directly to a field within active_map_group_handle. You can also use the parent message's HasField() method to check if a message type field value has been set.
map_group_handlesMapGroupHandleArray of associated map groups (not implemented yet)Repeated message fields are represented as an object that acts like a Python sequence. However, You must use add() instead of append(). It also has an extend() function that appends an entire list of messages, but makes a copy of every message in the list.
active_map_handleMapHandleCurrently active mapTo set active_map_handle, you simply assign a value directly to a field within active_map_handle. You can also use the parent message's HasField() method to check if a message type field value has been set.
map_handlesMapHandleArray of associated mapsRepeated message fields are represented as an object that acts like a Python sequence. However, You must use add() instead of append(). It also has an extend() function that appends an entire list of messages, but makes a copy of every message in the list.
application_datastrApplication data (reserved for use by Web App)You can manipulate the field application_data as if it were a regular field. To clear the value of application_data and reset it to the default value for its type, you call the ClearField() method of the Message interface.

Parent topic: Base (Python)