Package co.elastic.clients.elasticsearch.graph

Class ExploreRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.graph.ExploreRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class ExploreRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<ExploreRequest>	_DESERIALIZER	Json deserializer for ExploreRequest
static Endpoint<ExploreRequest,ExploreResponse,ElasticsearchError>	ENDPOINT	Endpoint "graph.explore".

Constructor Summary

Constructors

Constructor	Description
ExploreRequest(ExploreRequest.Builder builder)
ExploreRequest(java.util.function.Function<ExploreRequest.Builder,ExploreRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
Hop	connections()	API name: connections
ExploreControls	controls()	API name: controls
java.util.List<java.lang.String>	index()	Required - A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices
Query	query()	API name: query
java.lang.String	routing()	Specific routing value
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupExploreRequestDeserializer(DelegatingDeserializer<ExploreRequest.Builder> op)
java.lang.String	timeout()	Explicit operation timeout
java.util.List<java.lang.String>	type()	A comma-separated list of document types to search; leave empty to perform the operation on all types
java.util.List<VertexDefinition>	vertices()	API name: vertices

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ExploreRequest> _DESERIALIZER

Json deserializer for ExploreRequest

ENDPOINT

public static final Endpoint<ExploreRequest,ExploreResponse,ElasticsearchError> ENDPOINT

Endpoint "graph.explore".

Constructor Details

ExploreRequest

public ExploreRequest(ExploreRequest.Builder builder)

ExploreRequest

public ExploreRequest(java.util.function.Function<ExploreRequest.Builder,ExploreRequest.Builder> fn)

Method Details

index

public java.util.List<java.lang.String> index()

Required - A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

API name: index

type

@Nullable
public java.util.List<java.lang.String> type()

A comma-separated list of document types to search; leave empty to perform the operation on all types

API name: type

routing

@Nullable
public java.lang.String routing()

Specific routing value

API name: routing

timeout

@Nullable
public java.lang.String timeout()

Explicit operation timeout

API name: timeout

connections

@Nullable
public Hop connections()

API name: connections

controls

@Nullable
public ExploreControls controls()

API name: controls

query

@Nullable
public Query query()

API name: query

vertices

@Nullable
public java.util.List<VertexDefinition> vertices()

API name: vertices

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

setupExploreRequestDeserializer

protected static void setupExploreRequestDeserializer(DelegatingDeserializer<ExploreRequest.Builder> op)