Package co.elastic.clients.elasticsearch.search_application

Class ElasticsearchSearchApplicationClient

java.lang.Object

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

co.elastic.clients.elasticsearch.search_application.ElasticsearchSearchApplicationClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchSearchApplicationClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSearchApplicationClient>

Client for the search_application namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

ElasticsearchSearchApplicationClient

public ElasticsearchSearchApplicationClient(ElasticsearchTransport transport)

ElasticsearchSearchApplicationClient

public ElasticsearchSearchApplicationClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSearchApplicationClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSearchApplicationClient>

delete

public DeleteSearchApplicationResponse delete(DeleteSearchApplicationRequest request)
                                       throws IOException,
ElasticsearchException

Delete a search application.

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

public final DeleteSearchApplicationResponse delete(Function<DeleteSearchApplicationRequest.Builder,ObjectBuilder<DeleteSearchApplicationRequest>> fn)
                                             throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteBehavioralAnalytics

public DeleteBehavioralAnalyticsResponse deleteBehavioralAnalytics(DeleteBehavioralAnalyticsRequest request)
                                                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteBehavioralAnalytics

public final DeleteBehavioralAnalyticsResponse deleteBehavioralAnalytics(Function<DeleteBehavioralAnalyticsRequest.Builder,ObjectBuilder<DeleteBehavioralAnalyticsRequest>> fn)
                                                                  throws IOException,
ElasticsearchException

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public GetSearchApplicationResponse get(GetSearchApplicationRequest request)
                                 throws IOException,
ElasticsearchException

Get search application details.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public final GetSearchApplicationResponse get(Function<GetSearchApplicationRequest.Builder,ObjectBuilder<GetSearchApplicationRequest>> fn)
                                       throws IOException,
ElasticsearchException

Get search application details.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getBehavioralAnalytics

public GetBehavioralAnalyticsResponse getBehavioralAnalytics(GetBehavioralAnalyticsRequest request)
                                                      throws IOException,
ElasticsearchException

Get behavioral analytics collections.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getBehavioralAnalytics

public final GetBehavioralAnalyticsResponse getBehavioralAnalytics(Function<GetBehavioralAnalyticsRequest.Builder,ObjectBuilder<GetBehavioralAnalyticsRequest>> fn)
                                                            throws IOException,
ElasticsearchException

Get behavioral analytics collections.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getBehavioralAnalytics

public GetBehavioralAnalyticsResponse getBehavioralAnalytics()
                                                      throws IOException,
ElasticsearchException

Get behavioral analytics collections.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

list

public ListResponse list(ListRequest request)
                  throws IOException,
ElasticsearchException

Get search applications. Get information about search applications.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

list

public final ListResponse list(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)
                        throws IOException,
ElasticsearchException

Get search applications. Get information about search applications.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

list

public ListResponse list()
                  throws IOException,
ElasticsearchException

Get search applications. Get information about search applications.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postBehavioralAnalyticsEvent

public PostBehavioralAnalyticsEventResponse postBehavioralAnalyticsEvent(PostBehavioralAnalyticsEventRequest request)
                                                                  throws IOException,
ElasticsearchException

Create a behavioral analytics collection event.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postBehavioralAnalyticsEvent

public final PostBehavioralAnalyticsEventResponse postBehavioralAnalyticsEvent(Function<PostBehavioralAnalyticsEventRequest.Builder,ObjectBuilder<PostBehavioralAnalyticsEventRequest>> fn)
                                                                        throws IOException,
ElasticsearchException

Create a behavioral analytics collection event.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

put

public PutResponse put(PutRequest request)
                throws IOException,
ElasticsearchException

Create or update a search application.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

put

public final PutResponse put(Function<PutRequest.Builder,ObjectBuilder<PutRequest>> fn)
                      throws IOException,
ElasticsearchException

Create or update a search application.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putBehavioralAnalytics

public PutBehavioralAnalyticsResponse putBehavioralAnalytics(PutBehavioralAnalyticsRequest request)
                                                      throws IOException,
ElasticsearchException

Create a behavioral analytics collection.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putBehavioralAnalytics

public final PutBehavioralAnalyticsResponse putBehavioralAnalytics(Function<PutBehavioralAnalyticsRequest.Builder,ObjectBuilder<PutBehavioralAnalyticsRequest>> fn)
                                                            throws IOException,
ElasticsearchException

Create a behavioral analytics collection.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

renderQuery

public RenderQueryResponse renderQuery(RenderQueryRequest request)
                                throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

renderQuery

public final RenderQueryResponse renderQuery(Function<RenderQueryRequest.Builder,ObjectBuilder<RenderQueryRequest>> fn)
                                      throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

search

public <TDocument>
SearchApplicationSearchResponse<TDocument> search(SearchApplicationSearchRequest request,
 Class<TDocument> tDocumentClass)
                                           throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

search

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

search

public SearchApplicationSearchResponse<Void> search(SearchApplicationSearchRequest request)
                                             throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

search

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

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

Throws:

IOException

ElasticsearchException

search

public <TDocument>
SearchApplicationSearchResponse<TDocument> search(SearchApplicationSearchRequest request,
 Type tDocumentType)
                                           throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

search

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co