Olympe SDK Interface: Writable

Interface: Writable

olympe .dc. Writable

Writable graph object, able to store nodes and edges.

<abstract> createInstance(tag [, properties] [, id])

Creates an instance and returns it's tag

Name	Type	Argument	Description
`tag`	string		New instance tag
`properties`	Map.<string, ?*>	<optional>	Instance's properties (map of properties names to values)
`id`	number	<optional>	operationId

<abstract> createRelation(relationTag, originTag, destinationTag [, id])

Creates a relation between two instances.

Name	Type	Argument	Description
`relationTag`	string		Tag of the relation
`originTag`	string		Origin instance tag
`destinationTag`	string		Destination instance tag
`id`	number	<optional>	operationId

<abstract> deleteInstance(tag [, followRule] [, id])

Deletes the specified instance. If specified, apply the follow rules to make a clean delete.

Name	Type	Argument	Description
`tag`	string
`followRule`	olympe.dc.FollowRules	<optional>
`id`	number	<optional>	operationId

<abstract> deleteRelation(relationTag, originTag, destinationTag [, id])

Removes a relation between two instances

Name	Type	Argument	Description
`relationTag`	string		Tag of the relation
`originTag`	string		Origin instance tag
`destinationTag`	string		Destination instance tag
`id`	number	<optional>	operationId

<abstract> updateInstance(tag [, properties] [, forceUpdate] [, id])

Updates an instance.

If the instance does not exist, it will be automatically created
Depending on the implementation, updates will be rejected if the provided "new" version is lower than the stored one

Name	Type	Argument	Default	Description
`tag`	string			Instance tag
`properties`	Map.<string, ?*>	<optional>		Instance properties
`forceUpdate`	boolean	<optional>	false	If true, do not do any version check and accepts any update (used by rollbacks)
`id`	number	<optional>		operationId