work_queue.Task Class Reference

Python Task object. More...

Public Member Functions
def	__init__
	Create a new task specification.
def	specify_algorithm
	Set the worker selection algorithm for task.
def	specify_tag
	Attach a user defined logical name to the task.
def	specify_preferred_host
	Indicate that the task would be optimally run on a given host.
def	specify_file
	Add a file to the task.
def	specify_input_file
	Add a input file to the task.
def	specify_output_file
	Add a output file to the task.
def	specify_buffer
	Add an input bufer to the task.
def	specify_file_command
	Add a file created or handled by an arbitrary command to a task (eg.

---

Detailed Description

Python Task object.

This class is used to create a task specification.

---

Constructor & Destructor Documentation

def work_queue.Task.__init__	(		self,
			command
	)

Create a new task specification.

Parameters:

self	Reference to the current task object.
command	The shell command line to be exected by the task.

References work_queue.Task._task, work_queue_task_create(), and work_queue_task_delete().

---

Member Function Documentation

def work_queue.Task.specify_algorithm	(		self,
			algorithm
	)

Set the worker selection algorithm for task.

Parameters:

self	Reference to the current task object.
algorithm	One of the following algorithms to use in assigning a task to a worker: WORK_QUEUE_SCHEDULE_FCFS WORK_QUEUE_SCHEDULE_FILES WORK_QUEUE_SCHEDULE_TIME WORK_QUEUE_SCHEDULE_RAND

References work_queue.Task._task, and work_queue_task_specify_algorithm().

def work_queue.Task.specify_tag	(		self,
			tag
	)

Attach a user defined logical name to the task.

Parameters:

self	Reference to the current task object.
tag	The tag to attach to task.

References work_queue.Task._task, and work_queue_task_specify_tag().

def work_queue.Task.specify_preferred_host	(		self,
			hostname
	)

Indicate that the task would be optimally run on a given host.

Parameters:

self	Reference to the current task object.
hostname	The hostname to which this task would optimally be sent.

References work_queue.Task._task.

def work_queue.Task.specify_file	(		self,
			local_name,
			remote_name = None,
			type = None,
			flags = None,
			cache = True
	)

Add a file to the task.

Parameters:

self	Reference to the current task object.
local_name	The name of the file on local disk or shared filesystem.
remote_name	The name of the file at the execution site.
type	Must be one of the following values: WORK_QUEUE_INPUT or WORK_QUEUE_OUTPUT
flags	May be zero to indicate no special handling, or any of the following or'd together: WORK_QUEUE_NOCACHE WORK_QUEUE_CACHE
cache	Legacy parameter for setting file caching attribute. By default this is enabled.

Example:

 # The following are equivalent
 >>> task.specify_file("/etc/hosts", type=WORK_QUEUE_INPUT, flags=WORK_QUEUE_NOCACHE)
 >>> task.specify_file("/etc/hosts", "hosts", type=WORK_QUEUE_INPUT, cache=false)

References work_queue.Task._task, and work_queue_task_specify_file().

Referenced by work_queue.Task.specify_input_file(), and work_queue.Task.specify_output_file().

def work_queue.Task.specify_input_file	(		self,
			local_name,
			remote_name = None,
			flags = None,
			cache = True
	)

Add a input file to the task.

This is just a wrapper for specify_file with type set to WORK_QUEUE_INPUT.

References work_queue.Task.specify_file().

def work_queue.Task.specify_output_file	(		self,
			local_name,
			remote_name = None,
			flags = None,
			cache = True
	)

Add a output file to the task.

This is just a wrapper for specify_file with type set to WORK_QUEUE_OUTPUT.

References work_queue.Task.specify_file().

def work_queue.Task.specify_buffer	(		self,
			buffer,
			remote_name,
			flags = None,
			cache = True
	)

Add an input bufer to the task.

Parameters:

self	Reference to the current task object.
buffer	The contents of the buffer to pass as input.
remote_name	The name of the remote file to create.
flags	May take the same values as specify_file.
cache	Legacy parameter for setting file caching attribute. By default this is enabled.

References work_queue.Task._task, and work_queue_task_specify_buffer().

def work_queue.Task.specify_file_command	(		self,
			remote_name,
			command,
			type,
			flags,
			cache = True
	)

Add a file created or handled by an arbitrary command to a task (eg.

wget, ftp, chirp_get|put).

Parameters:

self	Reference to the current task object.
remote_name	The name of the remote file at the execution site.
command	The contents of the buffer to pass as input.
type	Must be one of the following values: WORK_QUEUE_INPUT or WORK_QUEUE_OUTPUT
flags	May take the same values as specify_file.
cache	Legacy parameter for setting file caching attribute. By default this is enabled.

References work_queue.Task._task.

---

The documentation for this class was generated from the following file:

• work_queue.binding.py