Search Applications
- class elasticsearch_serverless.client.SearchApplicationClient(client: BaseClient)
- delete(*, name: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None) ObjectApiResponse[Any]
Delete a search application.
Remove a search application and its associated alias. Indices attached to the search application are not removed.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete
- Parameters:
name – The name of the search application to delete.
- delete_behavioral_analytics(*, name: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None) ObjectApiResponse[Any]
Delete a behavioral analytics collection. The associated data stream is also deleted.
- Parameters:
name – The name of the analytics collection to be deleted
- get(*, name: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None) ObjectApiResponse[Any]
Get search application details.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get
- Parameters:
name – The name of the search application
- get_behavioral_analytics(*, name: Sequence[str] | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None) ObjectApiResponse[Any]
Get behavioral analytics collections.
- Parameters:
name – A list of analytics collections to limit the returned information
- list(*, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, from_: int | None = None, human: bool | None = None, pretty: bool | None = None, q: str | None = None, size: int | None = None) ObjectApiResponse[Any]
Get search applications. Get information about search applications.
- Parameters:
from – Starting offset.
q – Query in the Lucene query string syntax.
size – Specifies a max number of results to get.
- put(*, name: str, search_application: Mapping[str, Any] | None = None, body: Mapping[str, Any] | None = None, create: bool | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None) ObjectApiResponse[Any]
Create or update a search application.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put
- Parameters:
name – The name of the search application to be created or updated.
search_application –
create – If true, this request cannot replace or update existing Search Applications.
- put_behavioral_analytics(*, name: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None) ObjectApiResponse[Any]
Create a behavioral analytics collection.
- Parameters:
name – The name of the analytics collection to be created or updated.
- search(*, name: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, params: Mapping[str, Any] | None = None, pretty: bool | None = None, typed_keys: bool | None = None, body: Dict[str, Any] | None = None) ObjectApiResponse[Any]
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.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-search
- Parameters:
name – The name of the search application to be searched.
params – Query parameters specific to this request, which will override any defaults specified in the template.
typed_keys – Determines whether aggregation names are prefixed by their respective types in the response.