Python API: sam v8_1_5
sam.endFileProcessing()

Just having some fun...
This is the python interface to the command '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.



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

Return value: 

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
------------------------------------------------------------------------------------------------------------------------------------
    allConsumerProcesses       SamBoolean           End processing on all processes for the project
    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
    processDescription         string               Consumer process description
    processId                  long                 ID of the consumer process which should end file processing
(*) project                    string               name of the project this consumer process is running under
    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)
    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
====================================================================================================================================

Must have at least one of:	
	(processId, processDescription, allConsumerProcesses) 

Mutually exclusive keywords:	
	(processId || processDescription || allConsumerProcesses) 

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: