Python API: sam v8_1_5 sam.releaseFile()
|  |
This is the python interface to the command 'sam release file'.
Command Description:
Release a file after processing it. You must release a file
before you try to get another file. The file name can be a
path, in which case it will be reduced to just the final component.
If the status is set to "ok", the file will be marked as
consumed. Any other status will mark the file with an unknown
status (which is not "consumed").
Once the file is released, you should assume that it is
no longer available; the file does not necessarily remain in the
station cache beyond the time when a consumer process is
finished with it.
Python Usage:
from Sam import sam
result = sam.releaseFile(...)
Return value: (none)
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
(*) fileName string file to be released (this can be a path)
(*) processId long consumer process id which processed the file
(*) project string name of the project under which the 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 into which to write results (default: stdout)
s SamBoolean retrySilently mode (do not issue messages to stderr on proxy retries)
(*) station string name of the station where the consumer process is running
(*) status string status to be associated with the release of the file
t SamBoolean time-it mode (print additional info on timings)
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: