Module org.elasticsearch.xcore

Package org.elasticsearch.protocol.xpack.graph

Class GraphExploreResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.protocol.xpack.graph.GraphExploreResponse

All Implemented Interfaces:

Writeable, RefCounted, ToXContent, ToXContentObject

public class GraphExploreResponse
extends ActionResponse
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 class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Collection<Connection>	getConnections()
ShardOperationFailedException[]	getShardFailures()
TimeValue	getTook()
long	getTookInMillis()
Vertex	getVertex(Vertex.VertexId id)
Collection<Vertex>	getVertices()
boolean	isTimedOut()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

GraphExploreResponse

public GraphExploreResponse()

GraphExploreResponse

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

Method Details

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 Collection<Connection> getConnections()

getVertices

public Collection<Vertex> getVertices()

getVertex

public Vertex getVertex(Vertex.VertexId id)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException