Command Usage: sam v8_1_5 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.
Usage:
sam release file <--requiredOptions> [--options] [-flags]
Where:
--requiredOptions:
--fileName=<value> # file to be released (this can be a path)
--processId=<value> # consumer process id which processed the file
--project=<value> # name of the project under which the consumer process is running
--station=<value> # name of the station where the consumer process is running
--status=<value> # status to be associated with the release of the file
--options:
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--retryInterval=<value> # retry interval base in seconds; will multiply this base times retryCount (default: 5)
--retryJitter=<value> # retry jitter, random jitter added to base retry interval times retryCount (default: 5)
--retryMaxCount=<value> # number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
--rtfile=<value> # routing file into which to write results (default: stdout)
-flags:
-c # automatically close all servants after each method call
-d # debug mode
-s # retrySilently mode (do not issue messages to stderr on proxy retries)
-t # time-it mode (print additional info on timings)
-v # verbose mode
Synonymous Options:
--consumerProcessId=<value> # synonym for --processId=<value>
--cpid=<value> # synonym for --processId=<value>
--file=<value> # synonym for --fileName=<value>
--name=<value> # synonym for --fileName=<value>
Required Data Types:
corbaCallTimeout : int
fileName : string
processId : long
project : string
retryInterval : int
retryJitter : int
retryMaxCount : int
rtfile : string
station : string
status : string
You may omit "-c" if the $SAM_PYAPI_AUTO_CLOSE_SERVANTS environmental variable is set.
You may omit "--corbaCallTimeout=<value>" if the $SAM_PYAPI_CORBA_CALL_TIMEOUT environmental variable is set.
You may omit "--project=<value>" if the $SAM_PROJECT environmental variable is set.
You may omit "--retryInterval=<value>" if the $SAM_PYAPI_RETRY_INTERVAL environmental variable is set.
You may omit "--retryJitter=<value>" if the $SAM_PYAPI_RETRY_JITTER environmental variable is set.
You may omit "--retryMaxCount=<value>" if the $SAM_PYAPI_RETRY_MAX_COUNT environmental variable is set.
You may omit "-s" if the $SAM_PYAPI_RETRY_SILENTLY environmental variable is set.
You may omit "--station=<value>" if the $SAM_STATION environmental variable is set.
UNIX ExitStatus:
Success : 0
Unhandled exceptions : 127
See Also: