Class ExploreRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.graph.ExploreRequest
- All Implemented Interfaces:
JsonpSerializable
Extracts and summarizes information about the documents and terms in an
Elasticsearch data stream or index.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<ExploreRequest>
Json deserializer forExploreRequest
static final Endpoint<ExploreRequest,
ExploreResponse, ErrorResponse> Endpoint "graph.explore
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Hop
Specifies or more fields from which you want to extract terms that are associated with the specified vertices.final ExploreControls
controls()
Direct the Graph API how to build the graph.index()
Required - Name of the index.static ExploreRequest
final Query
query()
A seed query that identifies the documents of interest.final String
routing()
Custom value used to route operations to a specific shard.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
final Time
timeout()
Specifies the period of time to wait for a response from each shard.final List<VertexDefinition>
vertices()
Specifies one or more fields that contain the terms you want to include in the graph as vertices.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forExploreRequest
-
_ENDPOINT
Endpoint "graph.explore
".
-
-
Method Details
-
of
-
connections
Specifies or more fields from which you want to extract terms that are associated with the specified vertices.API name:
connections
-
controls
Direct the Graph API how to build the graph.API name:
controls
-
index
Required - Name of the index.API name:
index
-
query
A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.API name:
query
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
timeout
Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.API name:
timeout
-
vertices
Specifies one or more fields that contain the terms you want to include in the graph as 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)
-