Graph (Vertexium: Core 2.5.7 API)

All Known Subinterfaces:

GraphWithSearchIndex

All Known Implementing Classes:

GraphBase, GraphBaseWithSearchIndex
```
public interface Graph
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Edge`	`addEdge(String edgeId, String outVertexId, String inVertexId, String label, Visibility visibility, Authorizations authorizations)` Adds an edge between two vertices.
`Edge`	`addEdge(String outVertexId, String inVertexId, String label, Visibility visibility, Authorizations authorizations)` Adds an edge between two vertices.
`Edge`	`addEdge(String edgeId, Vertex outVertex, Vertex inVertex, String label, Visibility visibility, Authorizations authorizations)` Adds an edge between two vertices.
`Edge`	`addEdge(Vertex outVertex, Vertex inVertex, String label, Visibility visibility, Authorizations authorizations)` Adds an edge between two vertices.
`void`	`addGraphEventListener(GraphEventListener graphEventListener)` Adds a graph event listener that will be called when graph events occur.
`Vertex`	`addVertex(String vertexId, Visibility visibility, Authorizations authorizations)` Adds a vertex to the graph.
`Vertex`	`addVertex(Visibility visibility, Authorizations authorizations)` Adds a vertex to the graph.
`Iterable<Vertex>`	`addVertices(Iterable<ElementBuilder<Vertex>> vertices, Authorizations authorizations)` Adds the vertices to the graph.
`Authorizations`	`createAuthorizations(Authorizations auths, Collection<String> additionalAuthorizations)` Creates an authorizations object combining auths and additionalAuthorizations.
`Authorizations`	`createAuthorizations(Authorizations auths, String... additionalAuthorizations)` Creates an authorizations object combining auths and additionalAuthorizations.
`Authorizations`	`createAuthorizations(Collection<String> auths)` Creates an authorizations object.
`Authorizations`	`createAuthorizations(String... auths)` Creates an authorizations object.
`DefinePropertyBuilder`	`defineProperty(String propertyName)` Creates a defines property builder.
`void`	`deleteEdge(Edge edge, Authorizations authorizations)` Permanently deletes an edge from the graph.
`void`	`deleteEdge(String edgeId, Authorizations authorizations)` Permanently deletes an edge from the graph.
`void`	`deleteVertex(String vertexId, Authorizations authorizations)` Permanently deletes a vertex from the graph.
`void`	`deleteVertex(Vertex vertex, Authorizations authorizations)` Permanently deletes a vertex from the graph.
`Map<String,Boolean>`	`doEdgesExist(Iterable<String> ids, Authorizations authorizations)` Tests the existence of edges with the given authorizations.
`Map<String,Boolean>`	`doEdgesExist(Iterable<String> ids, Long endTime, Authorizations authorizations)` Tests the existence of edges with the given authorizations.
`boolean`	`doesEdgeExist(String edgeId, Authorizations authorizations)` Tests the existence of a edge with the given authorizations.
`boolean`	`doesVertexExist(String vertexId, Authorizations authorizations)` Tests the existence of a vertex with the given authorizations.
`Map<String,Boolean>`	`doVerticesExist(Iterable<String> ids, Authorizations authorizations)` Tests the existence of vertices with the given authorizations.
`void`	`drop()` Drops all tables
`Iterable<String>`	`filterEdgeIdsByAuthorization(Iterable<String> edgeIds, String authorizationToMatch, EnumSet<ElementFilter> filters, Authorizations authorizations)` Filters a collection of edge ids by the authorizations of that edge, properties, etc.
`Iterable<String>`	`filterVertexIdsByAuthorization(Iterable<String> vertexIds, String authorizationToMatch, EnumSet<ElementFilter> filters, Authorizations authorizations)` Filters a collection of vertex ids by the authorizations of that vertex, properties, etc.
`Iterable<Path>`	`findPaths(FindPathOptions options, Authorizations authorizations)` Finds all paths between two vertices.
`Iterable<Path>`	`findPaths(String sourceVertexId, String destVertexId, int maxHops, Authorizations authorizations)` Deprecated. Use `findPaths(FindPathOptions, Authorizations)`
`Iterable<Path>`	`findPaths(String sourceVertexId, String destVertexId, int maxHops, ProgressCallback progressCallback, Authorizations authorizations)` Deprecated. Use `findPaths(FindPathOptions, Authorizations)`
`Iterable<Path>`	`findPaths(String sourceVertexId, String destVertexId, String[] labels, int maxHops, Authorizations authorizations)` Deprecated. Use `findPaths(FindPathOptions, Authorizations)`
`Iterable<Path>`	`findPaths(String sourceVertexId, String destVertexId, String[] labels, int maxHops, ProgressCallback progressCallback, Authorizations authorizations)` Deprecated. Use `findPaths(FindPathOptions, Authorizations)`
`Iterable<String>`	`findRelatedEdgeIds(Iterable<String> vertexIds, Authorizations authorizations)` Given a list of vertex ids, find all the edge ids that connect them.
`Iterable<String>`	`findRelatedEdgeIds(Iterable<String> vertexIds, Long endTime, Authorizations authorizations)` Given a list of vertex ids, find all the edge ids that connect them.
`Iterable<String>`	`findRelatedEdgeIdsForVertices(Iterable<Vertex> vertices, Authorizations authorizations)` Given a list of vertices, find all the edge ids that connect them.
`Iterable<String>`	`findRelatedEdges(Iterable<String> vertexIds, Authorizations authorizations)` Deprecated.
`Iterable<String>`	`findRelatedEdges(Iterable<String> vertexIds, Long endTime, Authorizations authorizations)` Deprecated.
`Iterable<RelatedEdge>`	`findRelatedEdgeSummary(Iterable<String> vertexIds, Authorizations authorizations)` Given a list of vertex ids, find all the edges that connect them.
`Iterable<RelatedEdge>`	`findRelatedEdgeSummary(Iterable<String> vertexIds, Long endTime, Authorizations authorizations)` Given a list of vertex ids, find all the edges that connect them.
`Iterable<RelatedEdge>`	`findRelatedEdgeSummaryForVertices(Iterable<Vertex> vertices, Authorizations authorizations)` Given a list of vertices, find all the edges that connect them.
`void`	`flush()` Flushes any pending mutations to the graph.
`Edge`	`getEdge(String edgeId, Authorizations authorizations)` Get an edge from the graph.
`Edge`	`getEdge(String edgeId, EnumSet<FetchHint> fetchHints, Authorizations authorizations)` Get an edge from the graph.
`Edge`	`getEdge(String edgeId, EnumSet<FetchHint> fetchHints, Long endTime, Authorizations authorizations)` Get an edge from the graph.
`long`	`getEdgeCount(Authorizations authorizations)` Gets a count of the number of edges in the system.
`Iterable<Edge>`	`getEdges(Authorizations authorizations)` Gets all edges on the graph.
`Iterable<Edge>`	`getEdges(EnumSet<FetchHint> fetchHints, Authorizations authorizations)` Gets all edges on the graph.
`Iterable<Edge>`	`getEdges(EnumSet<FetchHint> fetchHints, Long endTime, Authorizations authorizations)` Gets all edges on the graph.
`Iterable<Edge>`	`getEdges(Iterable<String> ids, Authorizations authorizations)` Gets all edges on the graph matching the given ids.
`Iterable<Edge>`	`getEdges(Iterable<String> ids, EnumSet<FetchHint> fetchHints, Authorizations authorizations)` Gets all edges on the graph matching the given ids.
`Iterable<Edge>`	`getEdges(Iterable<String> ids, EnumSet<FetchHint> fetchHints, Long endTime, Authorizations authorizations)` Gets all edges on the graph matching the given ids.
`Iterable<Edge>`	`getEdgesInRange(Range idRange, Authorizations authorizations)` Gets edges from the graph in the given range.
`Iterable<Edge>`	`getEdgesInRange(Range idRange, EnumSet<FetchHint> fetchHints, Authorizations authorizations)` Gets edges from the graph in the given range.
`Iterable<Edge>`	`getEdgesInRange(Range idRange, EnumSet<FetchHint> fetchHints, Long endTime, Authorizations authorizations)` Gets edges from the graph in the given range.
`IdGenerator`	`getIdGenerator()` Gets the id generator used by this graph to create ids.
`Iterable<GraphMetadataEntry>`	`getMetadata()` Gets all metadata.
`Object`	`getMetadata(String key)` Gets metadata from the graph.
`Iterable<GraphMetadataEntry>`	`getMetadataWithPrefix(String prefix)` Gets all metadata with the given prefix.
`PropertyDefinition`	`getPropertyDefinition(String propertyName)` Gets the property definition for the given name.
`Collection<PropertyDefinition>`	`getPropertyDefinitions()` Gets all property definitions.
`SearchIndexSecurityGranularity`	`getSearchIndexSecurityGranularity()` Gets the granularity of the search index `SearchIndexSecurityGranularity`
`List<InputStream>`	`getStreamingPropertyValueInputStreams(List<StreamingPropertyValue> streamingPropertyValues)` Opens multiple StreamingPropertyValue input streams at once.
`Vertex`	`getVertex(String vertexId, Authorizations authorizations)` Get a vertex from the graph.
`Vertex`	`getVertex(String vertexId, EnumSet<FetchHint> fetchHints, Authorizations authorizations)` Get a vertex from the graph.
`Vertex`	`getVertex(String vertexId, EnumSet<FetchHint> fetchHints, Long endTime, Authorizations authorizations)` Get a vertex from the graph.
`long`	`getVertexCount(Authorizations authorizations)` Gets a count of the number of vertices in the system.
`Map<Object,Long>`	`getVertexPropertyCountByValue(String propertyName, Authorizations authorizations)` Gets the number of times a property with a given value occurs on vertices
`Iterable<Vertex>`	`getVertices(Authorizations authorizations)` Gets all vertices on the graph.
`Iterable<Vertex>`	`getVertices(EnumSet<FetchHint> fetchHints, Authorizations authorizations)` Gets all vertices on the graph.
`Iterable<Vertex>`	`getVertices(EnumSet<FetchHint> fetchHints, Long endTime, Authorizations authorizations)` Gets all vertices on the graph.
`Iterable<Vertex>`	`getVertices(Iterable<String> ids, Authorizations authorizations)` Gets all vertices matching the given ids on the graph.
`Iterable<Vertex>`	`getVertices(Iterable<String> ids, EnumSet<FetchHint> fetchHints, Authorizations authorizations)` Gets all vertices matching the given ids on the graph.
`Iterable<Vertex>`	`getVertices(Iterable<String> ids, EnumSet<FetchHint> fetchHints, Long endTime, Authorizations authorizations)` Gets all vertices matching the given ids on the graph.
`List<Vertex>`	`getVerticesInOrder(Iterable<String> ids, Authorizations authorizations)` Gets all vertices matching the given ids on the graph.
`List<Vertex>`	`getVerticesInOrder(Iterable<String> ids, EnumSet<FetchHint> fetchHints, Authorizations authorizations)` Gets all vertices matching the given ids on the graph.
`Iterable<Vertex>`	`getVerticesInRange(Range idRange, Authorizations authorizations)` Gets vertices from the graph in the given range.
`Iterable<Vertex>`	`getVerticesInRange(Range idRange, EnumSet<FetchHint> fetchHints, Authorizations authorizations)` Gets vertices from the graph in the given range.
`Iterable<Vertex>`	`getVerticesInRange(Range idRange, EnumSet<FetchHint> fetchHints, Long endTime, Authorizations authorizations)` Gets vertices from the graph in the given range.
`Iterable<Vertex>`	`getVerticesWithPrefix(String vertexIdPrefix, Authorizations authorizations)` Gets vertices from the graph given the prefix.
`Iterable<Vertex>`	`getVerticesWithPrefix(String vertexIdPrefix, EnumSet<FetchHint> fetchHints, Authorizations authorizations)` Gets vertices from the graph given the prefix.
`Iterable<Vertex>`	`getVerticesWithPrefix(String vertexIdPrefix, EnumSet<FetchHint> fetchHints, Long endTime, Authorizations authorizations)` Gets vertices from the graph given the prefix.
`boolean`	`isFieldBoostSupported()` Determine if field boost is support.
`boolean`	`isPropertyDefined(String propertyName)` Determine if a property is already defined
`boolean`	`isQuerySimilarToTextSupported()` Returns true if this graph supports similar to text queries.
`boolean`	`isVisibilityValid(Visibility visibility, Authorizations authorizations)` Given an authorization is the visibility object valid.
`void`	`markEdgeHidden(Edge edge, Visibility visibility, Authorizations authorizations)` Marks an edge as hidden for a given visibility.
`void`	`markEdgeVisible(Edge edge, Visibility visibility, Authorizations authorizations)` Marks an edge as visible for a given visibility, effectively undoing markEdgeHidden.
`void`	`markVertexHidden(Vertex vertex, Visibility visibility, Authorizations authorizations)` Marks a vertex as hidden for a given visibility.
`void`	`markVertexVisible(Vertex vertex, Visibility visibility, Authorizations authorizations)` Marks a vertex as visible for a given visibility, effectively undoing markVertexHidden.
`EdgeBuilderByVertexId`	`prepareEdge(String edgeId, String outVertexId, String inVertexId, String label, Long timestamp, Visibility visibility)` Prepare an edge to be added to the graph.
`EdgeBuilderByVertexId`	`prepareEdge(String edgeId, String outVertexId, String inVertexId, String label, Visibility visibility)` Prepare an edge to be added to the graph.
`EdgeBuilderByVertexId`	`prepareEdge(String outVertexId, String inVertexId, String label, Visibility visibility)` Prepare an edge to be added to the graph.
`EdgeBuilder`	`prepareEdge(String edgeId, Vertex outVertex, Vertex inVertex, String label, Long timestamp, Visibility visibility)` Prepare an edge to be added to the graph.
`EdgeBuilder`	`prepareEdge(String edgeId, Vertex outVertex, Vertex inVertex, String label, Visibility visibility)` Prepare an edge to be added to the graph.
`EdgeBuilder`	`prepareEdge(Vertex outVertex, Vertex inVertex, String label, Visibility visibility)` Prepare an edge to be added to the graph.
`VertexBuilder`	`prepareVertex(Long timestamp, Visibility visibility)` Prepare a vertex to be added to the graph.
`VertexBuilder`	`prepareVertex(String vertexId, Long timestamp, Visibility visibility)` Prepare a vertex to be added to the graph.
`VertexBuilder`	`prepareVertex(String vertexId, Visibility visibility)` Prepare a vertex to be added to the graph.
`VertexBuilder`	`prepareVertex(Visibility visibility)` Prepare a vertex to be added to the graph.
`GraphQuery`	`query(Authorizations authorizations)` Creates a query builder object used to query the graph.
`MultiVertexQuery`	`query(String[] vertexIds, Authorizations authorizations)` Creates a query builder object used to query a list of vertices.
`MultiVertexQuery`	`query(String[] vertexIds, String queryString, Authorizations authorizations)` Creates a query builder object used to query a list of vertices.
`GraphQuery`	`query(String queryString, Authorizations authorizations)` Creates a query builder object used to query the graph.
`SimilarToGraphQuery`	`querySimilarTo(String[] fields, String text, Authorizations authorizations)` Creates a query builder object that finds all vertices similar to the given text for the specified fields.
`void`	`reindex(Authorizations authorizations)` Reindex all vertices and edges.
`Iterable<Element>`	`saveElementMutations(Iterable<ElementMutation> mutations, Authorizations authorizations)` Saves multiple mutations with a single call.
`void`	`savePropertyDefinition(PropertyDefinition propertyDefinition)` Save a pre-made property definition.
`void`	`setMetadata(String key, Object value)` Sets metadata on the graph.
`void`	`shutdown()` Cleans up or disconnects from the underlying storage.
`void`	`softDeleteEdge(Edge edge, Authorizations authorizations)` Soft deletes an edge from the graph.
`void`	`softDeleteEdge(Edge edge, Long timestamp, Authorizations authorizations)` Soft deletes an edge from the graph.
`void`	`softDeleteEdge(String edgeId, Authorizations authorizations)` Soft deletes an edge from the graph.
`void`	`softDeleteEdge(String edgeId, Long timestamp, Authorizations authorizations)` Soft deletes an edge from the graph.
`void`	`softDeleteVertex(String vertexId, Authorizations authorizations)` Soft deletes a vertex from the graph.
`void`	`softDeleteVertex(String vertexId, Long timestamp, Authorizations authorizations)` Soft deletes a vertex from the graph.
`void`	`softDeleteVertex(Vertex vertex, Authorizations authorizations)` Soft deletes a vertex from the graph.
`void`	`softDeleteVertex(Vertex vertex, Long timestamp, Authorizations authorizations)` Soft deletes a vertex from the graph.
`void`	`truncate()` Clears all data from the graph.

- Method Detail
  - addVertex
```
Vertex addVertex(Visibility visibility,
                 Authorizations authorizations)
```
    Adds a vertex to the graph. The id of the new vertex will be generated using an IdGenerator.
    
    Parameters:
    
    visibility - The visibility to assign to the new vertex.
    
    authorizations - The authorizations required to add and retrieve the new vertex.
    
    Returns:
    
    The newly added vertex.
  - addVertex
```
Vertex addVertex(String vertexId,
                 Visibility visibility,
                 Authorizations authorizations)
```
    Adds a vertex to the graph.
    
    Parameters:
    
    vertexId - The id to assign the new vertex.
    
    visibility - The visibility to assign to the new vertex.
    
    authorizations - The authorizations required to add and retrieve the new vertex.
    
    Returns:
    
    The newly added vertex.
  - addVertices
```
Iterable<Vertex> addVertices(Iterable<ElementBuilder<Vertex>> vertices,
                             Authorizations authorizations)
```
    Adds the vertices to the graph.
    
    Parameters:
    
    vertices - The vertices to add.
    
    authorizations - The authorizations required to add and retrieve the new vertex.
    
    Returns:
    
    The vertices.
  - prepareVertex
```
VertexBuilder prepareVertex(Visibility visibility)
```
    Prepare a vertex to be added to the graph. This method provides a way to build up a vertex with it's properties to be inserted with a single operation. The id of the new vertex will be generated using an IdGenerator.
    
    Parameters:
    
    visibility - The visibility to assign to the new vertex.
    
    Returns:
    
    The vertex builder.
  - prepareVertex
```
VertexBuilder prepareVertex(Long timestamp,
                            Visibility visibility)
```
    Prepare a vertex to be added to the graph. This method provides a way to build up a vertex with it's properties to be inserted with a single operation. The id of the new vertex will be generated using an IdGenerator.
    
    Parameters:
    
    timestamp - The timestamp of the vertex. null, to use the system generated time.
    
    visibility - The visibility to assign to the new vertex.
    
    Returns:
    
    The vertex builder.
  - prepareVertex
```
VertexBuilder prepareVertex(String vertexId,
                            Visibility visibility)
```
    Prepare a vertex to be added to the graph. This method provides a way to build up a vertex with it's properties to be inserted with a single operation.
    
    Parameters:
    
    vertexId - The id to assign the new vertex.
    
    visibility - The visibility to assign to the new vertex.
    
    Returns:
    
    The vertex builder.
  - prepareVertex
```
VertexBuilder prepareVertex(String vertexId,
                            Long timestamp,
                            Visibility visibility)
```
    Prepare a vertex to be added to the graph. This method provides a way to build up a vertex with it's properties to be inserted with a single operation.
    
    Parameters:
    
    vertexId - The id to assign the new vertex.
    
    timestamp - The timestamp of the vertex.
    
    visibility - The visibility to assign to the new vertex.
    
    Returns:
    
    The vertex builder.
  - doesVertexExist
```
boolean doesVertexExist(String vertexId,
                        Authorizations authorizations)
```
    Tests the existence of a vertex with the given authorizations.
    
    Parameters:
    
    vertexId - The vertex id to check existence of.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    True if vertex exists.
  - getVertex
```
Vertex getVertex(String vertexId,
                 Authorizations authorizations)
```
    Get a vertex from the graph.
    
    Parameters:
    
    vertexId - The vertex id to retrieve from the graph.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    The vertex if successful. null if the vertex is not found or the required authorizations were not provided.
  - getVertex
```
Vertex getVertex(String vertexId,
                 EnumSet<FetchHint> fetchHints,
                 Authorizations authorizations)
```
    Get a vertex from the graph.
    
    Parameters:
    
    vertexId - The vertex id to retrieve from the graph.
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    The vertex if successful. null if the vertex is not found or the required authorizations were not provided.
  - getVertex
```
Vertex getVertex(String vertexId,
                 EnumSet<FetchHint> fetchHints,
                 Long endTime,
                 Authorizations authorizations)
```
    Get a vertex from the graph.
    
    Parameters:
    
    vertexId - The vertex id to retrieve from the graph.
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    endTime - Include all changes made up until the point in time.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    The vertex if successful. null if the vertex is not found or the required authorizations were not provided.
  - getVerticesWithPrefix
```
Iterable<Vertex> getVerticesWithPrefix(String vertexIdPrefix,
                                       Authorizations authorizations)
```
    Gets vertices from the graph given the prefix.
    
    Parameters:
    
    vertexIdPrefix - The prefix of the vertex ids to retrieve from the graph.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    The vertex if successful. null if the vertex is not found or the required authorizations were not provided.
  - getVerticesWithPrefix
```
Iterable<Vertex> getVerticesWithPrefix(String vertexIdPrefix,
                                       EnumSet<FetchHint> fetchHints,
                                       Authorizations authorizations)
```
    Gets vertices from the graph given the prefix.
    
    Parameters:
    
    vertexIdPrefix - The prefix of the vertex ids to retrieve from the graph.
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    The vertex if successful. null if the vertex is not found or the required authorizations were not provided.
  - getVerticesWithPrefix
```
Iterable<Vertex> getVerticesWithPrefix(String vertexIdPrefix,
                                       EnumSet<FetchHint> fetchHints,
                                       Long endTime,
                                       Authorizations authorizations)
```
    Gets vertices from the graph given the prefix.
    
    Parameters:
    
    vertexIdPrefix - The prefix of the vertex ids to retrieve from the graph.
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    endTime - Include all changes made up until the point in time.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    The vertex if successful. null if the vertex is not found or the required authorizations were not provided.
  - getVerticesInRange
```
Iterable<Vertex> getVerticesInRange(Range idRange,
                                    Authorizations authorizations)
```
    Gets vertices from the graph in the given range.
    
    Parameters:
    
    idRange - The range of ids to get.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    The vertices in the range.
  - getVerticesInRange
```
Iterable<Vertex> getVerticesInRange(Range idRange,
                                    EnumSet<FetchHint> fetchHints,
                                    Authorizations authorizations)
```
    Gets vertices from the graph in the given range.
    
    Parameters:
    
    idRange - The range of ids to get.
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    The vertices in the range.
  - getVerticesInRange
```
Iterable<Vertex> getVerticesInRange(Range idRange,
                                    EnumSet<FetchHint> fetchHints,
                                    Long endTime,
                                    Authorizations authorizations)
```
    Gets vertices from the graph in the given range.
    
    Parameters:
    
    idRange - The range of ids to get.
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    endTime - Include all changes made up until the point in time.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    The vertices in the range.
  - getVertices
```
Iterable<Vertex> getVertices(Authorizations authorizations)
```
    Gets all vertices on the graph.
    
    Parameters:
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    An iterable of all the vertices.
  - getVertices
```
Iterable<Vertex> getVertices(EnumSet<FetchHint> fetchHints,
                             Authorizations authorizations)
```
    Gets all vertices on the graph.
    
    Parameters:
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    An iterable of all the vertices.
  - getVertices
```
Iterable<Vertex> getVertices(EnumSet<FetchHint> fetchHints,
                             Long endTime,
                             Authorizations authorizations)
```
    Gets all vertices on the graph.
    
    Parameters:
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    endTime - Include all changes made up until the point in time.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    An iterable of all the vertices.
  - doVerticesExist
```
Map<String,Boolean> doVerticesExist(Iterable<String> ids,
                                    Authorizations authorizations)
```
    Tests the existence of vertices with the given authorizations.
    
    Parameters:
    
    ids - The vertex ids to check existence of.
    
    authorizations - The authorizations required to load the vertices.
    
    Returns:
    
    Map of ids to exists status.
  - getVertices
```
Iterable<Vertex> getVertices(Iterable<String> ids,
                             Authorizations authorizations)
```
    Gets all vertices matching the given ids on the graph. The order of the returned vertices is not guaranteed getVerticesInOrder(Iterable, Authorizations). Vertices are not kept in memory during the iteration.
    
    Parameters:
    
    ids - The ids of the vertices to get.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    An iterable of all the vertices.
  - getVertices
```
Iterable<Vertex> getVertices(Iterable<String> ids,
                             EnumSet<FetchHint> fetchHints,
                             Authorizations authorizations)
```
    Gets all vertices matching the given ids on the graph. The order of the returned vertices is not guaranteed getVerticesInOrder(Iterable, Authorizations). Vertices are not kept in memory during the iteration.
    
    Parameters:
    
    ids - The ids of the vertices to get.
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    An iterable of all the vertices.
  - getVertices
```
Iterable<Vertex> getVertices(Iterable<String> ids,
                             EnumSet<FetchHint> fetchHints,
                             Long endTime,
                             Authorizations authorizations)
```
    Gets all vertices matching the given ids on the graph. The order of the returned vertices is not guaranteed getVerticesInOrder(Iterable, Authorizations). Vertices are not kept in memory during the iteration.
    
    Parameters:
    
    ids - The ids of the vertices to get.
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    endTime - Include all changes made up until the point in time.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    An iterable of all the vertices.
  - getVerticesInOrder
```
List<Vertex> getVerticesInOrder(Iterable<String> ids,
                                Authorizations authorizations)
```
    Gets all vertices matching the given ids on the graph. This method is similar to getVertices(Iterable, Authorizations) but returns the vertices in the order that you passed in the ids. This requires loading all the vertices in memory to sort them.
    
    Parameters:
    
    ids - The ids of the vertices to get.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    An iterable of all the vertices.
  - getVerticesInOrder
```
List<Vertex> getVerticesInOrder(Iterable<String> ids,
                                EnumSet<FetchHint> fetchHints,
                                Authorizations authorizations)
```
    Gets all vertices matching the given ids on the graph. This method is similar to getVertices(Iterable, Authorizations) but returns the vertices in the order that you passed in the ids. This requires loading all the vertices in memory to sort them.
    
    Parameters:
    
    ids - The ids of the vertices to get.
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    An iterable of all the vertices.
  - deleteVertex
```
void deleteVertex(Vertex vertex,
                  Authorizations authorizations)
```
    Permanently deletes a vertex from the graph.
    
    Parameters:
    
    vertex - The vertex to delete.
    
    authorizations - The authorizations required to delete the vertex.
  - deleteVertex
```
void deleteVertex(String vertexId,
                  Authorizations authorizations)
```
    Permanently deletes a vertex from the graph.
    
    Parameters:
    
    vertexId - The vertex id to delete.
    
    authorizations - The authorizations required to delete the vertex.
  - softDeleteVertex
```
void softDeleteVertex(Vertex vertex,
                      Authorizations authorizations)
```
    Soft deletes a vertex from the graph.
    
    Parameters:
    
    vertex - The vertex to soft delete.
    
    authorizations - The authorizations required to soft delete the vertex.
  - softDeleteVertex
```
void softDeleteVertex(Vertex vertex,
                      Long timestamp,
                      Authorizations authorizations)
```
    Soft deletes a vertex from the graph.
    
    Parameters:
    
    vertex - The vertex to soft delete.
    
    authorizations - The authorizations required to soft delete the vertex.
  - softDeleteVertex
```
void softDeleteVertex(String vertexId,
                      Authorizations authorizations)
```
    Soft deletes a vertex from the graph.
    
    Parameters:
    
    vertexId - The vertex id to soft delete.
    
    authorizations - The authorizations required to soft delete the vertex.
  - softDeleteVertex
```
void softDeleteVertex(String vertexId,
                      Long timestamp,
                      Authorizations authorizations)
```
    Soft deletes a vertex from the graph.
    
    Parameters:
    
    vertexId - The vertex id to soft delete.
    
    authorizations - The authorizations required to soft delete the vertex.
  - addEdge
```
Edge addEdge(Vertex outVertex,
             Vertex inVertex,
             String label,
             Visibility visibility,
             Authorizations authorizations)
```
    Adds an edge between two vertices. The id of the new vertex will be generated using an IdGenerator.
    
    Parameters:
    
    outVertex - The source vertex. The "out" side of the edge.
    
    inVertex - The destination vertex. The "in" side of the edge.
    
    label - The label to assign to the edge. eg knows, works at, etc.
    
    visibility - The visibility to assign to the new edge.
    
    authorizations - The authorizations required to add and retrieve the new edge.
    
    Returns:
    
    The newly created edge.
  - addEdge
```
Edge addEdge(String edgeId,
             Vertex outVertex,
             Vertex inVertex,
             String label,
             Visibility visibility,
             Authorizations authorizations)
```
    Adds an edge between two vertices.
    
    Parameters:
    
    edgeId - The id to assign the new edge.
    
    outVertex - The source vertex. The "out" side of the edge.
    
    inVertex - The destination vertex. The "in" side of the edge.
    
    label - The label to assign to the edge. eg knows, works at, etc.
    
    visibility - The visibility to assign to the new edge.
    
    authorizations - The authorizations required to add and retrieve the new edge.
    
    Returns:
    
    The newly created edge.
  - addEdge
```
Edge addEdge(String outVertexId,
             String inVertexId,
             String label,
             Visibility visibility,
             Authorizations authorizations)
```
    Adds an edge between two vertices.
    
    Parameters:
    
    outVertexId - The source vertex id. The "out" side of the edge.
    
    inVertexId - The destination vertex id. The "in" side of the edge.
    
    label - The label to assign to the edge. eg knows, works at, etc.
    
    visibility - The visibility to assign to the new edge.
    
    authorizations - The authorizations required to add and retrieve the new edge.
    
    Returns:
    
    The newly created edge.
  - addEdge
```
Edge addEdge(String edgeId,
             String outVertexId,
             String inVertexId,
             String label,
             Visibility visibility,
             Authorizations authorizations)
```
    Adds an edge between two vertices.
    
    Parameters:
    
    edgeId - The id to assign the new edge.
    
    outVertexId - The source vertex id. The "out" side of the edge.
    
    inVertexId - The destination vertex id. The "in" side of the edge.
    
    label - The label to assign to the edge. eg knows, works at, etc.
    
    visibility - The visibility to assign to the new edge.
    
    authorizations - The authorizations required to add and retrieve the new edge.
    
    Returns:
    
    The newly created edge.
  - prepareEdge
```
EdgeBuilder prepareEdge(Vertex outVertex,
                        Vertex inVertex,
                        String label,
                        Visibility visibility)
```
    Prepare an edge to be added to the graph. This method provides a way to build up an edge with it's properties to be inserted with a single operation. The id of the new edge will be generated using an IdGenerator.
    
    Parameters:
    
    outVertex - The source vertex. The "out" side of the edge.
    
    inVertex - The destination vertex. The "in" side of the edge.
    
    label - The label to assign to the edge. eg knows, works at, etc.
    
    visibility - The visibility to assign to the new edge.
    
    Returns:
    
    The edge builder.
  - prepareEdge
```
EdgeBuilder prepareEdge(String edgeId,
                        Vertex outVertex,
                        Vertex inVertex,
                        String label,
                        Visibility visibility)
```
    Prepare an edge to be added to the graph. This method provides a way to build up an edge with it's properties to be inserted with a single operation.
    
    Parameters:
    
    edgeId - The id to assign the new edge.
    
    outVertex - The source vertex. The "out" side of the edge.
    
    inVertex - The destination vertex. The "in" side of the edge.
    
    label - The label to assign to the edge. eg knows, works at, etc.
    
    visibility - The visibility to assign to the new edge.
    
    Returns:
    
    The edge builder.
  - prepareEdge
```
EdgeBuilder prepareEdge(String edgeId,
                        Vertex outVertex,
                        Vertex inVertex,
                        String label,
                        Long timestamp,
                        Visibility visibility)
```
    Prepare an edge to be added to the graph. This method provides a way to build up an edge with it's properties to be inserted with a single operation.
    
    Parameters:
    
    edgeId - The id to assign the new edge.
    
    outVertex - The source vertex. The "out" side of the edge.
    
    inVertex - The destination vertex. The "in" side of the edge.
    
    label - The label to assign to the edge. eg knows, works at, etc.
    
    timestamp - The timestamp of the edge.
    
    visibility - The visibility to assign to the new edge.
    
    Returns:
    
    The edge builder.
  - prepareEdge
```
EdgeBuilderByVertexId prepareEdge(String outVertexId,
                                  String inVertexId,
                                  String label,
                                  Visibility visibility)
```
    Prepare an edge to be added to the graph. This method provides a way to build up an edge with it's properties to be inserted with a single operation.
    
    Parameters:
    
    outVertexId - The source vertex id. The "out" side of the edge.
    
    inVertexId - The destination vertex id. The "in" side of the edge.
    
    label - The label to assign to the edge. eg knows, works at, etc.
    
    visibility - The visibility to assign to the new edge.
    
    Returns:
    
    The edge builder.
  - prepareEdge
```
EdgeBuilderByVertexId prepareEdge(String edgeId,
                                  String outVertexId,
                                  String inVertexId,
                                  String label,
                                  Visibility visibility)
```
    Prepare an edge to be added to the graph. This method provides a way to build up an edge with it's properties to be inserted with a single operation.
    
    Parameters:
    
    edgeId - The id to assign the new edge.
    
    outVertexId - The source vertex id. The "out" side of the edge.
    
    inVertexId - The destination vertex id. The "in" side of the edge.
    
    label - The label to assign to the edge. eg knows, works at, etc.
    
    visibility - The visibility to assign to the new edge.
    
    Returns:
    
    The edge builder.
  - prepareEdge
```
EdgeBuilderByVertexId prepareEdge(String edgeId,
                                  String outVertexId,
                                  String inVertexId,
                                  String label,
                                  Long timestamp,
                                  Visibility visibility)
```
    Prepare an edge to be added to the graph. This method provides a way to build up an edge with it's properties to be inserted with a single operation.
    
    Parameters:
    
    edgeId - The id to assign the new edge.
    
    outVertexId - The source vertex id. The "out" side of the edge.
    
    inVertexId - The destination vertex id. The "in" side of the edge.
    
    label - The label to assign to the edge. eg knows, works at, etc.
    
    timestamp - The timestamp of the edge.
    
    visibility - The visibility to assign to the new edge.
    
    Returns:
    
    The edge builder.
  - doesEdgeExist
```
boolean doesEdgeExist(String edgeId,
                      Authorizations authorizations)
```
    Tests the existence of a edge with the given authorizations.
    
    Parameters:
    
    edgeId - The edge id to check existence of.
    
    authorizations - The authorizations required to load the edge.
    
    Returns:
    
    True if edge exists.
  - getEdge
```
Edge getEdge(String edgeId,
             Authorizations authorizations)
```
    Get an edge from the graph.
    
    Parameters:
    
    edgeId - The edge id to retrieve from the graph.
    
    authorizations - The authorizations required to load the edge.
    
    Returns:
    
    The edge if successful. null if the edge is not found or the required authorizations were not provided.
  - getEdge
```
Edge getEdge(String edgeId,
             EnumSet<FetchHint> fetchHints,
             Authorizations authorizations)
```
    Get an edge from the graph.
    
    Parameters:
    
    edgeId - The edge id to retrieve from the graph.
    
    fetchHints - Hint at what parts of the edge to fetch.
    
    authorizations - The authorizations required to load the edge.
    
    Returns:
    
    The edge if successful. null if the edge is not found or the required authorizations were not provided.
  - getEdge
```
Edge getEdge(String edgeId,
             EnumSet<FetchHint> fetchHints,
             Long endTime,
             Authorizations authorizations)
```
    Get an edge from the graph.
    
    Parameters:
    
    edgeId - The edge id to retrieve from the graph.
    
    fetchHints - Hint at what parts of the edge to fetch.
    
    endTime - Include all changes made up until the point in time.
    
    authorizations - The authorizations required to load the edge.
    
    Returns:
    
    The edge if successful. null if the edge is not found or the required authorizations were not provided.
  - getEdges
```
Iterable<Edge> getEdges(Authorizations authorizations)
```
    Gets all edges on the graph.
    
    Parameters:
    
    authorizations - The authorizations required to load the edge.
    
    Returns:
    
    An iterable of all the edges.
  - getEdges
```
Iterable<Edge> getEdges(EnumSet<FetchHint> fetchHints,
                        Authorizations authorizations)
```
    Gets all edges on the graph.
    
    Parameters:
    
    fetchHints - Hint at what parts of the edge to fetch.
    
    authorizations - The authorizations required to load the edge.
    
    Returns:
    
    An iterable of all the edges.
  - getEdges
```
Iterable<Edge> getEdges(EnumSet<FetchHint> fetchHints,
                        Long endTime,
                        Authorizations authorizations)
```
    Gets all edges on the graph.
    
    Parameters:
    
    fetchHints - Hint at what parts of the edge to fetch.
    
    endTime - Include all changes made up until the point in time.
    
    authorizations - The authorizations required to load the edge.
    
    Returns:
    
    An iterable of all the edges.
  - getEdgesInRange
```
Iterable<Edge> getEdgesInRange(Range idRange,
                               Authorizations authorizations)
```
    Gets edges from the graph in the given range.
    
    Parameters:
    
    idRange - The range of ids to get.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    The edges in the range.
  - getEdgesInRange
```
Iterable<Edge> getEdgesInRange(Range idRange,
                               EnumSet<FetchHint> fetchHints,
                               Authorizations authorizations)
```
    Gets edges from the graph in the given range.
    
    Parameters:
    
    idRange - The range of ids to get.
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    The edges in the range.
  - getEdgesInRange
```
Iterable<Edge> getEdgesInRange(Range idRange,
                               EnumSet<FetchHint> fetchHints,
                               Long endTime,
                               Authorizations authorizations)
```
    Gets edges from the graph in the given range.
    
    Parameters:
    
    idRange - The range of ids to get.
    
    fetchHints - Hint at what parts of the vertex to fetch.
    
    endTime - Include all changes made up until the point in time.
    
    authorizations - The authorizations required to load the vertex.
    
    Returns:
    
    The edges in the range.
  - filterEdgeIdsByAuthorization
```
Iterable<String> filterEdgeIdsByAuthorization(Iterable<String> edgeIds,
                                              String authorizationToMatch,
                                              EnumSet<ElementFilter> filters,
                                              Authorizations authorizations)
```
    Filters a collection of edge ids by the authorizations of that edge, properties, etc. If any of the filtered items match that edge id will be included.
    
    Parameters:
    
    edgeIds - The edge ids to filter on.
    
    authorizationToMatch - The authorization to look for
    
    filters - The parts of the edge to filter on
    
    authorizations - The authorization to find the edges with
    
    Returns:
    
    The filtered down list of edge ids
  - filterVertexIdsByAuthorization
```
Iterable<String> filterVertexIdsByAuthorization(Iterable<String> vertexIds,
                                                String authorizationToMatch,
                                                EnumSet<ElementFilter> filters,
                                                Authorizations authorizations)
```
    Filters a collection of vertex ids by the authorizations of that vertex, properties, etc. If any of the filtered items match that vertex id will be included.
    
    Parameters:
    
    vertexIds - The vertex ids to filter on.
    
    authorizationToMatch - The authorization to look for
    
    filters - The parts of the edge to filter on
    
    authorizations - The authorization to find the edges with
    
    Returns:
    
    The filtered down list of vertex ids
  - doEdgesExist
```
Map<String,Boolean> doEdgesExist(Iterable<String> ids,
                                 Authorizations authorizations)
```
    Tests the existence of edges with the given authorizations.
    
    Parameters:
    
    ids - The edge ids to check existence of.
    
    authorizations - The authorizations required to load the edges.
    
    Returns:
    
    Maps of ids to exists status.
  - doEdgesExist
```
Map<String,Boolean> doEdgesExist(Iterable<String> ids,
                                 Long endTime,
                                 Authorizations authorizations)
```
    Tests the existence of edges with the given authorizations.
    
    Parameters:
    
    ids - The edge ids to check existence of.
    
    endTime - Include all changes made up until the point in time.
    
    authorizations - The authorizations required to load the edges.
    
    Returns:
    
    Maps of ids to exists status.
  - getEdges
```
Iterable<Edge> getEdges(Iterable<String> ids,
                        Authorizations authorizations)
```
    Gets all edges on the graph matching the given ids.
    
    Parameters:
    
    ids - The ids of the edges to get.
    
    authorizations - The authorizations required to load the edge.
    
    Returns:
    
    An iterable of all the edges.
  - getEdges
```
Iterable<Edge> getEdges(Iterable<String> ids,
                        EnumSet<FetchHint> fetchHints,
                        Authorizations authorizations)
```
    Gets all edges on the graph matching the given ids.
    
    Parameters:
    
    ids - The ids of the edges to get.
    
    fetchHints - Hint at what parts of the edge to fetch.
    
    authorizations - The authorizations required to load the edge.
    
    Returns:
    
    An iterable of all the edges.
  - getEdges
```
Iterable<Edge> getEdges(Iterable<String> ids,
                        EnumSet<FetchHint> fetchHints,
                        Long endTime,
                        Authorizations authorizations)
```
    Gets all edges on the graph matching the given ids.
    
    Parameters:
    
    ids - The ids of the edges to get.
    
    fetchHints - Hint at what parts of the edge to fetch.
    
    endTime - Include all changes made up until the point in time.
    
    authorizations - The authorizations required to load the edge.
    
    Returns:
    
    An iterable of all the edges.
  - findRelatedEdges
```
@Deprecated
Iterable<String> findRelatedEdges(Iterable<String> vertexIds,
                                              Authorizations authorizations)
```
    Deprecated.
    
    Use findRelatedEdgeIds(Iterable, Authorizations)
  - findRelatedEdges
```
@Deprecated
Iterable<String> findRelatedEdges(Iterable<String> vertexIds,
                                              Long endTime,
                                              Authorizations authorizations)
```
    Deprecated.
    
    Use findRelatedEdgeIds(Iterable, Long, Authorizations)
  - findRelatedEdgeIdsForVertices
```
Iterable<String> findRelatedEdgeIdsForVertices(Iterable<Vertex> vertices,
                                               Authorizations authorizations)
```
    Given a list of vertices, find all the edge ids that connect them.
    
    Parameters:
    
    vertices - The list of vertices.
    
    authorizations - The authorizations required to load the edges.
    
    Returns:
    
    An iterable of all the edge ids between any two vertices.
  - findRelatedEdgeIds
```
Iterable<String> findRelatedEdgeIds(Iterable<String> vertexIds,
                                    Authorizations authorizations)
```
    Given a list of vertex ids, find all the edge ids that connect them.
    
    Parameters:
    
    vertexIds - The list of vertex ids.
    
    authorizations - The authorizations required to load the edges.
    
    Returns:
    
    An iterable of all the edge ids between any two vertices.
  - findRelatedEdgeIds
```
Iterable<String> findRelatedEdgeIds(Iterable<String> vertexIds,
                                    Long endTime,
                                    Authorizations authorizations)
```
    Given a list of vertex ids, find all the edge ids that connect them.
    
    Parameters:
    
    vertexIds - The list of vertex ids.
    
    endTime - Include all changes made up until the point in time.
    
    authorizations - The authorizations required to load the edges.
    
    Returns:
    
    An iterable of all the edge ids between any two vertices.
  - findRelatedEdgeSummaryForVertices
```
Iterable<RelatedEdge> findRelatedEdgeSummaryForVertices(Iterable<Vertex> vertices,
                                                        Authorizations authorizations)
```
    Given a list of vertices, find all the edges that connect them.
    
    Parameters:
    
    vertices - The list of vertices.
    
    authorizations - The authorizations required to load the edges.
    
    Returns:
    
    Summary information about the related edges.
  - findRelatedEdgeSummary
```
Iterable<RelatedEdge> findRelatedEdgeSummary(Iterable<String> vertexIds,
                                             Authorizations authorizations)
```
    Given a list of vertex ids, find all the edges that connect them.
    
    Parameters:
    
    vertexIds - The list of vertex ids.
    
    authorizations - The authorizations required to load the edges.
    
    Returns:
    
    Summary information about the related edges.
  - findRelatedEdgeSummary
```
Iterable<RelatedEdge> findRelatedEdgeSummary(Iterable<String> vertexIds,
                                             Long endTime,
                                             Authorizations authorizations)
```
    Given a list of vertex ids, find all the edges that connect them.
    
    Parameters:
    
    vertexIds - The list of vertex ids.
    
    endTime - Include all changes made up until the point in time.
    
    authorizations - The authorizations required to load the edges.
    
    Returns:
    
    Summary information about the related edges.
  - deleteEdge
```
void deleteEdge(Edge edge,
                Authorizations authorizations)
```
    Permanently deletes an edge from the graph.
    
    Parameters:
    
    edge - The edge to delete from the graph.
    
    authorizations - The authorizations required to delete the edge.
  - deleteEdge
```
void deleteEdge(String edgeId,
                Authorizations authorizations)
```
    Permanently deletes an edge from the graph. This method requires fetching the edge before deletion.
    
    Parameters:
    
    edgeId - The edge id of the edge to delete from the graph.
    
    authorizations - The authorizations required to delete the edge.
  - softDeleteEdge
```
void softDeleteEdge(Edge edge,
                    Authorizations authorizations)
```
    Soft deletes an edge from the graph.
    
    Parameters:
    
    edge - The edge to soft delete from the graph.
    
    authorizations - The authorizations required to delete the edge.
  - softDeleteEdge
```
void softDeleteEdge(Edge edge,
                    Long timestamp,
                    Authorizations authorizations)
```
    Soft deletes an edge from the graph.
    
    Parameters:
    
    edge - The edge to soft delete from the graph.
    
    authorizations - The authorizations required to delete the edge.
  - softDeleteEdge
```
void softDeleteEdge(String edgeId,
                    Authorizations authorizations)
```
    Soft deletes an edge from the graph. This method requires fetching the edge before soft deletion.
    
    Parameters:
    
    edgeId - The edge id of the vertex to soft delete from the graph.
    
    authorizations - The authorizations required to delete the edge.
  - softDeleteEdge
```
void softDeleteEdge(String edgeId,
                    Long timestamp,
                    Authorizations authorizations)
```
    Soft deletes an edge from the graph. This method requires fetching the edge before soft deletion.
    
    Parameters:
    
    edgeId - The edge id of the vertex to soft delete from the graph.
    
    authorizations - The authorizations required to delete the edge.
  - query
```
GraphQuery query(String queryString,
                 Authorizations authorizations)
```
    Creates a query builder object used to query the graph.
    
    Parameters:
    
    queryString - The string to search for in the text of an element. This will search all fields for the given text.
    
    authorizations - The authorizations required to load the elements.
    
    Returns:
    
    A query builder object.
  - query
```
GraphQuery query(Authorizations authorizations)
```
    Creates a query builder object used to query the graph.
    
    Parameters:
    
    authorizations - The authorizations required to load the elements.
    
    Returns:
    
    A query builder object.
  - query
```
MultiVertexQuery query(String[] vertexIds,
                       String queryString,
                       Authorizations authorizations)
```
    Creates a query builder object used to query a list of vertices.
    
    Parameters:
    
    vertexIds - The vertex ids to query.
    
    queryString - The string to search for in the text of an element. This will search all fields for the given text.
    
    authorizations - The authorizations required to load the elements.
    
    Returns:
    
    A query builder object.
  - query
```
MultiVertexQuery query(String[] vertexIds,
                       Authorizations authorizations)
```
    Creates a query builder object used to query a list of vertices.
    
    Parameters:
    
    vertexIds - The vertex ids to query.
    
    authorizations - The authorizations required to load the elements.
    
    Returns:
    
    A query builder object.
  - isQuerySimilarToTextSupported
```
boolean isQuerySimilarToTextSupported()
```
    Returns true if this graph supports similar to text queries.
  - querySimilarTo
```
SimilarToGraphQuery querySimilarTo(String[] fields,
                                   String text,
                                   Authorizations authorizations)
```
    Creates a query builder object that finds all vertices similar to the given text for the specified fields. This could be implemented similar to the ElasticSearch more like this query.
    
    Parameters:
    
    fields - The fields to match against.
    
    text - The text to find similar to.
    
    authorizations - The authorizations required to load the elements.
    
    Returns:
    
    A query builder object.
  - flush
```
void flush()
```
    Flushes any pending mutations to the graph.
  - shutdown
```
void shutdown()
```
    Cleans up or disconnects from the underlying storage.
  - findPaths
```
@Deprecated
Iterable<Path> findPaths(String sourceVertexId,
                                     String destVertexId,
                                     int maxHops,
                                     Authorizations authorizations)
```
    Deprecated. Use findPaths(FindPathOptions, Authorizations)
    
    Finds all paths between two vertices.
    
    Parameters:
    
    sourceVertexId - The source vertex id to start the search from.
    
    destVertexId - The destination vertex id to get to.
    
    maxHops - The maximum number of hops to make before giving up.
    
    authorizations - The authorizations required to load all edges and vertices.
    
    Returns:
    
    An Iterable of lists of paths.
  - findPaths
```
@Deprecated
Iterable<Path> findPaths(String sourceVertexId,
                                     String destVertexId,
                                     String[] labels,
                                     int maxHops,
                                     Authorizations authorizations)
```
    Deprecated. Use findPaths(FindPathOptions, Authorizations)
    
    Finds all paths between two vertices.
    
    Parameters:
    
    sourceVertexId - The source vertex id to start the search from.
    
    destVertexId - The destination vertex id to get to.
    
    labels - Edge labels
    
    maxHops - The maximum number of hops to make before giving up.
    
    authorizations - The authorizations required to load all edges and vertices.
    
    Returns:
    
    An Iterable of lists of paths.
  - findPaths
```
@Deprecated
Iterable<Path> findPaths(String sourceVertexId,
                                     String destVertexId,
                                     int maxHops,
                                     ProgressCallback progressCallback,
                                     Authorizations authorizations)
```
    Deprecated. Use findPaths(FindPathOptions, Authorizations)
    
    Finds all paths between two vertices.
    
    Parameters:
    
    sourceVertexId - The source vertex id to start the search from.
    
    destVertexId - The destination vertex id to get to.
    
    maxHops - The maximum number of hops to make before giving up.
    
    progressCallback - Callback used to report progress.
    
    authorizations - The authorizations required to load all edges and vertices.
    
    Returns:
    
    An Iterable of lists of paths.
  - findPaths
```
@Deprecated
Iterable<Path> findPaths(String sourceVertexId,
                                     String destVertexId,
                                     String[] labels,
                                     int maxHops,
                                     ProgressCallback progressCallback,
                                     Authorizations authorizations)
```
    Deprecated. Use findPaths(FindPathOptions, Authorizations)
    
    Finds all paths between two vertices.
    
    Parameters:
    
    sourceVertexId - The source vertex id to start the search from.
    
    destVertexId - The destination vertex id to get to.
    
    labels - Edge labels
    
    maxHops - The maximum number of hops to make before giving up.
    
    progressCallback - Callback used to report progress.
    
    authorizations - The authorizations required to load all edges and vertices.
    
    Returns:
    
    An Iterable of lists of paths.
  - findPaths
```
Iterable<Path> findPaths(FindPathOptions options,
                         Authorizations authorizations)
```
    Finds all paths between two vertices.
    
    Parameters:
    
    options - Find path options
    
    authorizations - The authorizations required to load all edges and vertices.
    
    Returns:
    
    An Iterable of lists of paths.
  - getIdGenerator
```
IdGenerator getIdGenerator()
```
    Gets the id generator used by this graph to create ids.
    
    Returns:
    
    the id generator.
  - isVisibilityValid
```
boolean isVisibilityValid(Visibility visibility,
                          Authorizations authorizations)
```
    Given an authorization is the visibility object valid.
    
    Parameters:
    
    visibility - The visibility you want to check.
    
    authorizations - The given authorizations.
    
    Returns:
    
    true if the visibility is valid given an authorization, else return false.
  - reindex
```
void reindex(Authorizations authorizations)
```
    Reindex all vertices and edges.
    
    Parameters:
    
    authorizations - authorizations used to query for the data to reindex.
  - setMetadata
```
void setMetadata(String key,
                 Object value)
```
    Sets metadata on the graph.
    
    Parameters:
    
    key - The key to the metadata.
    
    value - The value to set.
  - getMetadata
```
Object getMetadata(String key)
```
    Gets metadata from the graph.
    
    Parameters:
    
    key - The key to the metadata.
    
    Returns:
    
    The metadata value, or null.
  - getMetadata
```
Iterable<GraphMetadataEntry> getMetadata()
```
    Gets all metadata.
    
    Returns:
    
    Iterable of all metadata.
  - getMetadataWithPrefix
```
Iterable<GraphMetadataEntry> getMetadataWithPrefix(String prefix)
```
    Gets all metadata with the given prefix.
  - isFieldBoostSupported
```
boolean isFieldBoostSupported()
```
    Determine if field boost is support. That is can you change the boost at a field level to give higher priority.
  - truncate
```
void truncate()
```
    Clears all data from the graph.
  - drop
```
void drop()
```
    Drops all tables
  - getSearchIndexSecurityGranularity
```
SearchIndexSecurityGranularity getSearchIndexSecurityGranularity()
```
    Gets the granularity of the search index SearchIndexSecurityGranularity
  - addGraphEventListener
```
void addGraphEventListener(GraphEventListener graphEventListener)
```
    Adds a graph event listener that will be called when graph events occur.
  - markVertexHidden
```
void markVertexHidden(Vertex vertex,
                      Visibility visibility,
                      Authorizations authorizations)
```
    Marks a vertex as hidden for a given visibility.
    
    Parameters:
    
    vertex - The vertex to mark hidden.
    
    visibility - The visibility string under which this vertex is hidden. This visibility can be a superset of the vertex visibility to mark it as hidden for only a subset of authorizations.
    
    authorizations - The authorizations used.
  - markVertexVisible
```
void markVertexVisible(Vertex vertex,
                       Visibility visibility,
                       Authorizations authorizations)
```
    Marks a vertex as visible for a given visibility, effectively undoing markVertexHidden.
    
    Parameters:
    
    vertex - The vertex to mark visible.
    
    visibility - The visibility string under which this vertex is now visible.
    
    authorizations - The authorizations used.
  - markEdgeHidden
```
void markEdgeHidden(Edge edge,
                    Visibility visibility,
                    Authorizations authorizations)
```
    Marks an edge as hidden for a given visibility.
    
    Parameters:
    
    edge - The edge to mark hidden.
    
    visibility - The visibility string under which this edge is hidden. This visibility can be a superset of the edge visibility to mark it as hidden for only a subset of authorizations.
    
    authorizations - The authorizations used.
  - markEdgeVisible
```
void markEdgeVisible(Edge edge,
                     Visibility visibility,
                     Authorizations authorizations)
```
    Marks an edge as visible for a given visibility, effectively undoing markEdgeHidden.
    
    Parameters:
    
    edge - The edge to mark visible.
    
    visibility - The visibility string under which this edge is now visible.
    
    authorizations - The authorizations used.
  - createAuthorizations
```
Authorizations createAuthorizations(String... auths)
```
    Creates an authorizations object.
    
    Parameters:
    
    auths - The authorizations granted.
    
    Returns:
    
    A new authorizations object
  - createAuthorizations
```
Authorizations createAuthorizations(Collection<String> auths)
```
    Creates an authorizations object.
    
    Parameters:
    
    auths - The authorizations granted.
    
    Returns:
    
    A new authorizations object
  - createAuthorizations
```
Authorizations createAuthorizations(Authorizations auths,
                                    String... additionalAuthorizations)
```
    Creates an authorizations object combining auths and additionalAuthorizations.
    
    Parameters:
    
    auths - The authorizations granted.
    
    additionalAuthorizations - additional authorizations
    
    Returns:
    
    A new authorizations object
  - createAuthorizations
```
Authorizations createAuthorizations(Authorizations auths,
                                    Collection<String> additionalAuthorizations)
```
    Creates an authorizations object combining auths and additionalAuthorizations.
    
    Parameters:
    
    auths - The authorizations granted.
    
    additionalAuthorizations - additional authorizations
    
    Returns:
    
    A new authorizations object
  - getVertexPropertyCountByValue
```
Map<Object,Long> getVertexPropertyCountByValue(String propertyName,
                                               Authorizations authorizations)
```
    Gets the number of times a property with a given value occurs on vertices
    
    Parameters:
    
    propertyName - The name of the property to find
    
    authorizations - The authorizations to use to find the property
    
    Returns:
    
    The results
  - getVertexCount
```
long getVertexCount(Authorizations authorizations)
```
    Gets a count of the number of vertices in the system.
  - getEdgeCount
```
long getEdgeCount(Authorizations authorizations)
```
    Gets a count of the number of edges in the system.
  - savePropertyDefinition
```
void savePropertyDefinition(PropertyDefinition propertyDefinition)
```
    Save a pre-made property definition.
    
    Parameters:
    
    propertyDefinition - the property definition to save.
  - defineProperty
```
DefinePropertyBuilder defineProperty(String propertyName)
```
    Creates a defines property builder. This is typically used by the indexer to give it hints on how it should index a property.
    
    Parameters:
    
    propertyName - The name of the property to define.
  - isPropertyDefined
```
boolean isPropertyDefined(String propertyName)
```
    Determine if a property is already defined
  - getPropertyDefinition
```
PropertyDefinition getPropertyDefinition(String propertyName)
```
    Gets the property definition for the given name.
    
    Parameters:
    
    propertyName - name of the property
    
    Returns:
    
    the property definition if found. null otherwise.
  - getPropertyDefinitions
```
Collection<PropertyDefinition> getPropertyDefinitions()
```
    Gets all property definitions.
    
    Returns:
    
    all property definitions.
  - saveElementMutations
```
Iterable<Element> saveElementMutations(Iterable<ElementMutation> mutations,
                                       Authorizations authorizations)
```
    Saves multiple mutations with a single call.
    
    Parameters:
    
    mutations - the mutations to save
    
    authorizations - the authorizations used during save
    
    Returns:
    
    the elements which were saved
  - getStreamingPropertyValueInputStreams
```
List<InputStream> getStreamingPropertyValueInputStreams(List<StreamingPropertyValue> streamingPropertyValues)
```
    Opens multiple StreamingPropertyValue input streams at once. This can have performance benefits by reducing the number of queries to the underlying data source.
    
    Parameters:
    
    streamingPropertyValues - list of StreamingPropertyValues to get input streams for
    
    Returns:
    
    InputStreams in the same order as the input list

Interface Graph

Method Summary

Method Detail

addVertex

addVertex

addVertices

prepareVertex

prepareVertex

prepareVertex

prepareVertex

doesVertexExist

getVertex

getVertex

getVertex

getVerticesWithPrefix

getVerticesWithPrefix

getVerticesWithPrefix

getVerticesInRange

getVerticesInRange

getVerticesInRange

getVertices

getVertices

getVertices

doVerticesExist

getVertices

getVertices

getVertices

getVerticesInOrder

getVerticesInOrder

deleteVertex

deleteVertex

softDeleteVertex

softDeleteVertex

softDeleteVertex

softDeleteVertex

addEdge

addEdge

addEdge

addEdge

prepareEdge

prepareEdge

prepareEdge

prepareEdge

prepareEdge

prepareEdge

doesEdgeExist

getEdge

getEdge

getEdge

getEdges

getEdges

getEdges

getEdgesInRange

getEdgesInRange

getEdgesInRange

filterEdgeIdsByAuthorization

filterVertexIdsByAuthorization

doEdgesExist

doEdgesExist

getEdges

getEdges

getEdges

findRelatedEdges

findRelatedEdges

findRelatedEdgeIdsForVertices

findRelatedEdgeIds

findRelatedEdgeIds

findRelatedEdgeSummaryForVertices

findRelatedEdgeSummary

findRelatedEdgeSummary

deleteEdge

deleteEdge

softDeleteEdge

softDeleteEdge

softDeleteEdge

softDeleteEdge

query

query

query

query