Query parameters

• allow_no_match boolean

  Specifies what to do when the request:

  1. Contains wildcard expressions and there are no transforms that match.
  2. Contains the _all string or no identifiers and there are no matches.
  3. Contains wildcard expressions and there are only partial matches.

  If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

• from number

  Skips the specified number of transforms.

• size number

  Specifies the maximum number of transforms to obtain.

• exclude_generated boolean

  Excludes fields that were automatically added when creating the transform. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • count number Required
  • transforms array[object] Required
    Hide transforms attributes Show transforms attributes object

    • authorization object
      Hide authorization attributes Show authorization attributes object

      • api_key object
        Hide api_key attributes Show api_key attributes object

        • id string Required

          The identifier for the API key.

        • name string Required

          The name of the API key.

      • roles array[string]

        If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response.

      • service_account string

        If a service account was used for the most recent update to the transform, the account name is listed in the response.

    • create_time number

      Time unit for milliseconds

    • description string

      Free text description of the transform.

    • dest object Required
      Hide dest attributes Show dest attributes object

      • index string Required
      • op_type string

        Values are index or create.

      • pipeline string

        The name of the pipeline to use.

      • routing string
      • version_type string

        Values are internal, external, external_gte, or force.

    • 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.

    • id string Required
    • 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

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

    • 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
        Hide group_by attributes Show group_by attributes object

        • Additional properties
        • date_histogram
        • geotile_grid
        • histogram
        • terms
    • 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.

    • settings object
      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

        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.

    • source object Required
      Hide source attributes Show source attributes object

      • index string | array[string] Required
      • query object
        Hide query attributes Show query attributes object

        • bool object
        • boosting object
        • common object Deprecated
        • combined_fields object
        • constant_score object
        • dis_max object
        • distance_feature
        • exists object
        • function_score object
        • fuzzy object

          Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.

        • geo_bounding_box object
        • geo_distance object
        • geo_polygon object
        • geo_shape object
        • has_child object
        • has_parent object
        • ids object
        • intervals object

          Returns documents based on the order and proximity of matching terms.

        • knn object
        • match object

          Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.

        • match_all object
        • match_bool_prefix object

          Analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

        • match_none object
        • match_phrase object

          Analyzes the text and creates a phrase query out of the analyzed text.

        • match_phrase_prefix object

          Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.

        • more_like_this object
        • multi_match object
        • nested object
        • parent_id object
        • percolate object
        • pinned
        • prefix object

          Returns documents that contain a specific prefix in a provided field.

        • query_string object
        • range object

          Returns documents that contain terms within a provided range.

        • rank_feature object
        • regexp object

          Returns documents that contain terms matching a regular expression.

        • rule object
        • script object
        • script_score object
        • semantic object
        • shape object
        • simple_query_string object
        • span_containing object
        • span_field_masking object
        • span_first object
        • span_multi object
        • span_near object
        • span_not object
        • span_or object
        • span_term object

          Matches spans containing a term.

        • span_within object
        • sparse_vector
        • term object

          Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.

        • terms object
        • terms_set object

          Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.

        • text_expansion object Deprecated

          Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.

        • weighted_tokens object Deprecated

          Supports returning text_expansion query results by sending in precomputed tokens with the query.

        • wildcard object

          Returns documents that contain terms matching a wildcard pattern.

        • wrapper object
        • type object
      • runtime_mappings object
        Hide runtime_mappings attributes Show runtime_mappings attributes object

        • Additional properties
        • fields
        • fetch_fields array[object]

          For type lookup

        • 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
        • type string Required

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

    • 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.

    • version string
    • _meta object
      Hide _meta attributes Show _meta attributes object

      • Additional properties
      • key object