Python API: sam v8_1_5
sam.dhGet()

Just having some fun...
This is the python interface to the command 'sam get dataset'.
Command Description:

NOTE: copies the files of a dataset first on the cache of
your SAM station and then to the directory specified in "destination" or 
where  the sam command is invoked. In contrast to the dh get lite command, 
this command creates a SAM project and consumer to get the files.
The tool can be run in a "dry" mode where no actual staging is parformed. 
To achieve that downloadPlugin option may be set to "echo". 
The command is recoverable via "sam generate strict recovery project"


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

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
------------------------------------------------------------------------------------------------------------------------------------
    appName                    string               
    appVersion                 string               
    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
    destination                string               Target location for incoming files
    downloadPlugin             string               Override default transfer machanism (samcp) with user specified command.
    filelist                   string               comma separated list of files
    group                      string               Use SAM Work group to run get dataset project against
    nodeName                   string               Override default (sam_download) node name that tool uses to receive files from SAM station
    project                    string               Override random project name generated by the command, usefull when generate strict recovery project is thought to be used
    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               
    t                          SamBoolean           time-it mode (print additional info on timings)
    timeout                    int                  timeout value in seconds
    v                          SamBoolean           verbose mode
====================================================================================================================================

Python API-only Keywords:
	'datasetSpecification': replaces (definitionName, definitionId, snapshotVersion, snapshotName, snapshotId)

Must have at least one of:	
	(datasetSpecification, filelist, 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']
	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: