com.datastax.bdp.graph.api.snapshot

Interface SnapshotBuilder

public interface SnapshotBuilder

Builds a persistent analytics-capable graph data snapshot.

Method Summary

Modifier and Type	Method and Description
SnapshotBuilder	conf(java.lang.String key, java.lang.String value) Set or override an arbitrary key-value string pair in the configuration of the Spark job used to create the snapshot.
org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource	create() Make the snapshot.
SnapshotBuilder	edges(java.lang.String... labels) Set the edge labels to retain in the snapshot.
SnapshotBuilder	vertices(java.lang.String... labels) Set the vertex labels to retain in the snapshot.

Method Detail

vertices

SnapshotBuilder vertices(java.lang.String... labels)

Set the vertex labels to retain in the snapshot.

If this method is never called on a SnapshotBuilder, then it retains all vertices regardless of label.

Parameters:

labels - one or more vertex label names to snapshot

Returns:

this builder

edges

SnapshotBuilder edges(java.lang.String... labels)

Set the edge labels to retain in the snapshot.

If this method is never called on a SnapshotBuilder, then it retains all edges regardless of label.

Parameters:

labels - one or more edge label names to snapshot

Returns:

this builder

conf

SnapshotBuilder conf(java.lang.String key,
                     java.lang.String value)

Set or override an arbitrary key-value string pair in the configuration of the Spark job used to create the snapshot.

Parameters:

key - the configuration option to modify

value - the configuraiton value

Returns:

this builder

create

org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource create()
                                                                              throws java.lang.InterruptedException,
                                                                                     java.util.concurrent.ExecutionException

Make the snapshot. Though the details are implementation dependent, callers should assume that this is a resource-intensive batch operation.

Returns:

a traversal source attached to the just-created snapshot

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException