Python API: samAdmin v8_1_5 samAdmin.addParamType()
|  |
This is the python interface to the command 'samadmin add param type'.
Command Description:
Register a new ParamType in the SAM db.
The corresponding dimension for querying this paramCategory/paramType
combination will be added automatically.
Example:
samadmin add paramType --paramCategory='global' --paramType='requestId' --dataType='long'
This will add a new paramCategory/paramType of 'global'/'requestId' to the database,
where the values must be convertible to type 'long'. It will also add the dimension
GLOBAL.REQUESTID to the database as a valid dimension for querying.
Python Usage:
from SamAdmin import samAdmin
result = samAdmin.addParamType(...)
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
connect string oracle username/password for connecting to this database
corbaCallTimeout int time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
d SamBoolean debug mode
(*) dataType DataType required dataType of values for this paramType
(*) paramCategory string paramCategory to which this paramType should be added
(*) paramType string name of the paramType to be added to the SAM DB
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)
t SamBoolean time-it mode (print additional info on timings)
v SamBoolean verbose mode
====================================================================================================================================
Environment Defaults:
c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
connect = os.environ['SAM_ORACLE_CONNECT']
corbaCallTimeout = os.environ['SAM_PYAPI_CORBA_CALL_TIMEOUT']
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']
See Also: