Arrive function that calls the super.
Check if the _path for the backing folder is created. If not, optionally create it.
Function that creates and arrives new jobs. Can produce file or folder jobs.
Get a held job with a job id. Removes it from the held job queue, so you should move it out of the folder after using this.
var tunnel = af.createTunnel("Checkpoint example");
var webhook = af.createWebhookNest(["test", "example"], "get");
var holding_folder = af.createAutoFolderNest(["test", "checkpoint"]);
var im = webhook.getInterfaceManager();
// Watch for jobs, hold, and provide to the interface.
im.checkNest(holding_folder);
tunnel.watch(webhook);
tunnel.run(function(job, nest){
// Get the job_id from the webhook request
var job_id = job.getParameter("job_id");
// Get the held job from the holding folder
var checkpoint_job = holding_folder.getHeldJob(job_id);
// Move somewhere else
checkpoint_job.move(af.createAutoFolderNest(["test", "outfolder"]));
});
Loads jobs that have piled up in the nest if it was not watched. No longer used.
Array of jobs
Checks whether a _path starts with or contains a hidden file or a folder.
The _path of the file that needs to be validated.
returns {boolean} - true
if the source is blacklisted and otherwise false
.
Initial load of the contents of the directory.
Optional flag to hold jobs found.
Picks up a job from another nest.
Callback is given the job in its parameter.
Watches the folder.
Optional flag to hold jobs found.
Watches and holds jobs found.
Generated using TypeDoc
A folder nest is a nest which contains a backing folder at a specific _path. If the folder does not exist, antfarm can optionally create it.