Python API: sam v8_1_5 sam.dhGetLite()
|  |
This is the python interface to the command 'sam dh get lite'.
Command Description:
NOTE: this command is not yet implemented for the v6 suite of tools.
It should not be used until this disclaimer is removed from the
help text!
Dh Get Lite: copies the files of a dataset first on the cache of
your SAM station and then to the directory the sam command is
invoked.
Used e.g. by the JIM software
Python Usage:
from Sam import sam
result = sam.dhGetLite(...)
Return value: cpid (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
corbaCallTimeout int time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
d SamBoolean debug mode
definitionName string Name of the dataset
fileList string
group string group under which the project should be run
nodeName string node where station should deliver files
numFiles int Number of files to be pulled (default is to pull all files)
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 int Snapshot Id of the dataset
(*) station string station where this consumer process is running
t SamBoolean time-it mode (print additional info on timings)
timeout int timeout value in seconds, xxx
v SamBoolean verbose mode
====================================================================================================================================
Must have at least one of:
(snapshotId, definitionName, fileList)
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']
station = os.environ['SAM_STATION']
See Also: