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.14/delete-enrich-policy-api.html
- Parameters:
name (str) – Enrich policy to delete.
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
- Return type:
ObjectApiResponse[Any]
- 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.14/execute-enrich-policy-api.html
- Parameters:
name (str) – Enrich policy to execute.
wait_for_completion (bool | None) – If true, the request blocks other enrich policy execution requests until complete.
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
- 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.14/get-enrich-policy-api.html
- Parameters:
name (str | Sequence[str] | None) – Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter.
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
- Return type:
ObjectApiResponse[Any]
- put_policy(*, name, error_trace=None, filter_path=None, geo_match=None, human=None, match=None, pretty=None, range=None, body=None)
Creates a new enrich policy.
https://www.elastic.co/guide/en/elasticsearch/reference/8.14/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)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | 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.14/enrich-stats-api.html
- Parameters:
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
- Return type:
ObjectApiResponse[Any]