Python API: sam v8_1_5 sam.convert_v5_metadata()
|  |
This is the python interface to the command 'sam convert v5 metadata'.
Command Description:
Given metadata in the v5 format, convert it to the v6 format.
If the --outputFile option is present, the file will contain all of
the required import statements, etc., such that this descriptionFile will be
valid and useable in subsequent commands. If no --outputFile is specified,
the import statements will NOT be printed to the screen.
Python Usage:
from Sam import sam
result = sam.convert_v5_metadata(...)
Return value: SamFile.SamDataFile.SamDataFile
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
descriptionFile string full path to a file containing the v5-format metadata
outputFile string file in which to write the results, complete with required import statements
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
>>> v5metadata SamBoolean
====================================================================================================================================
Python API-only Keywords:
'v5metadata': replaces descriptionFile
Environment Defaults:
c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
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: