com.datastax.bdp.graph.api.model

Interface EdgeLabel

All Superinterfaces:

Identified, Named

public interface EdgeLabel
extends Named, Identified

Represents a type of edge within the graph.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EdgeLabel.Builder
static class	EdgeLabel.Directionality The directionality of the edge.

Method Summary

Modifier and Type	Method and Description
PropertyKey	addPropertyKey(java.lang.String name) Register that a particular property key may be used on edges with this label.
Cardinality	cardinality()
EdgeLabel.Directionality	directionality()
void	drop() Drop the edge label from the graph.
void	dropPropertyKey(java.lang.String name) Drops the property key from this vertex label
java.util.Set<? extends PropertyKey>	propertyKeys()
java.util.Optional<java.time.Duration>	ttl()

Methods inherited from interface com.datastax.bdp.graph.api.Named

name

Methods inherited from interface com.datastax.bdp.graph.api.Identified

id

Method Detail

directionality

EdgeLabel.Directionality directionality()

Returns:

The directionality of the edge. Only bidirectional is supported.

ttl

java.util.Optional<java.time.Duration> ttl()

Returns:

The time to live for the relation type. Once expired the relation will be automatically removed.

cardinality

Cardinality cardinality()

Returns:

The cardinality of this edge label.

propertyKeys

java.util.Set<? extends PropertyKey> propertyKeys()

Returns:

All property keys associated with this edge label.

addPropertyKey

PropertyKey addPropertyKey(java.lang.String name)

Register that a particular property key may be used on edges with this label.

Parameters:

name - The property key name

drop

void drop()

Drop the edge label from the graph. The data is not actually removed.

dropPropertyKey

void dropPropertyKey(java.lang.String name)

Drops the property key from this vertex label

Parameters:

name - The property key to drop