org.springframework.data.elasticsearch.client.reactive

Class DefaultReactiveElasticsearchClient

java.lang.Object

org.springframework.data.elasticsearch.client.reactive.DefaultReactiveElasticsearchClient

All Implemented Interfaces:

ReactiveElasticsearchClient

public class DefaultReactiveElasticsearchClient
extends Object
implements ReactiveElasticsearchClient

A WebClient based ReactiveElasticsearchClient that connects to an Elasticsearch cluster using HTTP.

Since:

3.2

Author:

Christoph Strobl, Mark Paluch

See Also:

ClientConfiguration, ReactiveRestClients

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.elasticsearch.client.reactive.ReactiveElasticsearchClient

ReactiveElasticsearchClient.ReactiveElasticsearchClientCallback, ReactiveElasticsearchClient.Status

Constructor Summary

Constructors

Constructor and Description
DefaultReactiveElasticsearchClient(HostProvider hostProvider) Create a new DefaultReactiveElasticsearchClient using the given HostProvider to obtain server connections.

Method Summary

Modifier and Type	Method and Description
static ReactiveElasticsearchClient	create(ClientConfiguration clientConfiguration) Create a new DefaultReactiveElasticsearchClient given ClientConfiguration.
static ReactiveElasticsearchClient	create(HttpHeaders headers, String... hosts) Create a new DefaultReactiveElasticsearchClient aware of the given nodes in the cluster.
reactor.core.publisher.Mono<org.elasticsearch.action.delete.DeleteResponse>	delete(HttpHeaders headers, org.elasticsearch.action.delete.DeleteRequest deleteRequest) Execute the given DeleteRequest against the delete API to remove a document.
reactor.core.publisher.Mono<org.elasticsearch.index.reindex.BulkByScrollResponse>	deleteBy(HttpHeaders headers, org.elasticsearch.index.reindex.DeleteByQueryRequest deleteRequest) Execute a DeleteByQueryRequest against the delete by query API.
reactor.core.publisher.Mono<ClientResponse>	execute(ReactiveElasticsearchClient.ReactiveElasticsearchClientCallback callback) Compose the actual command/s to run against Elasticsearch using the underlying connection.
reactor.core.publisher.Mono<Boolean>	exists(HttpHeaders headers, org.elasticsearch.action.get.GetRequest getRequest) Checks for the existence of a document.
reactor.core.publisher.Mono<org.elasticsearch.index.get.GetResult>	get(HttpHeaders headers, org.elasticsearch.action.get.GetRequest getRequest) Execute the given GetRequest against the get API to retrieve a document by id.
reactor.core.publisher.Mono<org.elasticsearch.action.index.IndexResponse>	index(HttpHeaders headers, org.elasticsearch.action.index.IndexRequest indexRequest) Execute the given IndexRequest against the index API to index a document.
reactor.core.publisher.Mono<org.elasticsearch.action.main.MainResponse>	info(HttpHeaders headers) Get the cluster info otherwise provided when sending an HTTP request to port 9200.
reactor.core.publisher.Flux<org.elasticsearch.index.get.GetResult>	multiGet(HttpHeaders headers, org.elasticsearch.action.get.MultiGetRequest multiGetRequest) Execute the given MultiGetRequest against the multi-get API to retrieve multiple documents by id.
reactor.core.publisher.Mono<Boolean>	ping(HttpHeaders headers) Pings the remote Elasticsearch cluster and emits true if the ping succeeded, false otherwise.
reactor.core.publisher.Flux<org.elasticsearch.search.SearchHit>	scroll(HttpHeaders headers, org.elasticsearch.action.search.SearchRequest searchRequest) Execute the given SearchRequest against the search scroll API.
reactor.core.publisher.Flux<org.elasticsearch.search.SearchHit>	search(HttpHeaders headers, org.elasticsearch.action.search.SearchRequest searchRequest) Execute the given SearchRequest against the search API.
reactor.core.publisher.Mono<ReactiveElasticsearchClient.Status>	status() Get the current client ReactiveElasticsearchClient.Status.
reactor.core.publisher.Mono<org.elasticsearch.action.update.UpdateResponse>	update(HttpHeaders headers, org.elasticsearch.action.update.UpdateRequest updateRequest) Execute the given UpdateRequest against the update API to alter a document.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.elasticsearch.client.reactive.ReactiveElasticsearchClient

delete, delete, deleteBy, deleteBy, exists, exists, get, get, index, index, info, multiGet, multiGet, ping, scroll, search, search, update, update

Constructor Detail

DefaultReactiveElasticsearchClient

public DefaultReactiveElasticsearchClient(HostProvider hostProvider)

Create a new DefaultReactiveElasticsearchClient using the given HostProvider to obtain server connections.

Parameters:

hostProvider - must not be null.

Method Detail

create

public static ReactiveElasticsearchClient create(HttpHeaders headers,
                                                 String... hosts)

Create a new DefaultReactiveElasticsearchClient aware of the given nodes in the cluster.
NOTE If the cluster requires authentication be sure to provide the according HttpHeaders correctly.

Parameters:

headers - Use HttpHeaders to provide eg. authentication data. Must not be null.

hosts - must not be null nor empty!

Returns:

new instance of DefaultReactiveElasticsearchClient.

create

public static ReactiveElasticsearchClient create(ClientConfiguration clientConfiguration)

Create a new DefaultReactiveElasticsearchClient given ClientConfiguration.
NOTE If the cluster requires authentication be sure to provide the according HttpHeaders correctly.

Parameters:

clientConfiguration - Client configuration. Must not be null.

Returns:

new instance of DefaultReactiveElasticsearchClient.

ping

public reactor.core.publisher.Mono<Boolean> ping(HttpHeaders headers)

Description copied from interface: ReactiveElasticsearchClient

Pings the remote Elasticsearch cluster and emits true if the ping succeeded, false otherwise.

Specified by:

ping in interface ReactiveElasticsearchClient

Parameters:

headers - Use HttpHeaders to provide eg. authentication data. Must not be null.

Returns:

the Mono emitting the result of the ping attempt.

info

public reactor.core.publisher.Mono<org.elasticsearch.action.main.MainResponse> info(HttpHeaders headers)

Description copied from interface: ReactiveElasticsearchClient

Get the cluster info otherwise provided when sending an HTTP request to port 9200.

Specified by:

info in interface ReactiveElasticsearchClient

Parameters:

headers - Use HttpHeaders to provide eg. authentication data. Must not be null.

Returns:

the Mono emitting the result of the info request.

get

public reactor.core.publisher.Mono<org.elasticsearch.index.get.GetResult> get(HttpHeaders headers,
                                                                              org.elasticsearch.action.get.GetRequest getRequest)

Description copied from interface: ReactiveElasticsearchClient

Execute the given GetRequest against the get API to retrieve a document by id.

Specified by:

get in interface ReactiveElasticsearchClient

Parameters:

headers - Use HttpHeaders to provide eg. authentication data. Must not be null.

getRequest - must not be null.

Returns:

the Mono emitting the result.

See Also:

Get API on elastic.co

multiGet

public reactor.core.publisher.Flux<org.elasticsearch.index.get.GetResult> multiGet(HttpHeaders headers,
                                                                                   org.elasticsearch.action.get.MultiGetRequest multiGetRequest)

Description copied from interface: ReactiveElasticsearchClient

Execute the given MultiGetRequest against the multi-get API to retrieve multiple documents by id.

Specified by:

multiGet in interface ReactiveElasticsearchClient

Parameters:

headers - Use HttpHeaders to provide eg. authentication data. Must not be null.

multiGetRequest - must not be null.

Returns:

the Flux emitting the result.

See Also:

Multi Get API on elastic.co

exists

public reactor.core.publisher.Mono<Boolean> exists(HttpHeaders headers,
                                                   org.elasticsearch.action.get.GetRequest getRequest)

Description copied from interface: ReactiveElasticsearchClient

Checks for the existence of a document. Emits true if it exists, false otherwise.

Specified by:

exists in interface ReactiveElasticsearchClient

Parameters:

headers - Use HttpHeaders to provide eg. authentication data. Must not be null.

getRequest - must not be null.

Returns:

the Mono emitting true if it exists, false otherwise.

index

public reactor.core.publisher.Mono<org.elasticsearch.action.index.IndexResponse> index(HttpHeaders headers,
                                                                                       org.elasticsearch.action.index.IndexRequest indexRequest)

Description copied from interface: ReactiveElasticsearchClient

Execute the given IndexRequest against the index API to index a document.

Specified by:

index in interface ReactiveElasticsearchClient

Parameters:

headers - Use HttpHeaders to provide eg. authentication data. Must not be null.

indexRequest - must not be null.

Returns:

the Mono emitting the IndexResponse.

See Also:

Index API on elastic.co

update

public reactor.core.publisher.Mono<org.elasticsearch.action.update.UpdateResponse> update(HttpHeaders headers,
                                                                                          org.elasticsearch.action.update.UpdateRequest updateRequest)

Description copied from interface: ReactiveElasticsearchClient

Execute the given UpdateRequest against the update API to alter a document.

Specified by:

update in interface ReactiveElasticsearchClient

Parameters:

headers - Use HttpHeaders to provide eg. authentication data. Must not be null.

updateRequest - must not be null.

Returns:

the Mono emitting the UpdateResponse.

See Also:

Update API on elastic.co

delete

public reactor.core.publisher.Mono<org.elasticsearch.action.delete.DeleteResponse> delete(HttpHeaders headers,
                                                                                          org.elasticsearch.action.delete.DeleteRequest deleteRequest)

Description copied from interface: ReactiveElasticsearchClient

Execute the given DeleteRequest against the delete API to remove a document.

Specified by:

delete in interface ReactiveElasticsearchClient

Parameters:

headers - Use HttpHeaders to provide eg. authentication data. Must not be null.

deleteRequest - must not be null.

Returns:

the Mono emitting the DeleteResponse.

See Also:

Delete API on elastic.co

search

public reactor.core.publisher.Flux<org.elasticsearch.search.SearchHit> search(HttpHeaders headers,
                                                                              org.elasticsearch.action.search.SearchRequest searchRequest)

Description copied from interface: ReactiveElasticsearchClient

Execute the given SearchRequest against the search API.

Specified by:

search in interface ReactiveElasticsearchClient

Parameters:

headers - Use HttpHeaders to provide eg. authentication data. Must not be null.

searchRequest - must not be null.

Returns:

the Flux emitting hits one by one.

See Also:

Search API on elastic.co

scroll

public reactor.core.publisher.Flux<org.elasticsearch.search.SearchHit> scroll(HttpHeaders headers,
                                                                              org.elasticsearch.action.search.SearchRequest searchRequest)

Description copied from interface: ReactiveElasticsearchClient

Execute the given SearchRequest against the search scroll API.
Scroll keeps track of scrollIds returned by the server and provides them when requesting more results via _search/scroll. All bound server resources are freed on completion.

Specified by:

scroll in interface ReactiveElasticsearchClient

Parameters:

headers - Use HttpHeaders to provide eg. authentication data. Must not be null.

searchRequest - must not be null.

Returns:

the Flux emitting hits one by one.

See Also:

Search Scroll API on elastic.co

deleteBy

public reactor.core.publisher.Mono<org.elasticsearch.index.reindex.BulkByScrollResponse> deleteBy(HttpHeaders headers,
                                                                                                  org.elasticsearch.index.reindex.DeleteByQueryRequest deleteRequest)

Description copied from interface: ReactiveElasticsearchClient

Execute a DeleteByQueryRequest against the delete by query API.

Specified by:

deleteBy in interface ReactiveElasticsearchClient

Parameters:

headers - Use HttpHeaders to provide eg. authentication data. Must not be null.

deleteRequest - must not be null.

Returns:

a Mono emitting operation response.

See Also:

Delete By Query API on elastic.co

execute

public reactor.core.publisher.Mono<ClientResponse> execute(ReactiveElasticsearchClient.ReactiveElasticsearchClientCallback callback)

Description copied from interface: ReactiveElasticsearchClient

Compose the actual command/s to run against Elasticsearch using the underlying connection. Execute selects an active server from the available ones and retries operations that fail with a ConnectException on another node if the previously selected one becomes unavailable.

Specified by:

execute in interface ReactiveElasticsearchClient

Parameters:

callback - the callback wielding the actual command to run.

Returns:

the Mono emitting the ClientResponse once subscribed.

status

public reactor.core.publisher.Mono<ReactiveElasticsearchClient.Status> status()

Description copied from interface: ReactiveElasticsearchClient

Get the current client ReactiveElasticsearchClient.Status.
NOTE the actual implementation might choose to actively check the current cluster state by pinging known nodes.

Specified by:

status in interface ReactiveElasticsearchClient

Returns:

the actual ReactiveElasticsearchClient.Status information.