AlgorithmiaDataDirectory-class {algorithmia}

DataDirectory object to interact with directories. Supports Algorithmia data directories, S3, Dropbox and more coming soon! To create one, call: 'client$dir("directory_path")'

Description

DataDirectory object to interact with directories. Supports Algorithmia data directories, S3, Dropbox and more coming soon! To create one, call: 'client$dir("directory_path")'

Fields

client

Reference to the AlgorithmiaClient object that has the credentials necessary to make API calls.

dataDirectoryUrl

Convenience field that holds "/v1/data/" + dataDirectoryPath

dataDirectoryPath

The path of to the directory

Methods

create(acl = NULL)

Creates the directory with the ACL provided.

delete(force = FALSE)

Deletes the directory. If the directory is not empty, it will fail unless 'force' is set to TRUE.

dir(name)

Returns an AlgorithmiaDataDirectory object for the child directory.

dirs()

Returns an AlgorithmiaDirectoryIterator of all the child directories.

exists()

Returns TRUE if this directory exists. FALSE, if it does not.

file(name)

Returns an AlgorithmiaDataFile object for the child file.

files()

Returns an AlgorithmiaDirectoryIterator of all the child files.

getName()

Returns the name of the innermost directory.

getParent()

Returns the url for the parent directory (everything but the innermost directory).

getPermissions()

Returns the AlgorithmiaAcl object representing the permissions of the directory.

updatePermissions(acl)

Updates the permissions of the directory. Currently supported ACLs are: 'ReadAcl.PUBLIC', 'ReadAcl.PRIVATE', and 'ReadAcl.MY_ALGORITHMS'.