Python API: sam v8_1_5 sam.establishDefaultProcess()
|  |
This is the python interface to the command 'sam establish default process'.
Command Description:
Register previously reserved consumer process with the project master to enable delivery and
tracking of files for the analysis.
If no routing file (rtfile) is specified, the consumer process ID will be written to stdout.
The consumer ID must have already been established via 'establish consumer'.
Python Usage:
from Sam import sam
result = sam.establishDefaultProcess(...)
Return value: processId (int)
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
------------------------------------------------------------------------------------------------------------------------------------
c SamBoolean automatically close all servants after each method call
(*) consumerId long Consumer process Id to register with project master
corbaCallTimeout int time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
d SamBoolean debug mode
(*) project string project against which this consumer process is running
retryInterval int retry interval base in seconds; will multiply this base times retryCount (default: 5)
retryJitter int retry jitter, random jitter added to base retry interval times retryCount (default: 5)
retryMaxCount int number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
rtfile string routing file, in which to write results
s SamBoolean retrySilently mode (do not issue messages to stderr on proxy retries)
(*) station string station where this consumer process is running
t SamBoolean time-it mode (print additional info on timings)
userProcessId string User defined Id that can be used to track this process in the DB
v SamBoolean verbose mode
====================================================================================================================================
Environment Defaults:
c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
corbaCallTimeout = os.environ['SAM_PYAPI_CORBA_CALL_TIMEOUT']
project = os.environ['SAM_PROJECT']
retryInterval = os.environ['SAM_PYAPI_RETRY_INTERVAL']
retryJitter = os.environ['SAM_PYAPI_RETRY_JITTER']
retryMaxCount = os.environ['SAM_PYAPI_RETRY_MAX_COUNT']
s = os.environ['SAM_PYAPI_RETRY_SILENTLY']
station = os.environ['SAM_STATION']
See Also: