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:

JsonpSerializable

@JsonpDeserializable
public class ExploreRequest
extends RequestBase
implements JsonpSerializable

Explore extracted and summarized information about the documents and terms in an index.

See Also:

• API specification

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 final JsonpDeserializer<ExploreRequest>	_DESERIALIZER	Json deserializer for ExploreRequest
static final Endpoint<ExploreRequest,ExploreResponse,ErrorResponse>	_ENDPOINT	Endpoint "graph.explore".

Method Summary

Modifier and Type	Method	Description
final Hop	connections()	API name: connections
final ExploreControls	controls()	API name: controls
final List<String>	index()	Required - A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices
static ExploreRequest	of(Function<ExploreRequest.Builder,ObjectBuilder<ExploreRequest>> fn)
final Query	query()	API name: query
final 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(ObjectDeserializer<ExploreRequest.Builder> op)
final Time	timeout()	Explicit operation timeout
final List<VertexDefinition>	vertices()	API name: vertices

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ExploreRequest> _DESERIALIZER

Json deserializer for ExploreRequest

_ENDPOINT

public static final Endpoint<ExploreRequest,ExploreResponse,ErrorResponse> _ENDPOINT

Endpoint "graph.explore".

Method Details

of

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

connections

@Nullable
public final Hop connections()

API name: connections

controls

@Nullable
public final ExploreControls controls()

API name: controls

index

public final List<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

query

@Nullable
public final Query query()

API name: query

routing

@Nullable
public final String routing()

Specific routing value

API name: routing

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout

vertices

public final 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(ObjectDeserializer<ExploreRequest.Builder> op)