Package org.opensearch.client.opensearch._types.query_dsl

Class PercolateQuery

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.QueryBase

org.opensearch.client.opensearch._types.query_dsl.PercolateQuery

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, QueryVariant, ToCopyableBuilder<PercolateQuery.Builder,PercolateQuery>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class PercolateQuery
extends QueryBase
implements QueryVariant, ToCopyableBuilder<PercolateQuery.Builder,PercolateQuery>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PercolateQuery.Builder	Builder for PercolateQuery.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<PercolateQuery>	_DESERIALIZER	Json deserializer for PercolateQuery

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
static PercolateQuery.Builder	builder()
final JsonData	document()	The source of the document being percolated.
final List<JsonData>	documents()	An array of sources of the documents being percolated.
boolean	equals(Object o)
final String	field()	Required - API name: field
int	hashCode()
final String	id()	API name: id
final String	index()	API name: index
final String	name()	The suffix used for the _percolator_document_slot field when multiple percolate queries are specified.
static PercolateQuery	of(Function<PercolateQuery.Builder,ObjectBuilder<PercolateQuery>> fn)
final String	preference()	Preference used to fetch document to percolate.
final String	routing()	API name: routing
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPercolateQueryDeserializer(ObjectDeserializer<PercolateQuery.Builder> op)
PercolateQuery.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Long	version()	API name: version

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

boost, queryName, serialize, setupQueryBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch._types.query_dsl.QueryVariant

toQuery

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PercolateQuery> _DESERIALIZER

Json deserializer for PercolateQuery

Method Details

of

public static PercolateQuery of(Function<PercolateQuery.Builder,ObjectBuilder<PercolateQuery>> fn)

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

document

@Nullable
public final JsonData document()

The source of the document being percolated.

API name: document

documents

@Nonnull
public final List<JsonData> documents()

An array of sources of the documents being percolated.

API name: documents

field

@Nonnull
public final String field()

Required - API name: field

id

@Nullable
public final String id()

API name: id

index

@Nullable
public final String index()

API name: index

name

@Nullable
public final String name()

The suffix used for the _percolator_document_slot field when multiple percolate queries are specified.

API name: name

preference

@Nullable
public final String preference()

Preference used to fetch document to percolate.

API name: preference

routing

@Nullable
public final String routing()

API name: routing

version

@Nullable
public final Long version()

API name: version

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class QueryBase

toBuilder

@Nonnull
public PercolateQuery.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PercolateQuery.Builder,PercolateQuery>

Returns:

a new builder instance.

builder

@Nonnull
public static PercolateQuery.Builder builder()

setupPercolateQueryDeserializer

protected static void setupPercolateQueryDeserializer(ObjectDeserializer<PercolateQuery.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class QueryBase

equals

public boolean equals(Object o)

Overrides:

equals in class QueryBase