tenant-api/viaduct.api.globalid/GlobalID

GlobalID

interface GlobalID<T : NodeCompositeOutput>(source)

GlobalIDs are objects in Viaduct that contain 'type' and 'internalID' properties. They are used to uniquely identify node objects in the graph.

GlobalID values support structural equality, as opposed to referential equality.

A GlobalID will be generated for fields with the @idOf(type:"T") directive.

Instances of GlobalID can be created using execution-context objects, e.g., ExecutionContext.nodeIDFor(User, 123).

Properties

Link copied to clipboard
abstract val internalID: String

The internal ID of the node object, e.g. 123.

Link copied to clipboard
abstract val type: Type<T>

The type of the node object, e.g. User.