java.lang.Object
org.elasticsearch.search.collapse.CollapseBuilder
- All Implemented Interfaces:
Writeable
,ToXContent
,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
Modifier and TypeFieldDescriptionstatic final ParseField
static final ParseField
static final ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild
(SearchExecutionContext searchExecutionContext) boolean
static CollapseBuilder
fromXContent
(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()
setInnerHits
(List<InnerHitBuilder> innerHits) setInnerHits
(InnerHitBuilder innerHit) setMaxConcurrentGroupRequests
(int num) 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
-
INNER_HITS_FIELD
-
MAX_CONCURRENT_GROUP_REQUESTS_FIELD
-
-
Constructor Details
-
CollapseBuilder
Public constructor- Parameters:
field
- The name of the field to collapse on
-
CollapseBuilder
- Throws:
IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
fromXContent
-
setInnerHits
-
setInnerHits
-
setMaxConcurrentGroupRequests
-
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 XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
equals
-
hashCode
public int hashCode() -
build
-