Python API: sam v8_1_5
sam.endProcess()

Just having some fun...
This is the python interface to the command 'sam end process'.
Command Description:

Tell the station that this consumer process has terminated and will be
requesting no more files, by calling the
sam_idl/sam_station/GPM2Consumer.endProcess interface of the project master.
Note that , separate "commit process" call needs to be issued to certify that all
files processed by this processId did produce the output.


Python Usage:
	from Sam import sam
	result = sam.endProcess(...)

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
(*) processId                  long                 the consumer process ID of the process being terminated
(*) project                    string               project under which this consumer 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 results are written (default: stdout)
    s                          SamBoolean           retrySilently mode (do not issue messages to stderr on proxy retries)
(*) station                    string               station where the project is running
    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: