Python API: sam v8_1_5 sam.modifyRequest()
|  |
This is the python interface to the command 'sam modify request'.
Command Description:
Modify an existing request.
Python Usage:
from Sam import sam
result = sam.modifyRequest(...)
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
------------------------------------------------------------------------------------------------------------------------------------
archive string modify the request archive status
c SamBoolean automatically close all servants after each method call
comments string modify the comments for the 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 string modify the reconstruction request dataset specification
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
delParams string parameters to delete associated with this request
group string modify the work group associated with the request
numberOfEvents long modify the number of events to generate
paramFile string file name containing parameters to modify request
params Params params object containing parameters to modify request
priority long modify the priority of the request
(*) requestId long
requestStatus string modify the status of the request
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 || delParams)
(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: