Enrich Policies

class elasticsearch_serverless.client.EnrichClient(client: BaseClient)
delete_policy(*, name: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, master_timeout: str | ~typing.Literal[-1] | ~typing.Literal[0] | None = None, pretty: bool | None = None) → ObjectApiResponse[Any]

Delete an enrich policy. Deletes an existing enrich policy and its enrich index.

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

Parameters:

  • name – Enrich policy to delete.

  • master_timeout – Period to wait for a connection to the master node.

execute_policy(*, name: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, master_timeout: str | ~typing.Literal[-1] | ~typing.Literal[0] | None = None, pretty: bool | None = None, wait_for_completion: bool | None = None) → ObjectApiResponse[Any]

Run an enrich policy. Create the enrich index for an existing enrich policy.

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

Parameters:

  • name – Enrich policy to execute.

  • master_timeout – Period to wait for a connection to the master node.

  • wait_for_completion – If true, the request blocks other enrich policy execution requests until complete.

get_policy(*, name: str | Sequence[str] | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, master_timeout: str | ~typing.Literal[-1] | ~typing.Literal[0] | None = None, pretty: bool | None = None) → ObjectApiResponse[Any]

Get an enrich policy. Returns information about an enrich policy.

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

Parameters:

  • name – Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter.

  • master_timeout – Period to wait for a connection to the master node.

put_policy(*, name: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, geo_match: Mapping[str, Any] | None = None, human: bool | None = None, master_timeout: str | ~typing.Literal[-1] | ~typing.Literal[0] | None = None, match: Mapping[str, Any] | None = None, pretty: bool | None = None, range: Mapping[str, Any] | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Create an enrich policy. Creates an enrich policy.

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

Parameters:

  • name – Name of the enrich policy to create or update.

  • geo_match – Matches enrich data to incoming documents based on a geo_shape query.

  • master_timeout – Period to wait for a connection to the master node.

  • match – Matches enrich data to incoming documents based on a term query.

  • range – Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a term query.