Body

• dest object
  Hide dest attributes Show dest attributes object

  • index string
  • pipeline string

    The unique identifier for an ingest pipeline.

• description string

  Free text description of the transform.

• frequency string

  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

• pivot object
  Hide pivot attributes Show pivot attributes object

  • aggregations object

    Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation, min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted average.

  • group_by object

    Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are currently supported: date histogram, geotile grid, histogram, terms.

    Hide group_by attribute Show group_by attribute object

    • * object Additional properties
      Hide * attributes Show * attributes object

      • date_histogram object
        Hide date_histogram attributes Show date_histogram attributes object

        • calendar_interval string

          Values are second, 1s, minute, 1m, hour, 1h, day, 1d, week, 1w, month, 1M, quarter, 1q, year, or 1y.

        • extended_bounds object
          Hide extended_bounds attributes Show extended_bounds attributes object

          • max
          • min
        • hard_bounds object
          Hide hard_bounds attributes Show hard_bounds attributes object

          • max
          • min
        • field string

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • fixed_interval string

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • format string

          The date format used to format key_as_string in the response. If no format is specified, the first date format specified in the field mapping is used.

        • interval string

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • min_doc_count number

          Only returns buckets that have min_doc_count number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned.

        • missing string
        • offset string

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • order object | array[object]

          One of:

          object-1 object array-2 array[object]
        • params object
          Hide params attribute Show params attribute object

          • * object Additional properties
        • script object
          Hide script attributes Show script attributes object

          • source
          • id string
          • params object

            Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          • lang
          • options object
        • time_zone string
        • keyed boolean

          Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array.

      • geotile_grid object
        Hide geotile_grid attributes Show geotile_grid attributes object

        • field string

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • precision number
        • shard_size number

          Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning max(10,(size x number-of-shards)) buckets from each shard.

        • size number

          The maximum number of buckets to return.

        • bounds object

          A geo bounding box. It can be represented in various ways:

          • as 4 top/bottom/left/right coordinates
          • as 2 top_left / bottom_right points
          • as 2 top_right / bottom_left points
          • as a WKT bounding box

          One of:

          CoordsGeoBounds object TopLeftBottomRightGeoBounds object TopRightBottomLeftGeoBounds object WktGeoBounds object
      • histogram object
        Hide histogram attributes Show histogram attributes object

        • extended_bounds object
          Hide extended_bounds attributes Show extended_bounds attributes object

          • max number

            Maximum value for the bound.

          • min number

            Minimum value for the bound.

        • hard_bounds object
          Hide hard_bounds attributes Show hard_bounds attributes object

          • max number

            Maximum value for the bound.

          • min number

            Minimum value for the bound.

        • field string

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • interval number

          The interval for the buckets. Must be a positive decimal.

        • min_doc_count number

          Only returns buckets that have min_doc_count number of documents. By default, the response will fill gaps in the histogram with empty buckets.

        • missing number

          The value to apply to documents that do not have a value. By default, documents without a value are ignored.

        • offset number

          By default, the bucket keys start with 0 and then continue in even spaced steps of interval. The bucket boundaries can be shifted by using the offset option.

        • order object | array[object]

          One of:

          object-1 object array-2 array[object]
        • script object
          Hide script attributes Show script attributes object

          • source
          • id string
          • params object

            Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          • lang
          • options object
        • format string
        • keyed boolean

          If true, returns buckets as a hash instead of an array, keyed by the bucket keys.

      • terms
• source object
  Hide source attributes Show source attributes object

  • index string | array[string] Required
  • runtime_mappings object
    Hide runtime_mappings attribute Show runtime_mappings attribute object

    • * object Additional properties
      Hide * attributes Show * attributes object

      • fields object

        For type composite

        Hide fields attribute Show fields attribute object

        • * object Additional properties
          Hide * attribute Show * attribute object

          • type string Required

            Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.

      • fetch_fields array[object]

        For type lookup

        Hide fetch_fields attributes Show fetch_fields attributes object

        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • format string
      • format string

        A custom format for date type runtime fields.

      • input_field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • target_field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • target_index string
      • script object
        Hide script attributes Show script attributes object

        • source string | object

          One of:

          string-1 string SearchRequestBody object

          Hide attributes Show attributes

          • aggregations object

            Defines the aggregations that are run as part of the search request.

          • collapse object
          • explain boolean

            If true, the request returns detailed information about score computation as part of a hit.

          • ext object

            Configuration of search extensions defined by Elasticsearch plugins.

          • from number

            The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

          • highlight
          • track_total_hits boolean | number

            Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.

          • indices_boost array[object]

            Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.

          • docvalue_fields array[object]

            An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.

          • knn
          • min_score number

            The minimum _score for matching documents. Documents with a lower _score are not included in search results or results collected by aggregations.

          • post_filter object

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          • profile boolean

            Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.

          • query object

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          • rescore
          • retriever object
          • script_fields object

            Retrieve a script evaluation (based on different fields) for each hit.

          • search_after array[number | string | boolean | null]

            A field value.

          • size number

            The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after property.

          • slice object
          • sort
          • _source
          • fields array[object]

            An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.

          • suggest object
          • terminate_after number

            The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.

            IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.

            If set to 0 (default), the query does not terminate early.

          • timeout string

            The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.

          • track_scores boolean

            If true, calculate and return document scores, even if the scores are not used for sorting.

          • version boolean

            If true, the request returns the document version as part of a hit.

          • seq_no_primary_term boolean

            If true, the request returns sequence number and primary term of the last modification of each hit.

          • stored_fields string | array[string]
          • pit object
          • runtime_mappings object
          • stats array[string]

            The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.

        • id string
        • params object

          Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          Hide params attribute Show params attribute object

          • * object Additional properties

        • lang string

          Any of:

          string-1 string string-2 string

          Values are painless, expression, mustache, or java.
        • options object
          Hide options attribute Show options attribute object

          • * string Additional properties
      • type string Required

        Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.

  • query object

    A query clause that retrieves a subset of data from the source index.

    Query DSL
• settings object

  The source of the data for the transform.

  Hide settings attributes Show settings attributes object

  • align_checkpoints boolean

    Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the transform config. As a result, less document updates in the destination index will be performed thus improving overall performance.

  • dates_as_epoch_millis boolean

    Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was the default for transforms created before version 7.11. For compatible output set this value to true.

  • deduce_mappings boolean

    Specifies whether the transform should deduce the destination index mappings from the transform configuration.

  • docs_per_second number

    Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a wait time between search requests. The default value is null, which disables throttling.

  • max_page_search_size number

    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 65,536.

  • unattended boolean Generally available

    If true, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails. Setting the number of retries other than infinite fails in validation.

• sync object
  Hide sync attribute Show sync attribute object

  • time object
    Hide time attributes Show time attributes object

    • delay string

      A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • field string Required

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

• retention_policy object
  Hide retention_policy attribute Show retention_policy attribute object

  • time object
    Hide time attributes Show time attributes object

    • field string Required

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • max_age string Required

      A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

• latest object
  Hide latest attributes Show latest attributes object

  • sort string Required

    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

  • unique_key array[string] Required

    Specifies an array of one or more fields that are used to group the data.