Preview a transform | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Query parameters

• Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

application/json

Body

• Hide dest attributes Show dest attributes object
  • The unique identifier for an ingest pipeline.
• Free text description of the transform.
• A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
• Hide pivot attributes Show pivot attributes 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.
  • 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
    * Hide date_histogram attributes Show date_histogram attributes object
    * Values are second, 1s, minute, 1m, hour, 1h, day, 1d, week, 1w, month, 1M, quarter, 1q, year, or 1y.
    * Hide extended_bounds attributes Show extended_bounds attributes object
    * max
    * min
    * Hide hard_bounds attributes Show hard_bounds attributes object
    * max
    * min
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * 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.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * 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.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * #### order object | array[object]
    * Hide params attribute Show params attribute object
    * *
    object Additional properties
    * Hide script attributes Show script attributes object
    * source
    * Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
    * lang
    * Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array.
    * Hide geotile_grid attributes Show geotile_grid attributes object
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * 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.
    * 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
    * Hide histogram attributes Show histogram attributes object
    * Hide extended_bounds attributes Show extended_bounds attributes object
    * Maximum value for the bound.
    * Minimum value for the bound.
    * Hide hard_bounds attributes Show hard_bounds attributes object
    * Maximum value for the bound.
    * Minimum value for the bound.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * The interval for the buckets. Must be a positive decimal.
    * Only returns buckets that have min_doc_count number of documents. By default, the response will fill gaps in the histogram with empty buckets.
    * The value to apply to documents that do not have a value. By default, documents without a value are ignored.
    * 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]
    * Hide script attributes Show script attributes object
    * source
    * Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
    * lang
    * If true, returns buckets as a hash instead of an array, keyed by the bucket keys.
    * terms
• Hide source attributes Show source attributes object
  • index
    string | array[string] Required
  • Hide runtime_mappings attribute Show runtime_mappings attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * For type composite
    Hide fields attribute Show fields attribute object
    * *
    object Additional properties
    Hide * attribute Show * attribute object
    * 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
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * A custom format for date type runtime fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide script attributes Show script attributes object
    * #### source string | 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
    Values are painless, expression, mustache, or java.
    * Hide options attribute Show options attribute object
    * *
    string Additional properties
    * Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.
  • A query clause that retrieves a subset of data from the source index.
    Query DSL
• 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.
  • Specifies whether the transform should deduce the destination index mappings from the transform configuration.
  • 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; Added in 8.5.0
    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.
• Hide sync attribute Show sync attribute object
  • Hide time attributes Show time attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
• Hide retention_policy attribute Show retention_policy attribute object
  • Hide time attributes Show time attributes object
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
• Hide latest attributes Show latest attributes object
  • 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.

Responses

• 200 application/json
  Hide response attributes Show response attributes object
  • generated_dest_index
    object Required
    Hide generated_dest_index attributes Show generated_dest_index attributes object
    * Hide aliases attribute Show aliases attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
    External documentation
    * If true, the alias is hidden. All indices for the alias must have the same is_hidden value.
    * If true, the index is the write index for the alias.
    * Hide mappings attributes Show mappings attributes object
    * Hide all_field attributes Show all_field attributes object
    * omit_norms
    boolean Required
    * search_analyzer
    string Required
    * similarity
    string Required
    * store_term_vector_offsets
    boolean Required
    * store_term_vector_payloads
    boolean Required
    * store_term_vector_positions
    boolean Required
    * store_term_vectors
    boolean Required
    * Values are strict, runtime, true, or false.
    * dynamic_date_formats
    array[string]
    * dynamic_templates
    array[object]
    * Hide _field_names attribute Show _field_names attribute object
    * Hide index_field attribute Show index_field attribute object
    * Hide _meta attribute Show _meta attribute object
    * *
    object Additional properties
    * numeric_detection
    boolean
    * Hide _routing attribute Show _routing attribute object
    * required
    boolean Required
    * Hide _size attribute Show _size attribute object
    * Hide _source attributes Show _source attributes object
    * compress_threshold
    string
    * Values are disabled, stored, or synthetic.
    * Hide runtime attribute Show runtime attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * For type composite
    Hide fields attribute Show fields attribute object
    * *
    object Additional properties
    * fetch_fields
    array[object]
    For type lookup
    * A custom format for date type runtime fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide script attributes Show script attributes object
    * source
    * Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
    * lang
    * Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.
    * Values are true or false.
    * _data_stream_timestamp
    object
    Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object
    * Index settings
    * Index settings
    * Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.
    Hide lifecycle attributes Show lifecycle attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide downsampling attribute Show downsampling attribute object
    * rounds
    array[object] Required
    The list of downsampling rounds to execute as part of this downsampling configuration
    Hide rounds attributes Show rounds attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.
  • preview
    array[object] Required