org.elasticsearch.action.percolate

Class PercolateResponse

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.broadcast.BroadcastResponse

org.elasticsearch.action.percolate.PercolateResponse

All Implemented Interfaces:

Iterable<PercolateResponse.Match>, HasContext, HasContextAndHeaders, HasHeaders, Streamable, ToXContent

public class PercolateResponse
extends BroadcastResponse
implements Iterable<PercolateResponse.Match>, ToXContent

Encapsulates the response of a percolator request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PercolateResponse.Match Represents a query that has matched with the document that was percolated.

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

Field Summary

Fields

Modifier and Type	Field and Description
static PercolateResponse.Match[]	EMPTY

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

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

EMPTY_PARAMS

Method Summary

Methods

Modifier and Type	Method and Description
InternalAggregations	getAggregations()
long	getCount()
PercolateResponse.Match[]	getMatches()
TimeValue	getTook() How long the percolate took.
long	getTookInMillis() How long the percolate took in milliseconds.
Iterator<PercolateResponse.Match>	iterator()
void	readFrom(StreamInput in)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastResponse

getFailedShards, getShardFailures, getSuccessfulShards, getTotalShards

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final PercolateResponse.Match[] EMPTY

Method Detail

getTook

public TimeValue getTook()

How long the percolate took.

getTookInMillis

public long getTookInMillis()

How long the percolate took in milliseconds.

getMatches

public PercolateResponse.Match[] getMatches()

Returns:

The queries that match with the document being percolated. This can return null if th.

getCount

public long getCount()

Returns:

The total number of queries that have matched with the document being percolated.

getAggregations

public InternalAggregations getAggregations()

Returns:

Any aggregations that has been executed on the query metadata. This can return null.

iterator

public Iterator<PercolateResponse.Match> iterator()

Specified by:

iterator in interface Iterable<PercolateResponse.Match>

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastResponse

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BroadcastResponse

Throws:

IOException