Transform resourcesedit
Transform resources relate to the Transform APIs.
For more information, see Transforming data.
Propertiesedit
-
description - (string) A description of the transform.
-
dest - (object) The destination for the transform. See Dest objects.
-
frequency -
(time units) The interval between checks for changes in the source indices
when the transform is running continuously. Also determines the
retry interval in the event of transient failures while the transform is
searching or indexing. The minimum value is
1sand the maximum is1h. The default value is1m. -
id - (string) A unique identifier for the transform.
-
pivot - (object) The method for transforming the data. See Pivot objects.
-
source - (object) The source of the data for the transform. See Source objects.
Dest objectsedit
Transform resources contain dest objects. For example, when
you create a transform, you must define its destination.
Propertiesedit
-
index - (string) The destination index for the transform.
-
pipeline - (string) The unique identifier for a pipeline.
Source objectsedit
Transform resources contain source objects. For example, when
you create a transform, you must define its source.
Propertiesedit
-
index -
(string or array) The source indices for the transform. It can
be a single index, an index pattern (for example,
"myindex*"), or an array of indices (for example,["index1", "index2"]). -
query - (object) A query clause that retrieves a subset of data from the source index. See Query DSL.
Pivot objectsedit
Transform resources contain pivot objects, which define the
pivot function group by fields and the aggregation to reduce the data.
Propertiesedit
-
aggregationsoraggs -
(object) Defines how to aggregate the grouped data. The following composite aggregations are supported:
Transforms support a subset of the functionality in composite aggregations. See Limitations.
-
group_by -
(object) Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are supported:
-
max_page_search_size -
(integer) Defines the initial page size to use for the composite aggregation
for each checkpoint. If circuit breaker exceptions occur, the page size is
dynamically adjusted to a lower value. The minimum value is
10and the maximum is10,000. The default value is500.
Examplesedit
See the create transforms API examples.