Python API: sam v8_1_5
sam.uploadFile()

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

The "upload file" command can transfer files to any valid sam location.


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

Return value: SamStruct.FileTransferStatus.FileTransferStatus

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
    declareFile                SamBoolean           indicates that this is a new file which must first be declared to SAM
    descriptionFile            string               metadata description file, if the file must be declared
(*) destinationPath            string               destination location; must be a valid SAM location
    group                      string               group responsible for the file (if not contained in the metadata)
    metadata                   SamDataFile          SamDataFile object containing the metadata for the file if it needs to be declared
    minPnfsFileStoreSize       SamSize              reject requests to transfer files smaller than this into enstore
    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)
(*) sourceFile                 string               fully-specified path to the file
    t                          SamBoolean           time-it mode (print additional info on timings)
    v                          SamBoolean           verbose mode
====================================================================================================================================

Python API-only Keywords:
	'metadata': replaces descriptionFile

Mutually exclusive keywords:	
	(descriptionFile || metadata) 

Environment Defaults:
	c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
	corbaCallTimeout = os.environ['SAM_PYAPI_CORBA_CALL_TIMEOUT']
	minPnfsFileStoreSize = os.environ['SAM_MIN_PNFS_FILE_STORE_SIZE']
	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: