Search Applications
- class elasticsearch.client.SearchApplicationClient(client)
- Parameters:
client (BaseClient)
- delete(*, name, error_trace=None, filter_path=None, human=None, pretty=None)
Deletes a search application.
https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-search-application.html
- Parameters:
name (str) – The name of the search application to delete
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
- Return type:
ObjectApiResponse[Any]
- delete_behavioral_analytics(*, name, error_trace=None, filter_path=None, human=None, pretty=None)
Delete a behavioral analytics collection.
https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-analytics-collection.html
- Parameters:
name (str) – The name of the analytics collection to be deleted
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
- Return type:
ObjectApiResponse[Any]
- get(*, name, error_trace=None, filter_path=None, human=None, pretty=None)
Returns the details about a search application.
https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-search-application.html
- Parameters:
name (str) – The name of the search application
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
- Return type:
ObjectApiResponse[Any]
- get_behavioral_analytics(*, name=None, error_trace=None, filter_path=None, human=None, pretty=None)
Returns the existing behavioral analytics collections.
https://www.elastic.co/guide/en/elasticsearch/reference/8.14/list-analytics-collection.html
- Parameters:
name (Sequence[str] | None) – A list of analytics collections to limit the returned information
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
- Return type:
ObjectApiResponse[Any]
- list(*, error_trace=None, filter_path=None, from_=None, human=None, pretty=None, q=None, size=None)
Returns the existing search applications.
https://www.elastic.co/guide/en/elasticsearch/reference/8.14/list-search-applications.html
- Parameters:
from – Starting offset.
q (str | None) – Query in the Lucene query string syntax.
size (int | None) – Specifies a max number of results to get.
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)
- Return type:
ObjectApiResponse[Any]
- put(*, name, search_application=None, body=None, create=None, error_trace=None, filter_path=None, human=None, pretty=None)
Creates or updates a search application.
https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-search-application.html
- Parameters:
name (str) – The name of the search application to be created or updated.
search_application (Mapping[str, Any] | None)
create (bool | None) – If true, this request cannot replace or update existing Search Applications.
body (Mapping[str, Any] | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
- Return type:
ObjectApiResponse[Any]
- put_behavioral_analytics(*, name, error_trace=None, filter_path=None, human=None, pretty=None)
Creates a behavioral analytics collection.
https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-analytics-collection.html
- Parameters:
name (str) – The name of the analytics collection to be created or updated.
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
- Return type:
ObjectApiResponse[Any]
- search(*, name, error_trace=None, filter_path=None, human=None, params=None, pretty=None, typed_keys=None, body=None)
Perform a search against a search application
https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-application-search.html
- Parameters:
name (str) – The name of the search application to be searched.
params (Mapping[str, Any] | None) – Query parameters specific to this request, which will override any defaults specified in the template.
typed_keys (bool | None) – Determines whether aggregation names are prefixed by their respective types in the response.
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)
- Return type:
ObjectApiResponse[Any]