Python API: sam v8_1_5 sam.deleteConsumptionNode()
|  |
This is the python interface to the command 'sam delete consumption node'.
Command Description:
Seize a consumption on a node that SAM used to deliver files to a consumer process Id,
sam_idl/sam_station/GPM2Consumer.establishProcess interface of the project
master.
A 'consumer process' is the process where your actual work is performed.
It is one of N processes collected under one consumer (established with a
prior "establish consumer" call), which all run the same application.
If no nodename is specified, sam_common_pylib/SamUtility/SamHostName/getSamHostName()
is used to determine the node upon which the process is running.
Python Usage:
from Sam import sam
result = sam.deleteConsumptionNode(...)
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
------------------------------------------------------------------------------------------------------------------------------------
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
nodeName string node on which the consumer process is running
(*) processId long consumer ID returned by a previous call to "establish consumer process"
(*) project string project under which this consumer process will be 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 to write results (default: stdout)
s SamBoolean retrySilently mode (do not issue messages to stderr on proxy retries)
(*) station string station where this 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: