Python API: sam v8_1_5 sam.startProject()
|  |
This is the python interface to the command 'sam start project'.
Command Description:
Start the requested project. The project may, but need not, have been previously
reserved in the database.
The project is started asynchronously by the station. If you need to verify that
it is started and available before running any other commands you can use 'sam
ping project' to test if it is responding yet.
Python Usage:
from Sam import sam
result = sam.startProject(...)
Return value: SamStruct.BaseProjectInfo.BaseProjectInfo
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
datasetSpecification SamBoolean
definitionId long DB ID number of the dataset definition to be used to create the project file list
definitionName string name of the dataset definition to be used to create the project file list
detached SamBoolean tell station not to start project master
fileCut long maximum number of files to be delivered
group string working group under which this project should be run
project string name of the project
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)
snapshotId long DB ID number of an existing snapshot to be used as the project file list
snapshotName string name of an existing snapshot to be used as the project file list
snapshotVersion SnapshotVersion "new", "last", or an existing snapshot version taken with the specified dataset definition
(*) station string station where the project will run
t SamBoolean time-it mode (print additional info on timings)
v SamBoolean verbose mode
====================================================================================================================================
Python API-only Keywords:
'datasetSpecification': replaces (definitionName, definitionId, snapshotVersion, snapshotName, snapshotId)
Mutually exclusive keywords:
(definitionName || definitionId)
(snapshotName || snapshotId)
(snapshotName || snapshotVersion)
Incompatible keyword combinations:
(datasetSpecification) OR (definitionName, definitionId, snapshotVersion) OR (snapshotName, snapshotId)
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: