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:
Streamable
,Writeable
,ToXContent
,ToXContentObject
public class GraphExploreResponse extends ActionResponse implements ToXContentObject
Graph explore response holds a graph ofVertex
andConnection
objects (nodes and edges in common graph parlance).- See Also:
GraphExploreRequest
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse
TransportResponse.Empty
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
-
-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GraphExploreResponse
fromXContext(XContentParser parser)
java.util.Collection<Connection>
getConnections()
ShardOperationFailedException[]
getShardFailures()
TimeValue
getTook()
long
getTookInMillis()
Vertex
getVertex(Vertex.VertexId id)
java.util.Collection<Vertex>
getVertices()
boolean
isTimedOut()
void
readFrom(StreamInput in)
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
-
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
-
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()
-
readFrom
public void readFrom(StreamInput in) throws java.io.IOException
- Specified by:
readFrom
in interfaceStreamable
- Overrides:
readFrom
in classActionResponse
- Throws:
java.io.IOException
-
getConnections
public java.util.Collection<Connection> getConnections()
-
getVertices
public java.util.Collection<Vertex> getVertices()
-
getVertex
public Vertex getVertex(Vertex.VertexId id)
-
writeTo
public void writeTo(StreamOutput out) throws java.io.IOException
- Specified by:
writeTo
in interfaceStreamable
- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classActionResponse
- Throws:
java.io.IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
fromXContext
public static GraphExploreResponse fromXContext(XContentParser parser) throws java.io.IOException
- Throws:
java.io.IOException
-
-