habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
api-reference-docs
elasticsearch-js/docs/reference/api/SearchApplication.md
Josh Mock b140fcda7f Another round of tweaks
2025-05-28 10:02:30 -05:00

13 KiB
Raw Permalink Blame History

SearchApplication [class-SearchApplication]

Constructor

new SearchApplication(transport: [Transport](./Transport.md));

Properties [class-properties-SearchApplication]

Name Type Description
acceptedParams Record<string, { path: string[]; body: string[]; query: string[]; }>  
transport Transport  

Methods [class-methods-SearchApplication]

Name Signature Description
delete delete(this: [That](./That.md), params: [SearchApplicationDeleteRequest](./SearchApplicationDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationDeleteResponse](./SearchApplicationDeleteResponse.md)>; Delete a search application. Remove a search application and its associated alias. Indices attached to the search application are not removed.
delete delete(this: [That](./That.md), params: [SearchApplicationDeleteRequest](./SearchApplicationDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationDeleteResponse](./SearchApplicationDeleteResponse.md), unknown>>;  
delete delete(this: [That](./That.md), params: [SearchApplicationDeleteRequest](./SearchApplicationDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationDeleteResponse](./SearchApplicationDeleteResponse.md)>;  
deleteBehavioralAnalytics deleteBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationDeleteBehavioralAnalyticsRequest](./SearchApplicationDeleteBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationDeleteBehavioralAnalyticsResponse](./SearchApplicationDeleteBehavioralAnalyticsResponse.md)>; Delete a behavioral analytics collection. The associated data stream is also deleted.
deleteBehavioralAnalytics deleteBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationDeleteBehavioralAnalyticsRequest](./SearchApplicationDeleteBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationDeleteBehavioralAnalyticsResponse](./SearchApplicationDeleteBehavioralAnalyticsResponse.md), unknown>>;  
deleteBehavioralAnalytics deleteBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationDeleteBehavioralAnalyticsRequest](./SearchApplicationDeleteBehavioralAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationDeleteBehavioralAnalyticsResponse](./SearchApplicationDeleteBehavioralAnalyticsResponse.md)>;  
get get(this: [That](./That.md), params: [SearchApplicationGetRequest](./SearchApplicationGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationGetResponse](./SearchApplicationGetResponse.md)>; Get search application details.
get get(this: [That](./That.md), params: [SearchApplicationGetRequest](./SearchApplicationGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationGetResponse](./SearchApplicationGetResponse.md), unknown>>;  
get get(this: [That](./That.md), params: [SearchApplicationGetRequest](./SearchApplicationGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationGetResponse](./SearchApplicationGetResponse.md)>;  
getBehavioralAnalytics getBehavioralAnalytics(this: [That](./That.md), params?: [SearchApplicationGetBehavioralAnalyticsRequest](./SearchApplicationGetBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationGetBehavioralAnalyticsResponse](./SearchApplicationGetBehavioralAnalyticsResponse.md)>; Get behavioral analytics collections.
getBehavioralAnalytics getBehavioralAnalytics(this: [That](./That.md), params?: [SearchApplicationGetBehavioralAnalyticsRequest](./SearchApplicationGetBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationGetBehavioralAnalyticsResponse](./SearchApplicationGetBehavioralAnalyticsResponse.md), unknown>>;  
getBehavioralAnalytics getBehavioralAnalytics(this: [That](./That.md), params?: [SearchApplicationGetBehavioralAnalyticsRequest](./SearchApplicationGetBehavioralAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationGetBehavioralAnalyticsResponse](./SearchApplicationGetBehavioralAnalyticsResponse.md)>;  
list list(this: [That](./That.md), params?: [SearchApplicationListRequest](./SearchApplicationListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationListResponse](./SearchApplicationListResponse.md)>; Get search applications. Get information about search applications.
list list(this: [That](./That.md), params?: [SearchApplicationListRequest](./SearchApplicationListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationListResponse](./SearchApplicationListResponse.md), unknown>>;  
list list(this: [That](./That.md), params?: [SearchApplicationListRequest](./SearchApplicationListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationListResponse](./SearchApplicationListResponse.md)>;  
postBehavioralAnalyticsEvent postBehavioralAnalyticsEvent(this: [That](./That.md), params: [SearchApplicationPostBehavioralAnalyticsEventRequest](./SearchApplicationPostBehavioralAnalyticsEventRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationPostBehavioralAnalyticsEventResponse](./SearchApplicationPostBehavioralAnalyticsEventResponse.md)>; Create a behavioral analytics collection event.
postBehavioralAnalyticsEvent postBehavioralAnalyticsEvent(this: [That](./That.md), params: [SearchApplicationPostBehavioralAnalyticsEventRequest](./SearchApplicationPostBehavioralAnalyticsEventRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationPostBehavioralAnalyticsEventResponse](./SearchApplicationPostBehavioralAnalyticsEventResponse.md), unknown>>;  
postBehavioralAnalyticsEvent postBehavioralAnalyticsEvent(this: [That](./That.md), params: [SearchApplicationPostBehavioralAnalyticsEventRequest](./SearchApplicationPostBehavioralAnalyticsEventRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationPostBehavioralAnalyticsEventResponse](./SearchApplicationPostBehavioralAnalyticsEventResponse.md)>;  
put put(this: [That](./That.md), params: [SearchApplicationPutRequest](./SearchApplicationPutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationPutResponse](./SearchApplicationPutResponse.md)>; Create or update a search application.
put put(this: [That](./That.md), params: [SearchApplicationPutRequest](./SearchApplicationPutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationPutResponse](./SearchApplicationPutResponse.md), unknown>>;  
put put(this: [That](./That.md), params: [SearchApplicationPutRequest](./SearchApplicationPutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationPutResponse](./SearchApplicationPutResponse.md)>;  
putBehavioralAnalytics putBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationPutBehavioralAnalyticsRequest](./SearchApplicationPutBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationPutBehavioralAnalyticsResponse](./SearchApplicationPutBehavioralAnalyticsResponse.md)>; Create a behavioral analytics collection.
putBehavioralAnalytics putBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationPutBehavioralAnalyticsRequest](./SearchApplicationPutBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationPutBehavioralAnalyticsResponse](./SearchApplicationPutBehavioralAnalyticsResponse.md), unknown>>;  
putBehavioralAnalytics putBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationPutBehavioralAnalyticsRequest](./SearchApplicationPutBehavioralAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationPutBehavioralAnalyticsResponse](./SearchApplicationPutBehavioralAnalyticsResponse.md)>;  
renderQuery renderQuery(this: [That](./That.md), params: [SearchApplicationRenderQueryRequest](./SearchApplicationRenderQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationRenderQueryResponse](./SearchApplicationRenderQueryResponse.md)>; 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.
renderQuery renderQuery(this: [That](./That.md), params: [SearchApplicationRenderQueryRequest](./SearchApplicationRenderQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationRenderQueryResponse](./SearchApplicationRenderQueryResponse.md), unknown>>;  
renderQuery renderQuery(this: [That](./That.md), params: [SearchApplicationRenderQueryRequest](./SearchApplicationRenderQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationRenderQueryResponse](./SearchApplicationRenderQueryResponse.md)>;  
search search<TDocument = unknown, TAggregations = Record<[AggregateName](./AggregateName.md), [AggregationsAggregate](./AggregationsAggregate.md)>>(this: [That](./That.md), params: [SearchApplicationSearchRequest](./SearchApplicationSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationSearchResponse](./SearchApplicationSearchResponse.md)<TDocument, TAggregations>>; 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.
search search<TDocument = unknown, TAggregations = Record<[AggregateName](./AggregateName.md), [AggregationsAggregate](./AggregationsAggregate.md)>>(this: [That](./That.md), params: [SearchApplicationSearchRequest](./SearchApplicationSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationSearchResponse](./SearchApplicationSearchResponse.md)<TDocument, TAggregations>, unknown>>;  
search search<TDocument = unknown, TAggregations = Record<[AggregateName](./AggregateName.md), [AggregationsAggregate](./AggregationsAggregate.md)>>(this: [That](./That.md), params: [SearchApplicationSearchRequest](./SearchApplicationSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationSearchResponse](./SearchApplicationSearchResponse.md)<TDocument, TAggregations>>;