Package co.elastic.clients.elasticsearch.search_application

Class ElasticsearchSearchApplicationAsyncClient

java.lang.Object

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

co.elastic.clients.elasticsearch.search_application.ElasticsearchSearchApplicationAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchSearchApplicationAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSearchApplicationAsyncClient>

Client for the search_application namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CompletableFuture<DeleteSearchApplicationResponse>	delete(DeleteSearchApplicationRequest request)	Delete a search application.
final CompletableFuture<DeleteSearchApplicationResponse>	delete(Function<DeleteSearchApplicationRequest.Builder,ObjectBuilder<DeleteSearchApplicationRequest>> fn)	Delete a search application.
CompletableFuture<DeleteBehavioralAnalyticsResponse>	deleteBehavioralAnalytics(DeleteBehavioralAnalyticsRequest request)	Delete a behavioral analytics collection.
final CompletableFuture<DeleteBehavioralAnalyticsResponse>	deleteBehavioralAnalytics(Function<DeleteBehavioralAnalyticsRequest.Builder,ObjectBuilder<DeleteBehavioralAnalyticsRequest>> fn)	Delete a behavioral analytics collection.
CompletableFuture<GetSearchApplicationResponse>	get(GetSearchApplicationRequest request)	Get search application details.
final CompletableFuture<GetSearchApplicationResponse>	get(Function<GetSearchApplicationRequest.Builder,ObjectBuilder<GetSearchApplicationRequest>> fn)	Get search application details.
CompletableFuture<GetBehavioralAnalyticsResponse>	getBehavioralAnalytics()	Get behavioral analytics collections.
CompletableFuture<GetBehavioralAnalyticsResponse>	getBehavioralAnalytics(GetBehavioralAnalyticsRequest request)	Get behavioral analytics collections.
final CompletableFuture<GetBehavioralAnalyticsResponse>	getBehavioralAnalytics(Function<GetBehavioralAnalyticsRequest.Builder,ObjectBuilder<GetBehavioralAnalyticsRequest>> fn)	Get behavioral analytics collections.
CompletableFuture<ListResponse>	list()	Get search applications.
CompletableFuture<ListResponse>	list(ListRequest request)	Get search applications.
final CompletableFuture<ListResponse>	list(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)	Get search applications.
CompletableFuture<PostBehavioralAnalyticsEventResponse>	postBehavioralAnalyticsEvent(PostBehavioralAnalyticsEventRequest request)	Create a behavioral analytics collection event.
final CompletableFuture<PostBehavioralAnalyticsEventResponse>	postBehavioralAnalyticsEvent(Function<PostBehavioralAnalyticsEventRequest.Builder,ObjectBuilder<PostBehavioralAnalyticsEventRequest>> fn)	Create a behavioral analytics collection event.
CompletableFuture<PutResponse>	put(PutRequest request)	Create or update a search application.
final CompletableFuture<PutResponse>	put(Function<PutRequest.Builder,ObjectBuilder<PutRequest>> fn)	Create or update a search application.
CompletableFuture<PutBehavioralAnalyticsResponse>	putBehavioralAnalytics(PutBehavioralAnalyticsRequest request)	Create a behavioral analytics collection.
final CompletableFuture<PutBehavioralAnalyticsResponse>	putBehavioralAnalytics(Function<PutBehavioralAnalyticsRequest.Builder,ObjectBuilder<PutBehavioralAnalyticsRequest>> fn)	Create a behavioral analytics collection.
CompletableFuture<RenderQueryResponse>	renderQuery(RenderQueryRequest request)	Render a search application query.
final CompletableFuture<RenderQueryResponse>	renderQuery(Function<RenderQueryRequest.Builder,ObjectBuilder<RenderQueryRequest>> fn)	Render a search application query.
CompletableFuture<SearchApplicationSearchResponse<Void>>	search(SearchApplicationSearchRequest request)	Overload of search(SearchApplicationSearchRequest, Class), where Class is defined as Void, meaning the documents will not be deserialized.
<TDocument> CompletableFuture<SearchApplicationSearchResponse<TDocument>>	search(SearchApplicationSearchRequest request, Class<TDocument> tDocumentClass)	Run a search application search.
<TDocument> CompletableFuture<SearchApplicationSearchResponse<TDocument>>	search(SearchApplicationSearchRequest request, Type tDocumentType)	Run a search application search.
final CompletableFuture<SearchApplicationSearchResponse<Void>>	search(Function<SearchApplicationSearchRequest.Builder,ObjectBuilder<SearchApplicationSearchRequest>> fn)	Overload of search(Function, Class), where Class is defined as Void, meaning the documents will not be deserialized.
final <TDocument> CompletableFuture<SearchApplicationSearchResponse<TDocument>>	search(Function<SearchApplicationSearchRequest.Builder,ObjectBuilder<SearchApplicationSearchRequest>> fn, Class<TDocument> tDocumentClass)	Run a search application search.
final <TDocument> CompletableFuture<SearchApplicationSearchResponse<TDocument>>	search(Function<SearchApplicationSearchRequest.Builder,ObjectBuilder<SearchApplicationSearchRequest>> fn, Type tDocumentType)	Run a search application search.
ElasticsearchSearchApplicationAsyncClient	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

ElasticsearchSearchApplicationAsyncClient

public ElasticsearchSearchApplicationAsyncClient(ElasticsearchTransport transport)

ElasticsearchSearchApplicationAsyncClient

public ElasticsearchSearchApplicationAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSearchApplicationAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSearchApplicationAsyncClient>

delete

public CompletableFuture<DeleteSearchApplicationResponse> delete(DeleteSearchApplicationRequest request)

Delete a search application.

Remove a search application and its associated alias. Indices attached to the search application are not removed.

See Also:

• Documentation on elastic.co

delete

public final CompletableFuture<DeleteSearchApplicationResponse> delete(Function<DeleteSearchApplicationRequest.Builder,ObjectBuilder<DeleteSearchApplicationRequest>> fn)

Delete a search application.

Remove a search application and its associated alias. Indices attached to the search application are not removed.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteBehavioralAnalytics

public CompletableFuture<DeleteBehavioralAnalyticsResponse> deleteBehavioralAnalytics(DeleteBehavioralAnalyticsRequest request)

Delete a behavioral analytics collection. The associated data stream is also deleted.

See Also:

• Documentation on elastic.co

deleteBehavioralAnalytics

public final CompletableFuture<DeleteBehavioralAnalyticsResponse> deleteBehavioralAnalytics(Function<DeleteBehavioralAnalyticsRequest.Builder,ObjectBuilder<DeleteBehavioralAnalyticsRequest>> fn)

Delete a behavioral analytics collection. The associated data stream is also deleted.

Parameters:

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

See Also:

• Documentation on elastic.co

get

public CompletableFuture<GetSearchApplicationResponse> get(GetSearchApplicationRequest request)

Get search application details.

See Also:

• Documentation on elastic.co

get

public final CompletableFuture<GetSearchApplicationResponse> get(Function<GetSearchApplicationRequest.Builder,ObjectBuilder<GetSearchApplicationRequest>> fn)

Get search application details.

Parameters:

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

See Also:

• Documentation on elastic.co

getBehavioralAnalytics

public CompletableFuture<GetBehavioralAnalyticsResponse> getBehavioralAnalytics(GetBehavioralAnalyticsRequest request)

Get behavioral analytics collections.

See Also:

• Documentation on elastic.co

getBehavioralAnalytics

public final CompletableFuture<GetBehavioralAnalyticsResponse> getBehavioralAnalytics(Function<GetBehavioralAnalyticsRequest.Builder,ObjectBuilder<GetBehavioralAnalyticsRequest>> fn)

Get behavioral analytics collections.

Parameters:

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

See Also:

• Documentation on elastic.co

getBehavioralAnalytics

public CompletableFuture<GetBehavioralAnalyticsResponse> getBehavioralAnalytics()

Get behavioral analytics collections.

See Also:

• Documentation on elastic.co

list

public CompletableFuture<ListResponse> list(ListRequest request)

Get search applications. Get information about search applications.

See Also:

• Documentation on elastic.co

list

public final CompletableFuture<ListResponse> list(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)

Get search applications. Get information about search applications.

Parameters:

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

See Also:

• Documentation on elastic.co

list

public CompletableFuture<ListResponse> list()

Get search applications. Get information about search applications.

See Also:

• Documentation on elastic.co

postBehavioralAnalyticsEvent

public CompletableFuture<PostBehavioralAnalyticsEventResponse> postBehavioralAnalyticsEvent(PostBehavioralAnalyticsEventRequest request)

Create a behavioral analytics collection event.

See Also:

• Documentation on elastic.co

postBehavioralAnalyticsEvent

public final CompletableFuture<PostBehavioralAnalyticsEventResponse> postBehavioralAnalyticsEvent(Function<PostBehavioralAnalyticsEventRequest.Builder,ObjectBuilder<PostBehavioralAnalyticsEventRequest>> fn)

Create a behavioral analytics collection event.

Parameters:

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

See Also:

• Documentation on elastic.co

put

public CompletableFuture<PutResponse> put(PutRequest request)

Create or update a search application.

See Also:

• Documentation on elastic.co

put

public final CompletableFuture<PutResponse> put(Function<PutRequest.Builder,ObjectBuilder<PutRequest>> fn)

Create or update a search application.

Parameters:

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

See Also:

• Documentation on elastic.co

putBehavioralAnalytics

public CompletableFuture<PutBehavioralAnalyticsResponse> putBehavioralAnalytics(PutBehavioralAnalyticsRequest request)

Create a behavioral analytics collection.

See Also:

• Documentation on elastic.co

putBehavioralAnalytics

public final CompletableFuture<PutBehavioralAnalyticsResponse> putBehavioralAnalytics(Function<PutBehavioralAnalyticsRequest.Builder,ObjectBuilder<PutBehavioralAnalyticsRequest>> fn)

Create a behavioral analytics collection.

Parameters:

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

See Also:

• Documentation on elastic.co

renderQuery

public CompletableFuture<RenderQueryResponse> renderQuery(RenderQueryRequest request)

Render a search application query. Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified. If a parameter used in the search template is not specified in params, the parameter's default value will be used. The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.

You must have read privileges on the backing alias of the search application.

See Also:

• Documentation on elastic.co

renderQuery

public final CompletableFuture<RenderQueryResponse> renderQuery(Function<RenderQueryRequest.Builder,ObjectBuilder<RenderQueryRequest>> fn)

Render a search application query. Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified. If a parameter used in the search template is not specified in params, the parameter's default value will be used. The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.

You must have read privileges on the backing alias of the search application.

Parameters:

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

See Also:

• Documentation on elastic.co

search

public <TDocument>
CompletableFuture<SearchApplicationSearchResponse<TDocument>> search(SearchApplicationSearchRequest request,
 Class<TDocument> tDocumentClass)

Run a search application search. Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable.

See Also:

• Documentation on elastic.co

search

public final <TDocument>
CompletableFuture<SearchApplicationSearchResponse<TDocument>> search(Function<SearchApplicationSearchRequest.Builder,ObjectBuilder<SearchApplicationSearchRequest>> fn,
 Class<TDocument> tDocumentClass)

Run a search application search. Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable.

Parameters:

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

See Also:

• Documentation on elastic.co

search

public CompletableFuture<SearchApplicationSearchResponse<Void>> search(SearchApplicationSearchRequest request)

Overload of search(SearchApplicationSearchRequest, Class), where Class is defined as Void, meaning the documents will not be deserialized.

search

public final CompletableFuture<SearchApplicationSearchResponse<Void>> search(Function<SearchApplicationSearchRequest.Builder,ObjectBuilder<SearchApplicationSearchRequest>> fn)

Overload of search(Function, Class), where Class is defined as Void, meaning the documents will not be deserialized.

search

public <TDocument>
CompletableFuture<SearchApplicationSearchResponse<TDocument>> search(SearchApplicationSearchRequest request,
 Type tDocumentType)

Run a search application search. Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable.

See Also:

• Documentation on elastic.co

search

public final <TDocument>
CompletableFuture<SearchApplicationSearchResponse<TDocument>> search(Function<SearchApplicationSearchRequest.Builder,ObjectBuilder<SearchApplicationSearchRequest>> fn,
 Type tDocumentType)

Run a search application search. Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable.

Parameters:

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

See Also:

• Documentation on elastic.co