Module org.elasticsearch.server

Package org.elasticsearch.search.collapse

Class CollapseBuilder

java.lang.Object

org.elasticsearch.search.collapse.CollapseBuilder

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class CollapseBuilder
extends Object
implements Writeable, ToXContentObject

A builder that enables field collapsing on search request.

Nested Class Summary

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

Modifier and Type	Field	Description
static final ParseField	FIELD_FIELD
static final ParseField	INNER_HITS_FIELD
static final ParseField	MAX_CONCURRENT_GROUP_REQUESTS_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CollapseBuilder(String field)	Public constructor
CollapseBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
CollapseContext	build(SearchExecutionContext searchExecutionContext)
boolean	equals(Object o)
static CollapseBuilder	fromXContent(XContentParser parser)
String	getField()	The name of the field to collapse against
List<InnerHitBuilder>	getInnerHits()	The inner hit options to expand the collapsed results
int	getMaxConcurrentGroupRequests()	Returns the amount of group requests that are allowed to be ran concurrently in the inner_hits phase.
int	hashCode()
CollapseBuilder	setInnerHits(List<InnerHitBuilder> innerHits)
CollapseBuilder	setInnerHits(InnerHitBuilder innerHit)
CollapseBuilder	setMaxConcurrentGroupRequests(int num)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

FIELD_FIELD

public static final ParseField FIELD_FIELD

INNER_HITS_FIELD

public static final ParseField INNER_HITS_FIELD

MAX_CONCURRENT_GROUP_REQUESTS_FIELD

public static final ParseField MAX_CONCURRENT_GROUP_REQUESTS_FIELD

Constructor Details

CollapseBuilder

public CollapseBuilder(String field)

Public constructor

Parameters:

field - The name of the field to collapse on

CollapseBuilder

public CollapseBuilder(StreamInput in)
                throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

fromXContent

public static CollapseBuilder fromXContent(XContentParser parser)

setInnerHits

public CollapseBuilder setInnerHits(InnerHitBuilder innerHit)

setInnerHits

public CollapseBuilder setInnerHits(List<InnerHitBuilder> innerHits)

setMaxConcurrentGroupRequests

public CollapseBuilder setMaxConcurrentGroupRequests(int num)

getField

public String getField()

The name of the field to collapse against

getInnerHits

public List<InnerHitBuilder> getInnerHits()

The inner hit options to expand the collapsed results

getMaxConcurrentGroupRequests

public int getMaxConcurrentGroupRequests()

Returns the amount of group requests that are allowed to be ran concurrently in the inner_hits phase.

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

build

public CollapseContext build(SearchExecutionContext searchExecutionContext)