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 graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned.
See Also:

  • Field Details

  • Method Details

    • of

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

    • connections

      @Nullable public final Hop connections()
      Specifies or more fields from which you want to extract terms that are associated with the specified vertices.

      API name: connections

    • controls

      @Nullable public final ExploreControls controls()
      Direct the Graph API how to build the graph.

      API name: controls

    • index

      public final List<String> index()
      Required - Name of the index.

      API name: index

    • query

      @Nullable public final Query query()
      A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.

      API name: query

    • routing

      @Nullable public final String routing()
      Custom value used to route operations to a specific shard.

      API name: routing

    • timeout

      @Nullable public final Time 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

      public final List<VertexDefinition> vertices()
      Specifies one or more fields that contain the terms you want to include in the graph as 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)