Class MatchPhraseQuery
java.lang.Object
org.opensearch.client.opensearch._types.query_dsl.QueryBase
org.opensearch.client.opensearch._types.query_dsl.MatchPhraseQuery
- All Implemented Interfaces:
JsonpSerializable,PlainJsonSerializable,QueryVariant,ToCopyableBuilder<MatchPhraseQuery.Builder,MatchPhraseQuery>
@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class MatchPhraseQuery
extends QueryBase
implements QueryVariant, ToCopyableBuilder<MatchPhraseQuery.Builder,MatchPhraseQuery>
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase
QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<MatchPhraseQuery> Json deserializer forMatchPhraseQuery -
Method Summary
Modifier and TypeMethodDescriptionQueryvariant kind.final Stringanalyzer()Analyzer used to convert the text in the query value into tokens.static MatchPhraseQuery.Builderbuilder()booleanfinal Stringfield()Required - The target fieldinthashCode()static MatchPhraseQueryfinal Stringquery()Required - Query terms that are analyzed and turned into a phrase query.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidfinal Integerslop()Maximum number of positions allowed between matching tokens.Create a new builderToCopyableBuilderthat is initialised with the current state of this object.final ZeroTermsQueryAPI name:zero_terms_queryMethods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase
boost, queryName, serialize, setupQueryBaseDeserializerMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.opensearch._types.query_dsl.QueryVariant
toQueryMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forMatchPhraseQuery
-
-
Method Details
-
of
public static MatchPhraseQuery of(Function<MatchPhraseQuery.Builder, ObjectBuilder<MatchPhraseQuery>> fn) -
_queryKind
Queryvariant kind.- Specified by:
_queryKindin interfaceQueryVariant
-
analyzer
Analyzer used to convert the text in the query value into tokens.API name:
analyzer -
field
Required - The target field -
query
Required - Query terms that are analyzed and turned into a phrase query.API name:
query -
slop
Maximum number of positions allowed between matching tokens.API name:
slop -
zeroTermsQuery
API name:zero_terms_query -
serializeInternal
- Overrides:
serializeInternalin classQueryBase
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<MatchPhraseQuery.Builder,MatchPhraseQuery> - Returns:
- a new builder instance.
-
builder
-
setupMatchPhraseQueryDeserializer
protected static void setupMatchPhraseQueryDeserializer(ObjectDeserializer<MatchPhraseQuery.Builder> op) -
hashCode
public int hashCode() -
equals
-