cloudmesh-storage.cloudmesh.storage.provider.box.Provider

Module Contents

Classes

Provider

Functions

get_id(source, results, source_type)

change_path(source)

update_dict(elements)

cloudmesh-storage.cloudmesh.storage.provider.box.Provider.get_id(source, results, source_type)
cloudmesh-storage.cloudmesh.storage.provider.box.Provider.change_path(source)
cloudmesh-storage.cloudmesh.storage.provider.box.Provider.update_dict(elements)
class cloudmesh-storage.cloudmesh.storage.provider.box.Provider.Provider(service=None)

Bases: cloudmesh.abstract.StorageABC.StorageABC

kind = box
sample
output
put(self, source=None, destination=None, recursive=False)

uploads file to Box, if source is directory and recursive is true uploads all files in source directory

Parameters

  • source – local file or directory to be uploaded

  • destination – cloud directory to upload to

  • recursive – if true upload all files in source directory, source must be directory not file

Returns

file dict(s) that have been uploaded

get(self, source=None, destination=None, recursive=False)

downloads file from Box, if recursive is true and source is directory downloads all files in directory

Parameters

  • source – cloud file or directory to download

  • destination – local directory to be downloaded into

  • recursive – if true download all files in source directory, source must be directory

Returns

file dict(s) that have been downloaded

search(self, directory=None, filename=None, recursive=False)

searches directory for file, if recursive searches all subdirectories

Parameters

  • directory – cloud directory to search in

  • filename – name of file to search for

  • recursive – if true search all child directories of original directory

Returns

file dict(s) matching filename in specified directory

create_dir(self, directory=None)

creates a new directory

Parameters

directory – path for new directory

Returns

dict of new directory

list(self, source=None, recursive=False)

lists all contents of directory, if recursive lists contents of subdirectories as well

Parameters

  • source – cloud directory to list all contents of

  • recursive – if true list contents of all child directories

Returns

dict(s) of files and directories

delete(self, source=None, recursive=False)

deletes file or directory

Parameters

  • source – file or directory to be deleted

  • recursive – copy the directory recurseively

Returns

None