Package co.elastic.clients.elasticsearch.graph

Class ElasticsearchGraphClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchGraphClient>

co.elastic.clients.elasticsearch.graph.ElasticsearchGraphClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchGraphClient
extends ApiClient<ElasticsearchTransport,ElasticsearchGraphClient>

Client for the graph namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchGraphClient(ElasticsearchTransport transport)
ElasticsearchGraphClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
ExploreResponse	explore(ExploreRequest request)	Explore graph analytics.
final ExploreResponse	explore(Function<ExploreRequest.Builder,ObjectBuilder<ExploreRequest>> fn)	Explore graph analytics.
ElasticsearchGraphClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchGraphClient

public ElasticsearchGraphClient(ElasticsearchTransport transport)

ElasticsearchGraphClient

public ElasticsearchGraphClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchGraphClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchGraphClient>

explore

public ExploreResponse explore(ExploreRequest request)
                        throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

explore

public final ExploreResponse explore(Function<ExploreRequest.Builder,ObjectBuilder<ExploreRequest>> fn)
                              throws IOException,
ElasticsearchException

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.

Parameters:

fn - a function that initializes a builder to create the ExploreRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co