rest-api-spec.api.ml.get_data_frame_analytics.json Maven / Gradle / Ivy

Go to download
{
  "ml.get_data_frame_analytics":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html",
      "description":"Retrieves configuration information for data frame analytics jobs."
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "application/json"]
    },
    "url":{
      "paths":[
        {
          "path":"/_ml/data_frame/analytics/{id}",
          "methods":[
            "GET"
          ],
          "parts":{
            "id":{
              "type":"string",
              "description":"The ID of the data frame analytics to fetch"
            }
          }
        },
        {
          "path":"/_ml/data_frame/analytics",
          "methods":[
            "GET"
          ]
        }
      ]
    },
    "params":{
      "allow_no_match":{
        "type":"boolean",
        "required":false,
        "description":"Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)",
        "default":true
      },
      "from":{
        "type":"int",
        "description":"skips a number of analytics",
        "default":0
      },
      "size":{
        "type":"int",
        "description":"specifies a max number of analytics to get",
        "default":100
      },
      "exclude_generated": {
        "required": false,
        "type": "boolean",
        "default": false,
        "description": "Omits fields that are illegal to set on data frame analytics PUT"
      }
    }
  }
}