Enrich Policies
- class elasticsearch.client.EnrichClient(client)
- Parameters:
client (BaseClient) –
- delete_policy(*, name, error_trace=None, filter_path=None, human=None, pretty=None)
Deletes an existing enrich policy and its enrich index.
https://www.elastic.co/guide/en/elasticsearch/reference/8.11/delete-enrich-policy-api.html
- execute_policy(*, name, error_trace=None, filter_path=None, human=None, pretty=None, wait_for_completion=None)
Creates the enrich index for an existing enrich policy.
https://www.elastic.co/guide/en/elasticsearch/reference/8.11/execute-enrich-policy-api.html
- Parameters:
- Return type:
ObjectApiResponse[Any]
- get_policy(*, name=None, error_trace=None, filter_path=None, human=None, pretty=None)
Gets information about an enrich policy.
https://www.elastic.co/guide/en/elasticsearch/reference/8.11/get-enrich-policy-api.html
- Parameters:
- Return type:
ObjectApiResponse[Any]
- put_policy(*, name, error_trace=None, filter_path=None, geo_match=None, human=None, match=None, pretty=None, range=None)
Creates a new enrich policy.
https://www.elastic.co/guide/en/elasticsearch/reference/8.11/put-enrich-policy-api.html
- Parameters:
name (str) – Name of the enrich policy to create or update.
geo_match (Mapping[str, Any] | None) – Matches enrich data to incoming documents based on a geo_shape query.
match (Mapping[str, Any] | None) – Matches enrich data to incoming documents based on a term query.
range (Mapping[str, Any] | None) – Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a term query.
error_trace (bool | None) –
human (bool | None) –
pretty (bool | None) –
- Return type:
ObjectApiResponse[Any]
- stats(*, error_trace=None, filter_path=None, human=None, pretty=None)
Gets enrich coordinator statistics and information about enrich policies that are currently executing.
https://www.elastic.co/guide/en/elasticsearch/reference/8.11/enrich-stats-api.html