Files {sevenbridges2} | R Documentation |
R6 Class representing files endpoints.
Description
R6 Class representing Files resource.
Super class
sevenbridges2::Resource
-> Files
Public fields
URL
List of URL endpoints for this resource.
Methods
Public methods
Method new()
Create new Files resource object.
Usage
Files$new(...)
Arguments
...
Other response arguments.
Method query()
This call returns a list of files and subdirectories in a
specified project or directory within a project, with specified
properties that you can access. The project or directory whose contents
you want to list is specified as a query parameter in the call. Further
properties to filter by can also be specified as query parameters.
Note that this call lists both files and subdirectories in the
specified project or directory within a project, but not the contents
of the subdirectories.
To list the contents of a subdirectory, make a new call
and specify the subdirectory ID as the parent
parameter.
More information you can find in our
API documentation.
Usage
Files$query( project = NULL, parent = NULL, name = NULL, metadata = NULL, origin = NULL, tag = NULL, limit = getOption("sevenbridges2")$limit, offset = getOption("sevenbridges2")$offset, ... )
Arguments
project
Project identifier (ID) as string or a Project object. Project should not be used together with parent. If parent is used, the call will list the content of the specified folder, within the project to which the folder belongs. If project is used, the call will list the content at the root of the project's files.
parent
The parent folder identifier as string or a File object which must be of type
FOLDER
. Should not be used together with project. If parent is used, the call will list the content of the specified folder, within the project to which the folder belongs. If project is used, the call will list the content at the root of the project's files.name
Name of the file. List files with this name. Note that the name must be an exact complete string for the results to match. Multiple names can be represented as a vector.
metadata
List file with this metadata field values. List only files that have the specified value in metadata field. Different metadata fields are represented as a named list. You can also define multiple instances of the same metadata field.
origin
Task object. List only files produced by task.
tag
List files containing this tag. Note that the tag must be an exact complete string for the results to match. Multiple tags can be represented by vector of values.
limit
The maximum number of collection items to return for a single request. Minimum value is
1
. The maximum value is100
and the default value is50
. This is a pagination-specific attribute.offset
The zero-based starting index in the entire collection of the first item to return. The default value is
0
. This is a pagination-specific attribute....
Other arguments that can be passed to core
api()
function as 'fields', etc.
Returns
Collection
of File
objects.
Examples
\dontrun{ files_object <- Files$new(auth = auth) # Query files in a project files_object$query(project = project) }
Method get()
This call returns a single File object with its details. The call returns the file's name, its tags, and all of its metadata. Files are specified by their IDs, which you can obtain by making the API call to list all files in a project.
Usage
Files$get(id, ...)
Arguments
id
The file ID.
...
Other arguments that can be passed to core
api()
function as 'fields', etc.
Returns
File
object.
Examples
\dontrun{ files_object <- Files$new(auth = auth) # Get file using id files_object$get(id = id) }
Method delete()
This call removes a file from the Seven Bridges Platform.
Files are specified by their IDs, which you can obtain by using
Files$query()
to list files or by getting a single file
using Files$get()
.
Usage
Files$delete(file, ...)
Arguments
file
File
object or file ID....
Other arguments that can be passed to core
api()
function as 'fields', etc.
Examples
\dontrun{ files_object <- Files$new(auth = auth) # Delete a file files_object$delete(file = file) }
Method copy()
Copy file/files to the specified project. This call allows
you to copy files between projects. Unlike the call to copy a file
between projects, this call lets you batch the copy operation and copy
a list of files at a time.
More information you may find
here.
Usage
Files$copy(files, destination_project)
Arguments
files
The list of files' IDs or list of File object to copy.
destination_project
Project object or project ID. where you want to copy files into.
Examples
\dontrun{ files_object <- Files$new(auth = auth) # Copy files to a project files_object$copy( file = file, destination_project = project ) }
Method create_folder()
A method for creating a new folder. It allows you to create
a new folder on the Platform within the root folder of a specified
project or the provided parent folder. Remember that you should provide
either the destination project (as the project
parameter) or the
destination folder (as the parent
parameter), not both.
More information you may find
here.
Usage
Files$create_folder(name, parent = NULL, project = NULL)
Arguments
name
The name of the folder you are about to create.
parent
The ID of the parent destination folder or a File object which must be of type
FOLDER
.project
The ID of the destination project, or a Project object.
Examples
\dontrun{ files_object <- Files$new(auth = auth) # Create folder in a project files_object$create_folder( name = name, project = project ) }
Method clone()
The objects of this class are cloneable with this method.
Usage
Files$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.
Examples
## ------------------------------------------------
## Method `Files$query`
## ------------------------------------------------
## Not run:
files_object <- Files$new(auth = auth)
# Query files in a project
files_object$query(project = project)
## End(Not run)
## ------------------------------------------------
## Method `Files$get`
## ------------------------------------------------
## Not run:
files_object <- Files$new(auth = auth)
# Get file using id
files_object$get(id = id)
## End(Not run)
## ------------------------------------------------
## Method `Files$delete`
## ------------------------------------------------
## Not run:
files_object <- Files$new(auth = auth)
# Delete a file
files_object$delete(file = file)
## End(Not run)
## ------------------------------------------------
## Method `Files$copy`
## ------------------------------------------------
## Not run:
files_object <- Files$new(auth = auth)
# Copy files to a project
files_object$copy(
file = file,
destination_project = project
)
## End(Not run)
## ------------------------------------------------
## Method `Files$create_folder`
## ------------------------------------------------
## Not run:
files_object <- Files$new(auth = auth)
# Create folder in a project
files_object$create_folder(
name = name,
project = project
)
## End(Not run)