Python API: sam v8_1_5 sam.createRequest()
|  |
This is the python interface to the command 'sam create request'.
Command Description:
Create a new request.
Python Usage:
from Sam import sam
result = sam.createRequest(...)
Return value: long
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
comments string comments for created request
corbaCallTimeout int time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
d SamBoolean debug mode
datasetSpecification SamBoolean
definitionId long DB ID number of the dataset definition to be used to create the project file list
definitionName string name of the dataset definition to be used to create the project file list
(*) group string work group associated with request
numberOfEvents long number of events to generate
paramFile string file containing request params
params Params python dictionary of request parameters
priority long priority associated with created request
(*) requestType string type of request to create
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)
s SamBoolean retrySilently mode (do not issue messages to stderr on proxy retries)
snapshotId long DB ID number of an existing snapshot to be used as the project file list
snapshotName string name of an existing snapshot to be used as the project file list
snapshotVersion SnapshotVersion "new", "last", or an existing snapshot version taken with the specified dataset definition
t SamBoolean time-it mode (print additional info on timings)
v SamBoolean verbose mode
====================================================================================================================================
Python API-only Keywords:
'datasetSpecification': replaces (definitionName, definitionId, snapshotVersion, snapshotName, snapshotId)
'params': replaces paramFile
Mutually exclusive keywords:
(definitionName || definitionId)
(params || paramFile)
(snapshotName || snapshotId)
(snapshotName || snapshotVersion)
Incompatible keyword combinations:
(datasetSpecification) OR (definitionName, definitionId, snapshotVersion) OR (snapshotName, snapshotId)
Environment Defaults:
c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
corbaCallTimeout = os.environ['SAM_PYAPI_CORBA_CALL_TIMEOUT']
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']
See Also: