Command Usage: sam v8_1_5 sam get next file
|  |
Command Description:
Receive the next file to be analyzed. The full path to the file is returned.
If there are no more files to be processed, the string 'END OF STREAM' will be returned
to the caller. (This may be referenced by means of the constant
SAMStation.GPM2Consumer.end_of_stream).
Usage:
sam get next file <--requiredOptions> [--options] [-flags]
Where:
--requiredOptions:
--processId=<value> # Consumer process ID for the process receiving the file
--project=<value> # name of the project under which this process is running
--station=<value> # name of the station where the project is running
--options:
--minimalOutput # Write unadorned output (useful for scripting)
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--erralertflag=<value> # set to "verbose" for more information in output message
--pollinterval=<value> # number of seconds to wait before retrying getNextFile again
--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 results will be written
--timeout=<value> # number of seconds to wait before timing out
-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>
--minOutput # synonym for --minimalOutput
Required Data Types:
corbaCallTimeout : int
erralertflag : string
pollinterval : long
processId : long
project : string
retryInterval : int
retryJitter : int
retryMaxCount : int
rtfile : string
station : string
timeout : long
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: