elasticsearch/docs/reference/transform/apis/transformresource.asciidoc

[role="xpack"]
[testenv="basic"]
[[transform-resource]]
=== {transform-cap} resources

{transform-cap} resources relate to the <<transform-apis>>.

For more information, see <<transforms>>.

[discrete]
[[transform-properties]]
==== {api-definitions-title}

`description`::
  (string) A description of the {transform}.

`dest`::
  (object) The destination for the {transform}. See
  <<transform-dest>>.
  
`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 `1s` and the maximum is `1h`. The
  default value is `1m`.

`id`::
  (string) A unique identifier for the {transform}.

`pivot`::
  (object) The method for transforming the data. See
  <<transform-pivot>>. 

`source`:: 
  (object) The source of the data for the {transform}. See
  <<transform-source>>.

[[transform-dest]]
==== Dest objects

{transform-cap} resources contain `dest` objects. For example, when
you create a {transform}, you must define its destination.

[discrete]
[[transform-dest-properties]]
===== {api-definitions-title}

`index`:: 
  (string) The _destination index_ for the {transform}.

`pipeline`::
  (string) The unique identifier for a <<pipeline,pipeline>>.

[[transform-source]]
==== Source objects

{transform-cap} resources contain `source` objects. For example, when
you create a {transform}, you must define its source.

[discrete]
[[transform-source-properties]]
===== {api-definitions-title}

`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>>.
  
[[transform-pivot]]
==== Pivot objects

{transform-cap} resources contain `pivot` objects, which define the
pivot function `group by` fields and the aggregation to reduce the data.

[discrete]
[[transform-pivot-properties]]
===== {api-definitions-title}

`aggregations` or `aggs`::
  (object) Defines how to aggregate the grouped data. The following composite
  aggregations are supported:
+
--
* {ref}/search-aggregations-metrics-avg-aggregation.html[Average]
* {ref}/search-aggregations-metrics-weight-avg-aggregation.html[Weighted Average]
* {ref}/search-aggregations-metrics-cardinality-aggregation.html[Cardinality]
* {ref}/search-aggregations-metrics-geobounds-aggregation.html[Geo Bounds]
* {ref}/search-aggregations-metrics-geocentroid-aggregation.html[Geo Centroid]
* {ref}/search-aggregations-metrics-max-aggregation.html[Max]
* {ref}/search-aggregations-metrics-min-aggregation.html[Min]
* {ref}/search-aggregations-metrics-scripted-metric-aggregation.html[Scripted Metric]
* {ref}/search-aggregations-metrics-sum-aggregation.html[Sum]
* {ref}/search-aggregations-metrics-valuecount-aggregation.html[Value Count]
* {ref}/search-aggregations-pipeline-bucket-script-aggregation.html[Bucket Script]
* {ref}/search-aggregations-pipeline-bucket-selector-aggregation.html[Bucket Selector]

IMPORTANT: {transforms-cap} support a subset of the functionality in
composite aggregations. See <<transform-limitations>>.

--

`group_by`::
  (object) Defines how to group the data. More than one grouping can be defined
  per pivot. The following groupings are supported:
+
--
* {ref}/search-aggregations-bucket-composite-aggregation.html#_terms[Terms]
* {ref}/search-aggregations-bucket-composite-aggregation.html#_histogram[Histogram]
* {ref}/search-aggregations-bucket-composite-aggregation.html#_date_histogram[Date Histogram]
--

`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 `10` and the
  maximum is `10,000`. The default value is `500`.

[[transform-example]]
==== {api-examples-title}

See the
<<put-transform-example,create {transforms} API examples>>.