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 classExploreRequest.BuilderBuilder 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>_DESERIALIZERJson deserializer forExploreRequeststatic Endpoint<ExploreRequest,ExploreResponse,ErrorResponse>_ENDPOINTEndpoint "graph.explore". -
Method Summary
Modifier and Type Method Description Hopconnections()API name:connectionsExploreControlscontrols()API name:controlsjava.util.List<java.lang.String>index()Required - A comma-separated list of index names to search; use_allor empty string to perform the operation on all indicesstatic ExploreRequestof(java.util.function.Function<ExploreRequest.Builder,ObjectBuilder<ExploreRequest>> fn)Queryquery()API name:queryjava.lang.Stringrouting()Specific routing valuevoidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)protected static voidsetupExploreRequestDeserializer(ObjectDeserializer<ExploreRequest.Builder> op)Timetimeout()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:verticesMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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_allor 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:
serializein interfaceJsonpSerializable
-
serializeInternal
-
setupExploreRequestDeserializer
protected static void setupExploreRequestDeserializer(ObjectDeserializer<ExploreRequest.Builder> op)
-