Package org.elasticsearch.client.graph

Class GraphExploreResponse

java.lang.Object

org.elasticsearch.client.graph.GraphExploreResponse

All Implemented Interfaces:

ToXContent, ToXContentObject

public class GraphExploreResponse
extends java.lang.Object
implements ToXContentObject

Graph explore response holds a graph of Vertex and Connection objects (nodes and edges in common graph parlance).

See Also:

GraphExploreRequest

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GraphExploreResponse()
GraphExploreResponse(long tookInMillis, boolean timedOut, ShardOperationFailedException[] shardFailures, java.util.Map<Vertex.VertexId,Vertex> vertices, java.util.Map<Connection.ConnectionId,Connection> connections, boolean returnDetailedInfo)

Method Summary

Modifier and Type	Method	Description
static GraphExploreResponse	fromXContent(XContentParser parser)
Connection	getConnection(Connection.ConnectionId connectionId)
java.util.Collection<Connection.ConnectionId>	getConnectionIds()
java.util.Collection<Connection>	getConnections()
ShardOperationFailedException[]	getShardFailures()
TimeValue	getTook()
long	getTookInMillis()
Vertex	getVertex(Vertex.VertexId id)
java.util.Collection<Vertex.VertexId>	getVertexIds()
java.util.Collection<Vertex>	getVertices()
boolean	isReturnDetailedInfo()
boolean	isTimedOut()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Constructor Detail

GraphExploreResponse

public GraphExploreResponse()

GraphExploreResponse

public GraphExploreResponse(long tookInMillis,
                            boolean timedOut,
                            ShardOperationFailedException[] shardFailures,
                            java.util.Map<Vertex.VertexId,Vertex> vertices,
                            java.util.Map<Connection.ConnectionId,Connection> connections,
                            boolean returnDetailedInfo)

Method Detail

getTook

public TimeValue getTook()

getTookInMillis

public long getTookInMillis()

isTimedOut

public boolean isTimedOut()

Returns:

true if the time stated in GraphExploreRequest.timeout(TimeValue) was exceeded (not all hops may have been completed in this case)

getShardFailures

public ShardOperationFailedException[] getShardFailures()

getConnections

public java.util.Collection<Connection> getConnections()

getConnectionIds

public java.util.Collection<Connection.ConnectionId> getConnectionIds()

getConnection

public Connection getConnection(Connection.ConnectionId connectionId)

getVertices

public java.util.Collection<Vertex> getVertices()

getVertexIds

public java.util.Collection<Vertex.VertexId> getVertexIds()

getVertex

public Vertex getVertex(Vertex.VertexId id)

isReturnDetailedInfo

public boolean isReturnDetailedInfo()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

fromXContent

public static GraphExploreResponse fromXContent(XContentParser parser)
                                         throws java.io.IOException

Throws:

java.io.IOException