File resource client
File resource client
Details
Base class that connects to a file using a FileResourceGetter.
Methods
Inherited methods
Method new()
Creates a new FileResourceClient instance.
Arguments
resource
A valid resource object.
file.getter
A FileResourceGetter object, optional. If not provided, it will be looked up in the FileResourceGetters registry. The operation will fail if none can be found.
Returns
A FileResourceClient object.
Method downloadFile()
Performs the file download, if it does not already exists locally.
Usage
FileResourceClient$downloadFile()
Returns
The local path to the downloaded file.
Removes the file if it was downloaded. A local file resource will remain untouched.
Usage
FileResourceClient$close()
Method clone()
The objects of this class are cloneable with this method.
Usage
FileResourceClient$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.