github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-29 01:44:36 -04:00
Code Issues Projects Releases Packages Wiki Activity

Adds retention policy to HLRC put transform API (#68768) (#69146)

Browse source 
Co-authored-by: Hendrik Muhs <hendrik.muhs@elastic.co>
This commit is contained in:
Lisa Cawley 2021-02-17 13:23:26 -08:00 • committed by GitHub
parent f419ad8389
commit 593de53698
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 60 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/java-rest/high-level/transform/put_transform.asciidoc
View file

@ -39,9 +39,12 @@ include-tagged::{doc-tests-file}[{api}-config]
<1> The {transform} ID
<2> The source indices and query from which to gather data
<3> The destination index and optional pipeline
<4> How often to check for updates to the source indices
<4> Optional, indicates how often to check for updates to the source indices
<5> The PivotConfig
<6> Optional free text description of the {transform}
<7> Optional {transform} settings
<8> Optional retention policy for the data in the destination index
<9> Details required only when the {transform} runs continuously
[id="{upid}-{api}-query-config"]
@ -112,6 +115,18 @@ include-tagged::{doc-tests-file}[{api}-agg-config]
--------------------------------------------------
<1> Aggregate the average star rating
===== RetentionPolicyConfig
Defines a retention policy for the {transform}. Data that meets the defined
criteria is deleted from the destination index.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-retention-policy-config]
--------------------------------------------------
<1> The date field that is used to calculate the age of the document.
<2> Specifies the maximum age of a document in the destination index.
===== SettingsConfig
Defines settings.
@ -124,6 +139,18 @@ include-tagged::{doc-tests-file}[{api}-settings-config]
from the source. The size dynamically adjusts as the {transform}
is running to recover from and prevent OOM issues.
===== SyncConfig
Defines the properties {transforms} require to run continuously.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-sync-config]
--------------------------------------------------
<1> The date field that is used to identify new documents in the source.
<2> The time delay between the current time and the latest input data time.
include::../execution.asciidoc[]
[id="{upid}-{api}-response"]

1
docs/java-rest/high-level/transform/update_transform.asciidoc
View file

@ -42,6 +42,7 @@ include-tagged::{doc-tests-file}[{api}-config]
<3> How often to check for updates to the source indices.
<4> How to keep the {transform} in sync with incoming data.
<5> Optional free text description of the {transform}.
<6> Optional retention policy for the data in the destination index
include::../execution.asciidoc[]