Class CollapseBuilder
org.elasticsearch.search.collapse.CollapseBuilder
- All Implemented Interfaces:
Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class CollapseBuilder
extends
implements Writeable, org.elasticsearch.common.xcontent.ToXContentObject
A builder that enables field collapsing on search request.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Modifier and TypeFieldDescriptionstatic org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild(SearchExecutionContext searchExecutionContext)
boolean
o)
static CollapseBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
getField()
The name of the field to collapse againstThe inner hit options to expand the collapsed resultsint
Returns the amount of group requests that are allowed to be ran concurrently in the inner_hits phase.int
hashCode()
<InnerHitBuilder> innerHits)
setInnerHits(InnerHitBuilder innerHit)
setMaxConcurrentGroupRequests(int num)
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class java.lang.
, , , , , , , ,
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Field Details
-
FIELD_FIELD
public static final org.elasticsearch.common.xcontent.ParseField FIELD_FIELD -
INNER_HITS_FIELD
public static final org.elasticsearch.common.xcontent.ParseField INNER_HITS_FIELD -
MAX_CONCURRENT_GROUP_REQUESTS_FIELD
public static final org.elasticsearch.common.xcontent.ParseField MAX_CONCURRENT_GROUP_REQUESTS_FIELD
-
-
Constructor Details
-
CollapseBuilder
public CollapseBuilder( field)Public constructor- Parameters:
field
- The name of the field to collapse on
-
CollapseBuilder
- Throws:
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
fromXContent
public static CollapseBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) -
setInnerHits
-
setInnerHits
public <InnerHitBuilder> innerHits) -
setMaxConcurrentGroupRequests
-
getField
public getField()The name of the field to collapse against -
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 org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
-
equals
public boolean equals( o)- Overrides:
in class
-
hashCode
public int hashCode()- Overrides:
in class
-
build
-