NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

› ›

xpack.ml.closeJob

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

client.xpack.ml.closeJob({
  job_id: string,
  allow_no_jobs: boolean,
  force: boolean,
  timeout: string,
  body: object
})

`job_id` or `jobId`	`string` - The name of the job to close
`allow_no_jobs` or `allowNoJobs`	`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
`force`	`boolean` - True if the job should be forcefully closed
`timeout`	`string` - Controls the time to wait until a job has closed. Default to 30 minutes
`body`	`object` - The URL params optionally sent in the body