Interface EdgeWrite

Edge to create or update

interface EdgeWrite {
    endNode: DirectRelationReference;
    existingVersion?: number;
    externalId: string;
    instanceType: "edge";
    sources?: EdgeOrNodeData[];
    space: string;
    startNode: DirectRelationReference;
    type: DirectRelationReference;
}

Properties

endNode existingVersion? externalId instanceType sources? space startNode type

Properties

endNode

endNode: DirectRelationReference

Reference to the node pointed to by the direct relation. The reference consists of a space and an external-id.

OptionalexistingVersion

existingVersion?: number

Fail the ingestion request if the edge's version is greater than this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the edge (for the specified container or view). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.

externalId

externalId: string

Unique alphanumeric identifier for the edge

instanceType

instanceType: "edge"

Optionalsources

sources?: EdgeOrNodeData[]

Properties to write to in a view or container, for the edge.

space

space: string

Id of the space that the edge belongs to. This id cannot be updated.

startNode

startNode: DirectRelationReference

Reference to the node pointed to by the direct relation. The reference consists of a space and an external-id.

type

type: DirectRelationReference

Edge type (direct relation)

Settings

Member Visibility

On This Page

Properties