Command Usage: sam v8_1_5 sam end file processing
|  |
Command Description:
Request end of file processing for a given consumer process (C++ API).
Once this request is accepted, no more input files will be delivered to user
application, but the consumer process listener will remain active until
the user application exits. This command can be executed by an authorized
account only.
The consumer process can be identified by either its ID, or by its
description. Unless the description is unique (for example, a batch job id)
it could potentially match more than one process within the project.
Usage:
sam end file processing <--requiredOptions> [--options] [-flags]
Where:
--requiredOptions:
--project=<value> # name of the project this consumer process is running under
--station=<value> # station where the project is running
--options:
--allConsumerProcesses # End processing on all processes for the project
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--processDescription=<value> # Consumer process description
--processId=<value> # ID of the consumer process which should end file processing
--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)
-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:
--all # synonym for --allConsumerProcesses
--cpid=<value> # synonym for --processId=<value>
Must specify at least one of:
--processId=<value> OR --processDescription=<value> OR --allConsumerProcesses
Mutually Exclusive Options:
--processId=<value> OR --processDescription=<value> OR --allConsumerProcesses
Required Data Types:
corbaCallTimeout : int
processDescription : string
processId : long
project : string
retryInterval : int
retryJitter : int
retryMaxCount : int
station : 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: