Enrich 策略

class elasticsearch.client.EnrichClient

To use this client, access client.enrich from an Elasticsearch client. For example:

from elasticsearch import Elasticsearch

# Create the client instance
client = Elasticsearch(...)
# Use the enrich client
client.enrich.<method>(...)

delete_policy(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None)

删除一个富化策略。删除现有的富化策略及其富化索引。

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-delete-policy

Parameters:

name (str) – 要删除的富化策略名称。
master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待连接主节点的超时时间。
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, master_timeout=None, pretty=None, wait_for_completion=None)

执行一个富化策略。为现有的富化策略创建富化索引。

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-execute-policy

Parameters:

name (str) – 要执行的富化策略名称。
master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待连接主节点的超时时间。
wait_for_completion (bool | None) – 如果为`true`，该请求会阻塞其他富化策略执行请求直到完成。
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, master_timeout=None, pretty=None)

获取富化策略信息。返回关于富化策略的信息。

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-get-policy

Parameters:

name (str | Sequence[str] | None) – 用于限制请求的富化策略名称逗号分隔列表。要返回所有富化策略的信息，请省略此参数。
master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待连接主节点的超时时间。
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, master_timeout=None, match=None, pretty=None, range=None, body=None)

创建富化策略。创建一个富化策略。

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-put-policy

Parameters:

name (str) – 要创建或更新的富化策略名称。
geo_match (Mapping[str, Any] | None) – 基于`geo_shape`查询将富化数据与传入文档匹配。
master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待连接主节点的超时时间。
match (Mapping[str, Any] | None) – 基于`term`查询将富化数据与传入文档匹配。
range (Mapping[str, Any] | None) – 基于`term`查询将传入文档中的数字、日期或IP地址与富化索引中的范围匹配。
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, master_timeout=None, pretty=None)

获取富化统计信息。返回富化协调器统计信息以及当前正在执行的富化策略的相关信息。

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-stats

Parameters:

master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待连接主节点的超时时间。
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)

Return type:

ObjectApiResponse[Any]