com.datastax.bdp.graph.api.model

Interface VertexLabel.Builder

Enclosing interface:

VertexLabel

public static interface VertexLabel.Builder

Method Summary

Modifier and Type	Method and Description
VertexLabel	add() Create and add the vertex label to the schema.
VertexLabel.Builder	addAdjacency(java.lang.String edgeLabel, org.apache.tinkerpop.gremlin.structure.Direction direction, java.lang.String adjacentVertexLabel) Add an adjacency to the vertex label
default VertexLabel.Builder	addAdjacency(java.lang.String edgeLabel, java.lang.String adjacentVertexLabel) Add an adjacency to the vertex label in both directions
VertexLabel.Builder	addPropertyKeys(java.lang.String... propertyKeys) Add property keys to the vertex label
default VertexLabel.Builder	clusteringId(java.lang.String propertyKey) Adds the given property key as a clustering ID to this vertex labels custom vertex id.
VertexLabel.Builder	idComponent(PropertyKey propertyKey, IdPropertyKey.Type type) Add a key that makes up the id component of this vertex label.
VertexLabel.Builder	idComponent(java.lang.String propertyKey, IdPropertyKey.Type type) Add a key that makes up the ID component of this vertex label.
VertexLabel.Builder	ifNotExists()
default VertexLabel.Builder	partitionId(java.lang.String propertyKey) Adds the given property key as a partition ID to this vertex labels custom vertex id.
VertexLabel.Builder	ttl(java.time.Duration ttl)

Method Detail

add

VertexLabel add()

Create and add the vertex label to the schema.

Returns:

The added vertex label.

ttl

VertexLabel.Builder ttl(java.time.Duration ttl)

Parameters:

ttl - The time to live for the vertex label. Once expired the vertex will be automatically removed.

Returns:

This builder.

idComponent

VertexLabel.Builder idComponent(java.lang.String propertyKey,
                                IdPropertyKey.Type type)

Add a key that makes up the ID component of this vertex label. Id properties must be set upon vertex construction and cannot be changed later. If no ID components are added then the default ID components will be used. If custom ids are used then at least one component of type IdPropertyKey.Type.Partition is required.

Parameters:

propertyKey - The name of the property key. This key already have been defined.

type - The type of the id component as defined in IdPropertyKey.Type.

Returns:

This builder.

partitionId

default VertexLabel.Builder partitionId(java.lang.String propertyKey)

Adds the given property key as a partition ID to this vertex labels custom vertex id.

Parameters:

propertyKey - The name of the property key. This key already have been defined.

Returns:

This builder.

See Also:

idComponent(String, IdPropertyKey.Type)

clusteringId

default VertexLabel.Builder clusteringId(java.lang.String propertyKey)

Adds the given property key as a clustering ID to this vertex labels custom vertex id.

Parameters:

propertyKey - The name of the property key. This key already have been defined.

Returns:

This builder.

idComponent

VertexLabel.Builder idComponent(PropertyKey propertyKey,
                                IdPropertyKey.Type type)

Add a key that makes up the id component of this vertex label.

Parameters:

propertyKey - The property key.

type - The type of the id component.

Returns:

This builder.

See Also:

idComponent(String, IdPropertyKey.Type)

addPropertyKeys

VertexLabel.Builder addPropertyKeys(java.lang.String... propertyKeys)

Add property keys to the vertex label

Parameters:

propertyKeys - The property key.

addAdjacency

VertexLabel.Builder addAdjacency(java.lang.String edgeLabel,
                                 org.apache.tinkerpop.gremlin.structure.Direction direction,
                                 java.lang.String adjacentVertexLabel)

Add an adjacency to the vertex label

Parameters:

edgeLabel - The name of the edge label

direction - The direction of the allowed edge. May be IN, OUT or BOTH

adjacentVertexLabel - The name of adjacent vertex label

addAdjacency

default VertexLabel.Builder addAdjacency(java.lang.String edgeLabel,
                                         java.lang.String adjacentVertexLabel)

Add an adjacency to the vertex label in both directions

Parameters:

edgeLabel - The name of the edge label

adjacentVertexLabel - The name of adjacent vertex label

ifNotExists

VertexLabel.Builder ifNotExists()

Returns:

if the vertex label already exists then just return it.