Skip to content

EdgeEndpoint #

Bases: object

Entry point for filtering an edge endpoint (source or destination).

An EdgeEndpoint is obtained from Edge.src() or Edge.dst() and allows you to filter on endpoint fields (id, name, type) as well as endpoint properties and metadata.

Examples:

Edge.src().id() == 1 Edge.dst().name().starts_with("user:") Edge.src().property("country") == "UK"

id() #

Selects the endpoint node ID field for filtering.

Returns:

Type Description

filter.EdgeEndpointIdFilter

metadata(name) #

Filters an endpoint node metadata field by name.

Metadata is shared across all temporal versions of a node.

Parameters:

Name Type Description Default
name str

Metadata key.

required

Returns:

Type Description

filter.FilterOps

name() #

Selects the endpoint node name field for filtering.

Returns:

Type Description

filter.EdgeEndpointNameFilter

node_type() #

Selects the endpoint node type field for filtering.

Returns:

Type Description

filter.EdgeEndpointTypeFilter

property(name) #

Filters an endpoint node property by name.

The property may be static or temporal depending on the query context.

Parameters:

Name Type Description Default
name str

Property key.

required

Returns:

Type Description

filter.PropertyFilterOps