Projects | R Documentation |
R6 Class representing a Projects resource.
sevenbridges2::Resource
-> Projects
URL
List of URL endpoints for this resource.
new()
Create new Projects resource object.
Projects$new(...)
...
Other response arguments.
query()
A method to list all projects available to a particular
user. If the username is not provided, all projects available to the
currently authenticated user will be listed.
Otherwise, projects will be listed for the user whose username
is provided.
Please keep in mind that this way you will only be able to list
projects you are a member of.
More details on how to query projects, you can find in our
documentation.
Projects$query( name = NULL, owner = NULL, tags = NULL, limit = getOption("sevenbridges2")$limit, offset = getOption("sevenbridges2")$offset, ... )
name
Project's name.
owner
The username of the owner whose projects you want to query.
tags
A list of project tags used to filter the query results. Each tag should be provided as a string within the list, and tags may include spaces. For example, both "my_tag_1" and "tag with spaces" are valid tag values. The method will return only projects that have all the specified tags.
limit
The maximum number of collection items to return
for a single request. Minimum value is 1
.
The maximum value is 100
and the default value is 50
.
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
like other query parameters or 'fields', etc.
Collection
of Project
objects.
\dontrun{ projects_object <- Projects$new(auth = auth) # Query projects projects_object$query(name = name) }
get()
This call creates a Project object containing the details of a specified project.
Projects$get(id, ...)
id
Project ID. It consists of project owner's username or
if you are using Enterprise, then the Division name and project's
short name in form of
<owner_username>/<project-short-name>
or
<division-name>/<project-short-name>
.
...
Other arguments that can be passed to core api()
function
like 'fields', etc.
Project
object.
\dontrun{ projects_object <- Projects$new(auth = auth) # Get project by id projects_object$get(id = id) }
delete()
Method that allows you to delete a project from the
platform. It can only be successfully made if you have admin status for
the project.
Projects are specified by their IDs, which you can obtain
by using Projects$query()
to list projects or by getting a
single project using Projects$get()
.
Please be careful when using this method and note that calling it will
permanently delete the project from the platform.
Projects$delete(project, ...)
project
Project
object or project ID.
...
Other arguments that can be passed to core api()
function
as 'fields', etc.
\dontrun{ projects_object <- Projects$new(auth = auth) # Delete a project projects_object$delete(project = project) }
create()
A method for creating a new project.
Projects$create( name, billing_group = NULL, description = name, tags = NULL, locked = FALSE, controlled = FALSE, location = NULL, use_interruptible_instances = TRUE, use_memoization = FALSE, use_elastic_disk = FALSE, intermediate_files = list(retention = "LIMITED", duration = 24), ... )
name
The name of the project you are creating.
billing_group
The Billing object or ID of the billing group for the project.
description
Description of the project.
tags
The list of project tags.
locked
Set this field to TRUE
to lock down a project.
Locking down a project prevents any Seven Bridges team member from
viewing any information about the task.
controlled
Set this field to TRUE
to define this project as
controlled i.e. one which will contain controlled data. Set FALSE
to
define the project as open i.e. one which will contain open data.
location
Specify the location for this project:
aws:us-east-1
or aws:us-west-2
.
use_interruptible_instances
Defines the use of spot instances.
use_memoization
Set to FALSE
by default. Set to TRUE
to
enable
memoization.
use_elastic_disk
Set to TRUE
to enable
Elastic disk.
intermediate_files
A list defining the retention period for intermediate files. Expected elements:
retention
- Specifies that intermediate files should be
retained for a limited amount of time.
The value is always LIMITED
.
duration
- Specifies intermediate files retention period in
hours. The minimum value is 1
. The maximum value is 120
and the
default value is 24
.
...
Other arguments that can be passed to core api()
function
like 'fields', etc.
Project
object.
\dontrun{ projects_object <- Projects$new(auth = auth) # Create a project projects_object$create( name = name, billing_group = billing_group, description = description ) }
clone()
The objects of this class are cloneable with this method.
Projects$clone(deep = FALSE)
deep
Whether to make a deep clone.
## ------------------------------------------------
## Method `Projects$query`
## ------------------------------------------------
## Not run:
projects_object <- Projects$new(auth = auth)
# Query projects
projects_object$query(name = name)
## End(Not run)
## ------------------------------------------------
## Method `Projects$get`
## ------------------------------------------------
## Not run:
projects_object <- Projects$new(auth = auth)
# Get project by id
projects_object$get(id = id)
## End(Not run)
## ------------------------------------------------
## Method `Projects$delete`
## ------------------------------------------------
## Not run:
projects_object <- Projects$new(auth = auth)
# Delete a project
projects_object$delete(project = project)
## End(Not run)
## ------------------------------------------------
## Method `Projects$create`
## ------------------------------------------------
## Not run:
projects_object <- Projects$new(auth = auth)
# Create a project
projects_object$create(
name = name,
billing_group = billing_group,
description = description
)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.