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 forExploreRequest
.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 forExploreRequest
static Endpoint<ExploreRequest,ExploreResponse,ErrorResponse>
_ENDPOINT
Endpoint "graph.explore
". -
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 indicesstatic ExploreRequest
of(java.util.function.Function<ExploreRequest.Builder,ObjectBuilder<ExploreRequest>> fn)
Query
query()
API name:query
java.lang.String
routing()
Specific routing valuevoid
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)
Time
timeout()
Explicit operation timeoutjava.util.List<java.lang.String>
type()
A comma-separated list of document types to search; leave empty to perform the operation on all typesjava.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
Json deserializer forExploreRequest
-
_ENDPOINT
Endpoint "graph.explore
".
-
-
Method Details
-
of
public static ExploreRequest of(java.util.function.Function<ExploreRequest.Builder,ObjectBuilder<ExploreRequest>> fn) -
connections
API name:connections
-
controls
API name:controls
-
index
public final 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 indicesAPI name:
index
-
query
API name:query
-
routing
@Nullable public final java.lang.String routing()Specific routing valueAPI name:
routing
-
timeout
Explicit operation timeoutAPI name:
timeout
-
type
public final java.util.List<java.lang.String> type()A comma-separated list of document types to search; leave empty to perform the operation on all typesAPI name:
type
-
vertices
API name:vertices
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupExploreRequestDeserializer
protected static void setupExploreRequestDeserializer(ObjectDeserializer<ExploreRequest.Builder> op)
-