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