Python API: samgridBatchAdmin v8_1_5 samgridBatchAdmin.addConsumerQueue()
|  |
This is the python interface to the command 'samgridBatchAdmin add consumer queue'.
Command Description:
Add a consumer queue to a given batch adapter in the station
configuration. Consumer queue should be used in cases where
project is started interactively, and consumer jobs are submitted
to the batch system.
For a full description of available queue types and their usages
please see the SAM Batch Adapter documentation.
Python Usage:
from SamgridBatchAdmin import samgridBatchAdmin
result = samgridBatchAdmin.addConsumerQueue(...)
Return value:
Arguments are passed as keyword-value pairs, as in:
myfunc(arg1='myarg', arg2='anotherarg', d=1)
Argument Keyword Description:
(*) indicates that this keyword is required
>>> indicates that either the API object or the CLI equivalent (<<<) is required
====================================================================================================================================
KEYWORD DATA TYPE DESCRIPTION
------------------------------------------------------------------------------------------------------------------------------------
(*) adapter string batch adapter name
d SamBoolean debug flag
description string description string
(*) queue string batch queue name
(*) station string station name
v SamBoolean verbose flag
====================================================================================================================================
Environment Defaults:
station = os.environ['SAM_STATION']
See Also: