rest-api-spec.api.transform.stop_transform.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

Elasticsearch subproject :rest-api-spec

There is a newer version: 8.17.0

{
  "transform.stop_transform":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html",
      "description":"Stops one or more transforms."
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "application/json"]
    },
    "url":{
      "paths":[
        {
          "path":"/_transform/{transform_id}/_stop",
          "methods":[
            "POST"
          ],
          "parts":{
            "transform_id":{
              "type":"string",
              "description":"The id of the transform to stop"
            }
          }
        }
      ]
    },
    "params":{
      "force":{
        "type":"boolean",
        "required":false,
        "description":"Whether to force stop a failed transform or not. Default to false"
      },
      "wait_for_completion":{
        "type":"boolean",
        "required":false,
        "description":"Whether to wait for the transform to fully stop before returning or not. Default to false"
      },
      "timeout":{
        "type":"time",
        "required":false,
        "description":"Controls the time to wait until the transform has stopped. Default to 30 seconds"
      },
      "allow_no_match":{
        "type":"boolean",
        "required":false,
        "description":"Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"
      },
      "wait_for_checkpoint":{
        "type":"boolean",
        "required":false,
        "description":"Whether to wait for the transform to reach a checkpoint before stopping. Default to false"
      }
    }
  }
}