R6 Class representing an app

Description

R6 Class representing a resource for managing apps.

Super class

sevenbridges2::Item -> App

Public fields

Methods

Public methods

• App$new()

• App$print()

• App$reload()

• App$copy()

• App$get_revision()

• App$create_revision()

• App$sync()

• App$input_matrix()

• App$output_matrix()

• App$create_task()

• App$clone()

Method new()

Create a new App object.

Usage

App$new(res = NA, ...)

Arguments

Returns

A new App object.

Method print()

Print method for App class.

Usage

App$print()

Examples

\dontrun{
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 app_object$print()
}

Method reload()

Reload App object information. Suitable also for loading raw CWL in the 'raw' field, if it's not already populated.

Usage

App$reload(...)

Arguments

Returns

App object.

Examples

\dontrun{
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 app_object$reload()
}

Method copy()

A method that copies the current app to the specified project.

Usage

App$copy(project, name = NULL, strategy = "clone", use_revision = FALSE, ...)

Arguments

Returns

Copied App object.

Examples

\dontrun{
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 app_object$copy(project)
}

Method get_revision()

Get app's revision.

Usage

App$get_revision(revision = self$revision, in_place = FALSE, ...)

Arguments

Details

This call allows you to obtain a particular revision of an app, which is not necessarily the most recent version.

Returns

App object.

Examples

\dontrun{
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 app_object$get_revision()
}

Method create_revision()

Create a new app revision.

Usage

App$create_revision(
  raw = NULL,
  from_path = NULL,
  raw_format = c("JSON", "YAML"),
  in_place = FALSE,
  ...
)

Arguments

Details

This call creates a new revision for an existing app. It adds a new CWL app description, and stores it as the named revision for the specified app. The revision number must not already exist and should follow the sequence of previously created revisions.

More documentation about how to create the app via API can be found here.

Returns

App object.

Examples

\dontrun{
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 # Create App object using raw CWL
 app_object$create_revision(raw)
}

Method sync()

Synchronize a copied app with its parent app.

Usage

App$sync(...)

Arguments

Details

This call synchronizes a copied app with the source app from which it has been copied.

Returns

App object.

Examples

\dontrun{
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )

  app_object$sync()
}

Method input_matrix()

Get an input matrix for the app, listing expected inputs (required or optional) along with their types, descriptions, etc.

Usage

App$input_matrix()

Returns

Data frame.

Method output_matrix()

Get an output matrix for the app, listing expected outputs of tasks that run this app, along with their types, descriptions, etc.

Usage

App$output_matrix()

Returns

Data frame.

Method create_task()

This call creates a new task. You can create either a single task or a batch task by using the app's default batching, override batching, or disable batching completely. A parent task is a task that specifies criteria by which to batch its inputs into a series of further sub-tasks, called child tasks. The documentation on batching tasks for more details on batching criteria.

Usage

App$create_task(
  project,
  revision = NULL,
  name = NULL,
  description = NULL,
  execution_settings = NULL,
  inputs = NULL,
  output_location = NULL,
  batch = NULL,
  batch_input = NULL,
  batch_by = NULL,
  use_interruptible_instances = NULL,
  action = NULL,
  ...
)

Arguments

Returns

Task object.

Examples

\dontrun{
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 # Create a DRAFT task
 app_object$create_task(project = project)
}

Method clone()

The objects of this class are cloneable with this method.

Usage

App$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `App$print`
## ------------------------------------------------

## Not run: 
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 app_object$print()

## End(Not run)

## ------------------------------------------------
## Method `App$reload`
## ------------------------------------------------

## Not run: 
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 app_object$reload()

## End(Not run)

## ------------------------------------------------
## Method `App$copy`
## ------------------------------------------------

## Not run: 
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 app_object$copy(project)

## End(Not run)


## ------------------------------------------------
## Method `App$get_revision`
## ------------------------------------------------

## Not run: 
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 app_object$get_revision()

## End(Not run)


## ------------------------------------------------
## Method `App$create_revision`
## ------------------------------------------------

## Not run: 
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 # Create App object using raw CWL
 app_object$create_revision(raw)

## End(Not run)


## ------------------------------------------------
## Method `App$sync`
## ------------------------------------------------

## Not run: 
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )

  app_object$sync()

## End(Not run)


## ------------------------------------------------
## Method `App$create_task`
## ------------------------------------------------

## Not run: 
 # x is API response when app is requested
 app_object <- App$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 # Create a DRAFT task
 app_object$create_task(project = project)

## End(Not run)

R6 Class representing the apps endpoint

Description

R6 Class representing the apps resource endpoint.

Super class

sevenbridges2::Resource -> Apps

Public fields

Methods

Public methods

• Apps$new()

• Apps$query()

• Apps$get()

• Apps$copy()

• Apps$create()

• Apps$clone()

Method new()

Create a new Apps resource object.

Usage

Apps$new(...)

Arguments

Method query()

This call lists all the apps available to you.

Usage

Apps$query(
  project = NULL,
  visibility = c("private", "public"),
  query_terms = NULL,
  id = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  fields = "!raw",
  ...
)

Arguments

Returns

Collection containing App objects.

Examples

\dontrun{
 apps_object <- Apps$new(
   auth = auth
 )

 # List public apps
 apps_object$query(visibility = "public")
}

Method get()

This call returns information about the specified app. The app must be in a project you can access. It could be an app uploaded to the Seven Bridges Platform by a project member or a public app copied into the project.
You can find more details about this operation in our API documentation.

Usage

Apps$get(id, revision = NULL, ...)

Arguments

Returns

App object.

Examples

\dontrun{
 apps_object <- Apps$new(
   auth = auth
 )

 # Get app object
 apps_object$get(id = "<some_id>")
}

Method copy()

This call copies the specified app to the specified project. The app must be in a project you can access. It could be an app uploaded to the Seven Bridges Platform by a project member or a public app copied into the project.

Usage

Apps$copy(
  app,
  project,
  name = NULL,
  strategy = c("clone", "direct", "clone_direct", "transient"),
  ...
)

Arguments

Returns

Copied App object.

Examples

\dontrun{
 apps_object <- Apps$new(
   auth = auth
 )
 # Copy app object to a project
 apps_object$copy(app = app, project = project)
}

Method create()

This call allows you to add an app using raw CWL.

Usage

Apps$create(
  raw = NULL,
  from_path = NULL,
  project,
  name,
  raw_format = c("JSON", "YAML"),
  ...
)

Arguments

Returns

App object.

Examples

\dontrun{
 apps_object <- Apps$new(
   auth = auth
 )

 # Create new app object
 apps_object$create(
  raw = raw,
  project = project,
  name = name,
  raw_format = "YAML"
 )
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Apps$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Apps$query`
## ------------------------------------------------

## Not run: 
 apps_object <- Apps$new(
   auth = auth
 )

 # List public apps
 apps_object$query(visibility = "public")

## End(Not run)


## ------------------------------------------------
## Method `Apps$get`
## ------------------------------------------------

## Not run: 
 apps_object <- Apps$new(
   auth = auth
 )

 # Get app object
 apps_object$get(id = "<some_id>")

## End(Not run)


## ------------------------------------------------
## Method `Apps$copy`
## ------------------------------------------------

## Not run: 
 apps_object <- Apps$new(
   auth = auth
 )
 # Copy app object to a project
 apps_object$copy(app = app, project = project)

## End(Not run)


## ------------------------------------------------
## Method `Apps$create`
## ------------------------------------------------

## Not run: 
 apps_object <- Apps$new(
   auth = auth
 )

 # Create new app object
 apps_object$create(
  raw = raw,
  project = project,
  name = name,
  raw_format = "YAML"
 )

## End(Not run)

R6 Class representing an AsyncJob

Description

R6 Class representing a resource for managing asynchronous jobs.

Super class

sevenbridges2::Item -> AsyncJob

Public fields

Methods

Public methods

• AsyncJob$new()

• AsyncJob$print()

• AsyncJob$reload()

• AsyncJob$clone()

Method new()

Create a new AsyncJob object.

Usage

AsyncJob$new(res = NA, ...)

Arguments

Returns

A new AsyncJob object.

Method print()

Print method for AsyncJob class.

Usage

AsyncJob$print()

Examples

\dontrun{
 # x is API response when app is requested
 asyncjob_object <- AsyncJob$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 asyncjob_object$print()
}

Method reload()

Reloads AsyncJob object information.

Usage

AsyncJob$reload(...)

Arguments

Returns

AsyncJob object.

Examples

\dontrun{
 # x is API response when AsyncJob is requested
 asyncjob_object <- AsyncJob$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 asyncjob_object$reload()
}

Method clone()

The objects of this class are cloneable with this method.

Usage

AsyncJob$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `AsyncJob$print`
## ------------------------------------------------

## Not run: 
 # x is API response when app is requested
 asyncjob_object <- AsyncJob$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 asyncjob_object$print()

## End(Not run)

## ------------------------------------------------
## Method `AsyncJob$reload`
## ------------------------------------------------

## Not run: 
 # x is API response when AsyncJob is requested
 asyncjob_object <- AsyncJob$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 asyncjob_object$reload()

## End(Not run)

R6 Class Representing Authentication Object

Description

Authentication object with methods for accessing API endpoints. Every object could be requested from this Auth object and any action could start from this object using cascading style. Please check vignette("Authentication_and_Billing", package = "sevenbridges2") for more information.

Details

This is the main object for authentication to platforms powered by Seven Bridges.

Public fields

Methods

Public methods

• Auth$new()

• Auth$get_token()

• Auth$api()

• Auth$user()

• Auth$rate_limit()

• Auth$upload()

• Auth$list_ongoing_uploads()

• Auth$upload_abort()

• Auth$send_feedback()

• Auth$clone()

Method new()

Create a new Seven Bridges API Authentication object. All methods can be accessed through this object.

Usage

Auth$new(
  from = c("direct", "env", "file"),
  platform = NA,
  url = NA,
  token = NA,
  sysenv_url = NA,
  sysenv_token = NA,
  config_file = NA,
  profile_name = NA,
  fs = NA,
  authorization = FALSE
)

Arguments

Returns

Auth class object.

Examples

\dontrun{
 # Multiple ways to create Auth object

 # Using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Authenticate using environment variables
 a <- Auth$new(from = "env")

 # Authenticate using file configuration
 a <- Auth$new(from = "file")

}

Method get_token()

Returns the authentication token read from system environment variable.

Usage

Auth$get_token()

Returns

An API authentication token in form of a string.

Examples

\dontrun{
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Get that same token
 a$get_token()
}

Method api()

This method returns all API paths and pass arguments to core api() function.

Usage

Auth$api(
  ...,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  fields = "_all"
)

Arguments

Examples

\dontrun{
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Create API request using request parameters directly
 a$api(params)
}

Method user()

Get details about the authenticated user.

Usage

Auth$user(username = NULL)

Arguments

Returns

User class object.

Examples

\dontrun{
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Get information about the currently authenticated user
 a$user()
}

Method rate_limit()

Get information about current rate limit.

This call returns information about your current rate limit. This is the number of API calls you can make in one hour. This call also returns information about your current instance limit.

Usage

Auth$rate_limit()

Examples

\dontrun{
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Get current rate limit
 a$rate_limit()
}

Method upload()

This method allows you to upload a single file from your local computer to the Platform.

Usage

Auth$upload(
  path,
  project = NULL,
  parent = NULL,
  filename = NULL,
  overwrite = FALSE,
  part_size = getOption("sevenbridges2")$RECOMMENDED_PART_SIZE,
  init = FALSE
)

Arguments

Examples

\dontrun{
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Create upload job and set destination project
 upload_job <- a$upload(
   path = "/path/to/your/file.txt",
   project = destination_project,
   overwrite = TRUE,
   init = TRUE
 )
}

Method list_ongoing_uploads()

This method returns the list of all ongoing uploads.

Usage

Auth$list_ongoing_uploads()

Examples

\dontrun{
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # List ongoing uploads
 a$list_ongoing_uploads()
}

Method upload_abort()

This call aborts an ongoing multipart upload.

Usage

Auth$upload_abort(upload_id)

Arguments

Examples

\dontrun{
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Abort upload
 a$abort_upload(upload_id = "<id_of_the_upload_process>")
}

Method send_feedback()

Send feedback to Seven Bridges.

Send feedback on ideas, thoughts, and problems via the sevenbridges2 API package with three available types: idea, thought, and problem. You can send one feedback item per minute.

Usage

Auth$send_feedback(
  text,
  type = c("idea", "thought", "problem"),
  referrer = NULL
)

Arguments

Examples

\dontrun{
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Send feedback
 a$send_feedback(
  "This is a test for sending feedback via API.",
  type = "thought"
 )
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Auth$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Auth$new`
## ------------------------------------------------

## Not run: 
 # Multiple ways to create Auth object

 # Using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Authenticate using environment variables
 a <- Auth$new(from = "env")

 # Authenticate using file configuration
 a <- Auth$new(from = "file")


## End(Not run)

## ------------------------------------------------
## Method `Auth$get_token`
## ------------------------------------------------

## Not run: 
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Get that same token
 a$get_token()

## End(Not run)


## ------------------------------------------------
## Method `Auth$api`
## ------------------------------------------------

## Not run: 
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Create API request using request parameters directly
 a$api(params)

## End(Not run)


## ------------------------------------------------
## Method `Auth$user`
## ------------------------------------------------

## Not run: 
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Get information about the currently authenticated user
 a$user()

## End(Not run)

## ------------------------------------------------
## Method `Auth$rate_limit`
## ------------------------------------------------

## Not run: 
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Get current rate limit
 a$rate_limit()

## End(Not run)


## ------------------------------------------------
## Method `Auth$upload`
## ------------------------------------------------

## Not run: 
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Create upload job and set destination project
 upload_job <- a$upload(
   path = "/path/to/your/file.txt",
   project = destination_project,
   overwrite = TRUE,
   init = TRUE
 )

## End(Not run)

## ------------------------------------------------
## Method `Auth$list_ongoing_uploads`
## ------------------------------------------------

## Not run: 
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # List ongoing uploads
 a$list_ongoing_uploads()

## End(Not run)

## ------------------------------------------------
## Method `Auth$upload_abort`
## ------------------------------------------------

## Not run: 
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Abort upload
 a$abort_upload(upload_id = "<id_of_the_upload_process>")

## End(Not run)

## ------------------------------------------------
## Method `Auth$send_feedback`
## ------------------------------------------------

## Not run: 
 # Authenticate using authentication token
 a <- Auth$new(
  token = "<your_token>",
  platform = "aws-us"
 )

 # Send feedback
 a$send_feedback(
  "This is a test for sending feedback via API.",
  type = "thought"
 )

## End(Not run)

R6 Class representing billing information.

Description

R6 Class representing a central resource for managing billing groups.

Details

This is the main object for Billing

Super class

sevenbridges2::Item -> Billing

Public fields

Methods

Public methods

• Billing$new()

• Billing$print()

• Billing$reload()

• Billing$analysis_breakdown()

• Billing$storage_breakdown()

• Billing$egress_breakdown()

• Billing$clone()

Method new()

Create a new Billing object.

Usage

Billing$new(res = NA, ...)

Arguments

Method print()

Prints billing group information as a bullet list.

Usage

Billing$print()

Examples

\dontrun{
# x is API response when billing group is requested
 billing_object <- Billing$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print billing group
 billing_object$print()
}

Method reload()

Reload Billing group object.

Usage

Billing$reload(...)

Arguments

Returns

Billing object.

Examples

\dontrun{
 # x is API response when billing group is requested
 billing_object <- Billing$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload billing group
 billing_object$reload()
}

Method analysis_breakdown()

Method for getting an analysis breakdown for a billing group.

Usage

Billing$analysis_breakdown(
  date_from = NULL,
  date_to = NULL,
  invoice = NULL,
  fields = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Examples

\dontrun{
# x is API response when billing group is requested
 billing_object <- Billing$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get analysis breakdown
 billing_object$analysis_breakdown()
}

Method storage_breakdown()

Method for getting a storage breakdown for a billing group.

Usage

Billing$storage_breakdown(
  date_from = NULL,
  date_to = NULL,
  invoice = NULL,
  fields = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Examples

\dontrun{
# x is API response when billing group is requested
 billing_object <- Billing$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get storage breakdown
 billing_object$storage_breakdown()
}

Method egress_breakdown()

Method for getting a egress breakdown for a billing group.

Usage

Billing$egress_breakdown(
  date_from = NULL,
  date_to = NULL,
  invoice = NULL,
  fields = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Examples

\dontrun{
# x is API response when billing group is requested
 billing_object <- Billing$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get egress breakdown
 billing_object$egress_breakdown()
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Billing$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Billing$print`
## ------------------------------------------------

## Not run: 
# x is API response when billing group is requested
 billing_object <- Billing$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print billing group
 billing_object$print()

## End(Not run)


## ------------------------------------------------
## Method `Billing$reload`
## ------------------------------------------------

## Not run: 
 # x is API response when billing group is requested
 billing_object <- Billing$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload billing group
 billing_object$reload()

## End(Not run)


## ------------------------------------------------
## Method `Billing$analysis_breakdown`
## ------------------------------------------------

## Not run: 
# x is API response when billing group is requested
 billing_object <- Billing$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get analysis breakdown
 billing_object$analysis_breakdown()

## End(Not run)


## ------------------------------------------------
## Method `Billing$storage_breakdown`
## ------------------------------------------------

## Not run: 
# x is API response when billing group is requested
 billing_object <- Billing$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get storage breakdown
 billing_object$storage_breakdown()

## End(Not run)


## ------------------------------------------------
## Method `Billing$egress_breakdown`
## ------------------------------------------------

## Not run: 
# x is API response when billing group is requested
 billing_object <- Billing$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get egress breakdown
 billing_object$egress_breakdown()

## End(Not run)

R6 Class representing billing groups endpoints

Description

R6 Class representing billing groups resource endpoints.

Super class

sevenbridges2::Resource -> Billing_groups

Public fields

Methods

Public methods

• Billing_groups$new()

• Billing_groups$query()

• Billing_groups$get()

• Billing_groups$clone()

Method new()

Create a new Billing_groups object.

Usage

Billing_groups$new(...)

Arguments

Method query()

List all your billing groups, including groups that are pending or have been disabled.

Usage

Billing_groups$query(
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of Billing groups.

Examples

\dontrun{
 billing_groups_object <- Billing_groups$new(
   auth = auth
 )

 # List all your billing groups
 billing_groups_object$query()
}

Method get()

Retrieve a single billing group, specified by its ID. To find the billing_group, use the call Billing_groups$query() to list all your billing groups. The information returned includes the billing group owner, the total balance, and the status of the billing group (pending or confirmed).

Usage

Billing_groups$get(id, ...)

Arguments

Returns

Billing object.

Examples

\dontrun{
 billing_groups_object <- Billing_groups$new(
   auth = auth
 )

 # Get single billing group
 billing_groups_object$get(id = id)
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Billing_groups$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Billing_groups$query`
## ------------------------------------------------

## Not run: 
 billing_groups_object <- Billing_groups$new(
   auth = auth
 )

 # List all your billing groups
 billing_groups_object$query()

## End(Not run)


## ------------------------------------------------
## Method `Billing_groups$get`
## ------------------------------------------------

## Not run: 
 billing_groups_object <- Billing_groups$new(
   auth = auth
 )

 # Get single billing group
 billing_groups_object$get(id = id)

## End(Not run)

R6 Class representing a Collection of objects

Description

R6 Class representing a resource for managing collections. A wrapper for Seven Bridges pageable resources. Among the actual collection items it contains information regarding the total number of entries available on the server and resource API request URL (href).

Public fields

Methods

Public methods

• Collection$new()

• Collection$print()

• Collection$next_page()

• Collection$prev_page()

• Collection$all()

• Collection$clone()

Method new()

Create a new Collection object.

Usage

Collection$new(
  href = NA,
  items = NA,
  links = NA,
  total = NA,
  response = NA,
  auth = NA
)

Arguments

Method print()

Print method for Collection class.

Usage

Collection$print(n = 10)

Arguments

Examples

\dontrun{
 # x is API response when collection object is requested
 collection_object <- Collection$new(
                                   href = x$href,
                                   items = x$items,
                                   links = x$links,
                                   total = x$total,
                                   auth = auth,
                                   response = attr(x, "response")
                                 )

 # Print collection object
 collection_object$print()
}

Method next_page()

Returns the next page of results.

Usage

Collection$next_page(...)

Arguments

Examples

\dontrun{
 # x is API response when collection object is requested
 collection_object <- Collection$new(
                                   href = x$href,
                                   items = x$items,
                                   links = x$links,
                                   total = x$total,
                                   auth = auth,
                                   response = attr(x, "response")
                                 )

 # Get next page of collection results
 collection_object$next_page()
}

Method prev_page()

Returns the previous page of results.

Usage

Collection$prev_page(...)

Arguments

Examples

\dontrun{
 # x is API response when collection object is requested
 collection_object <- Collection$new(
                                   href = x$href,
                                   items = x$items,
                                   links = x$links,
                                   total = x$total,
                                   auth = auth,
                                   response = attr(x, "response")
                                 )

 # Get previous page of collection results
 collection_object$prev_page()
}

Method all()

Fetches all available items by iterating through all pages. Please be aware of the API rate limit for your request.

Usage

Collection$all(...)

Arguments

Examples

\dontrun{
 # x is API response when collection object is requested
 collection_object <- Collection$new(
                                   href = x$href,
                                   items = x$items,
                                   links = x$links,
                                   total = x$total,
                                   auth = auth,
                                   response = attr(x, "response")
                                 )

 # Get all results of collection
 collection_object$all()
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Collection$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Collection$print`
## ------------------------------------------------

## Not run: 
 # x is API response when collection object is requested
 collection_object <- Collection$new(
                                   href = x$href,
                                   items = x$items,
                                   links = x$links,
                                   total = x$total,
                                   auth = auth,
                                   response = attr(x, "response")
                                 )

 # Print collection object
 collection_object$print()

## End(Not run)


## ------------------------------------------------
## Method `Collection$next_page`
## ------------------------------------------------

## Not run: 
 # x is API response when collection object is requested
 collection_object <- Collection$new(
                                   href = x$href,
                                   items = x$items,
                                   links = x$links,
                                   total = x$total,
                                   auth = auth,
                                   response = attr(x, "response")
                                 )

 # Get next page of collection results
 collection_object$next_page()

## End(Not run)


## ------------------------------------------------
## Method `Collection$prev_page`
## ------------------------------------------------

## Not run: 
 # x is API response when collection object is requested
 collection_object <- Collection$new(
                                   href = x$href,
                                   items = x$items,
                                   links = x$links,
                                   total = x$total,
                                   auth = auth,
                                   response = attr(x, "response")
                                 )

 # Get previous page of collection results
 collection_object$prev_page()

## End(Not run)


## ------------------------------------------------
## Method `Collection$all`
## ------------------------------------------------

## Not run: 
 # x is API response when collection object is requested
 collection_object <- Collection$new(
                                   href = x$href,
                                   items = x$items,
                                   links = x$links,
                                   total = x$total,
                                   auth = auth,
                                   response = attr(x, "response")
                                 )

 # Get all results of collection
 collection_object$all()

## End(Not run)

R6 Class representing a Division

Description

R6 Class representing a central resource for managing divisions.

Super class

sevenbridges2::Item -> Division

Public fields

Methods

Public methods

• Division$new()

• Division$print()

• Division$reload()

• Division$list_teams()

• Division$list_members()

• Division$remove_member()

• Division$clone()

Method new()

Create a new Division object.

Usage

Division$new(res = NA, ...)

Arguments

Method print()

Print method for Division class.

Usage

Division$print()

Examples

\dontrun{
 division_object <- Division$new(
 	res = x,
		href = x$href,
		auth = auth,
		response = attr(x, "response")
 )
 division_object$print()
}

Method reload()

Reload Division object information.

Usage

Division$reload(...)

Arguments

Returns

Division object.

Examples

\dontrun{
 division_object <- Division$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 division_object$reload()
}

Method list_teams()

This call retrieves a list of all teams in a division that you are a member of. Each team's ID and name will be returned.

Usage

Division$list_teams(list_all = FALSE, ...)

Arguments

Returns

A Collection of Team objects.

Examples

\dontrun{
  # Get details of a specific division
  division_obj <- a$divisions$get(id = "division-id")

  # Retrieve a list of division teams you are a member of
  division_obj$list_teams()

  # Retrieve a list of all teams within the division regardless of
  # whether you are a member of a team or not
  division_obj$list_teams(list_all = TRUE)
}

Method list_members()

This call retrieves a list of all members of a division. In addition, you can list members with a specific role, e.g. all administrators within a division.

Usage

Division$list_members(
  role = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

A Collection of User objects.

Examples

\dontrun{
  # Get details of a specific division
  division_obj <- a$divisions$get(id = "division-id")

  # Retrieve a list of all division members
  division_obj$list_members()

  # Or filter members by role. The following roles are supported:
  # "MEMBER", "ADMIN", and "EXTERNAL_COLLABORATOR"
  division_obj$list_members(role = "ADMIN")
}

Method remove_member()

Removes a specified user from a division. This action revokes the user's membership in the division but does not delete their Platform account. Note that only users with the ADMIN role in the division can perform this action.

Usage

Division$remove_member(user)

Arguments

Examples

\dontrun{
  # Retrieve details of a specific division
  division_obj <- a$divisions$get(id = "division-id")

  # Remove a member using their username
  division_obj$remove_member(user = "division-name/username")

  # Remove a member using a User object
  members <- division_obj$list_members(role = "MEMBER")
  member_to_remove <- members$items[[1]]
  division_obj$remove_member(user = member_to_remove)
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Division$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Division$print`
## ------------------------------------------------

## Not run: 
 division_object <- Division$new(
 	res = x,
		href = x$href,
		auth = auth,
		response = attr(x, "response")
 )
 division_object$print()

## End(Not run)

## ------------------------------------------------
## Method `Division$reload`
## ------------------------------------------------

## Not run: 
 division_object <- Division$new(
   res = x,
   href = x$href,
   auth = auth,
   response = attr(x, "response")
 )
 division_object$reload()

## End(Not run)


## ------------------------------------------------
## Method `Division$list_teams`
## ------------------------------------------------

## Not run: 
  # Get details of a specific division
  division_obj <- a$divisions$get(id = "division-id")

  # Retrieve a list of division teams you are a member of
  division_obj$list_teams()

  # Retrieve a list of all teams within the division regardless of
  # whether you are a member of a team or not
  division_obj$list_teams(list_all = TRUE)

## End(Not run)


## ------------------------------------------------
## Method `Division$list_members`
## ------------------------------------------------

## Not run: 
  # Get details of a specific division
  division_obj <- a$divisions$get(id = "division-id")

  # Retrieve a list of all division members
  division_obj$list_members()

  # Or filter members by role. The following roles are supported:
  # "MEMBER", "ADMIN", and "EXTERNAL_COLLABORATOR"
  division_obj$list_members(role = "ADMIN")

## End(Not run)


## ------------------------------------------------
## Method `Division$remove_member`
## ------------------------------------------------

## Not run: 
  # Retrieve details of a specific division
  division_obj <- a$divisions$get(id = "division-id")

  # Remove a member using their username
  division_obj$remove_member(user = "division-name/username")

  # Remove a member using a User object
  members <- division_obj$list_members(role = "MEMBER")
  member_to_remove <- members$items[[1]]
  division_obj$remove_member(user = member_to_remove)

## End(Not run)

R6 Class representing divisions endpoints.

Description

R6 Class representing Divisions resource.

Super class

sevenbridges2::Resource -> Divisions

Public fields

Methods

Public methods

• Divisions$new()

• Divisions$query()

• Divisions$get()

• Divisions$clone()

Method new()

Create new Divisions resource object.

Usage

Divisions$new(...)

Arguments

Method query()

This call retrieves a list of all divisions you are a member of. Each division's ID, name and URL on platform will be returned.

Usage

Divisions$query()

Returns

A Collection of Division objects.

Examples

\dontrun{
  # Retrieve a list of all divisions you are a member of
  a$Divisions$query()
}

Method get()

This call returns the details of a specified division.

Usage

Divisions$get(id, ...)

Arguments

Returns

Division object.

Examples

\dontrun{
  # Retrieve details of a specified division
  a$Divisions$get(id = "division-id")
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Divisions$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Divisions$query`
## ------------------------------------------------

## Not run: 
  # Retrieve a list of all divisions you are a member of
  a$Divisions$query()

## End(Not run)

## ------------------------------------------------
## Method `Divisions$get`
## ------------------------------------------------

## Not run: 
  # Retrieve details of a specified division
  a$Divisions$get(id = "division-id")

## End(Not run)

R6 Class representing an Export

Description

R6 Class representing a resource for managing volume export jobs.

Super class

sevenbridges2::Item -> Export

Public fields

Methods

Public methods

• Export$new()

• Export$print()

• Export$reload()

• Export$clone()

Method new()

Create a new Export object.

Usage

Export$new(res = NA, ...)

Arguments

Method print()

Print method for Export class.

Usage

Export$print()

Examples

\dontrun{
# x is API response when export is requested
export_object <- Export$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print export object
 export_object$print()
}

Method reload()

Refresh the Export object with updated information.

Usage

Export$reload(...)

Arguments

Returns

Export object.

Examples

\dontrun{
# x is API response when export is requested
export_object <- Export$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload export object
 export_object$reload()
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Export$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Export$print`
## ------------------------------------------------

## Not run: 
# x is API response when export is requested
export_object <- Export$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print export object
 export_object$print()

## End(Not run)


## ------------------------------------------------
## Method `Export$reload`
## ------------------------------------------------

## Not run: 
# x is API response when export is requested
export_object <- Export$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload export object
 export_object$reload()

## End(Not run)

R6 Class representing storage exports endpoints

Description

R6 Class representing storage exports resource endpoints.

Super class

sevenbridges2::Resource -> Exports

Public fields

Methods

Public methods

• Exports$new()

• Exports$query()

• Exports$get()

• Exports$submit_export()

• Exports$delete()

• Exports$bulk_get()

• Exports$bulk_submit_export()

• Exports$clone()

Method new()

Create a new Exports object.

Usage

Exports$new(...)

Arguments

Method query()

This call lists export jobs initiated by a particular user. Note that when you export a file from a project on the Platform into a volume, you write to your cloud storage bucket.

Usage

Exports$query(
  volume = NULL,
  state = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of Export objects.

Examples

\dontrun{
 exports_object <- Exports$new(
   auth = auth
 )

 # List all your running or failed export jobs on the volume
 exports_object$query(volume = volume, state = c("RUNNING", "FAILED"))
}

Method get()

This call will return the details of an export job.

Usage

Exports$get(id, ...)

Arguments

Returns

Export object.

Examples

\dontrun{
 exports_object <- Exports$new(
   auth = auth
 )

 # Get export job by ID
 exports_object$get(id = id)
}

Method submit_export()

This call lets you queue a job to export a file from a project on the Platform into a volume. The file selected for export must not be a public file or an alias. Aliases are objects stored in your cloud storage bucket which have been made available on the Platform. The volume you are exporting to must be configured for read-write access. To do this, set the access_mode parameter to RW when creating or modifying a volume.

Essentially, the call writes to your cloud storage bucket via the volume. If this call is successful, the original project file will become an alias to the newly exported object on the volume. The source file will be deleted from the Platform and, if no more copies of this file exist, it will no longer count towards your total storage price on the Platform.
In summary, once you export a file from the Platform to a volume, it is no longer part of the storage on the Platform and cannot be exported again.

Read more about this operation in our documentation here.

If you want to export multiple files, the recommended way is to do it in bulk considering the API rate limit (learn more). Bulk operations will be implemented in next releases.

Usage

Exports$submit_export(
  source_file,
  destination_volume,
  destination_location,
  overwrite = FALSE,
  copy_only = FALSE,
  properties = NULL,
  ...
)

Arguments

Returns

Export object.

Examples

\dontrun{
 exports_object <- Exports$new(
   auth = auth
 )

 # Submit export job
 exp_job1 <- exports_object$submit_export(
                          source_file = test_file,
                          destination_volume = vol1,
                          destination_location = "new_volume_file.txt"
                )
}

Method delete()

Export jobs cannot be deleted.

Usage

Exports$delete()

Method bulk_get()

This call returns the details of a bulk export job. When you export files from a project on the Platform into a volume, you write to your cloud storage bucket. This call obtains the details of that job.

Usage

Exports$bulk_get(exports)

Arguments

Returns

Collection with list of Export objects.

Examples

\dontrun{
 exports_object <- Exports$new(
                    auth = auth,
                   )

 # List export jobs
 exports_object$bulk_get(
  exports = list("export-job-id-1", "export-job-id-2")
  )
}

Method bulk_submit_export()

Bulk export files from your project on the Seven Bridges Platform into your volume. One call can contain up to 100 items. Files selected for export must not be public files or aliases. Aliases are objects stored in your cloud storage bucket which have been made available on the Platform. The volume you are exporting to must be configured for read-write access. To do this, set the access_mode parameter to RW when creating or modifying a volume.

Essentially, the call writes to your cloud storage bucket via the volume. If this call is successful, the original project files will become aliases to the newly exported objects on the volume. Source files will be deleted from the Platform and, if no more copies of the files exist, they will no longer count towards your total storage price on the Platform. In summary, once you export files from the Platform to a volume, they are no longer part of the storage on the Platform and cannot be exported again.

Learn more about using the Volumes API for Amazon S3 and for Google Cloud Storage.

Usage

Exports$bulk_submit_export(items, copy_only = FALSE)

Arguments

Returns

Collection with list of Export objects.

Examples

\dontrun{
 exports_object <- Exports$new(
                    auth = auth
                   )

 # Submit new bulk export into a volume
 exports_object$bulk_submit_export(items = list(
   list(
     source_file = "test_file-id",
     destination_volume = "volume-id",
     destination_location = "new_volume_file.txt"
   ),
   list(
     source_file = test_file_obj,
     destination_volume = test_volume_obj,
     destination_location = "/volume_folder/exported_file.txt",
     overwrite = TRUE
   ),
   list(
     source_file = "project_file_3_id",
     destination_volume = "volume-id",
     destination_location = "project_file_3.txt",
     properties = list(
      sse_algorithm = "AES256"
     )
   )
  ), copy_only = TRUE
 )
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Exports$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Exports$query`
## ------------------------------------------------

## Not run: 
 exports_object <- Exports$new(
   auth = auth
 )

 # List all your running or failed export jobs on the volume
 exports_object$query(volume = volume, state = c("RUNNING", "FAILED"))

## End(Not run)


## ------------------------------------------------
## Method `Exports$get`
## ------------------------------------------------

## Not run: 
 exports_object <- Exports$new(
   auth = auth
 )

 # Get export job by ID
 exports_object$get(id = id)

## End(Not run)


## ------------------------------------------------
## Method `Exports$submit_export`
## ------------------------------------------------

## Not run: 
 exports_object <- Exports$new(
   auth = auth
 )

 # Submit export job
 exp_job1 <- exports_object$submit_export(
                          source_file = test_file,
                          destination_volume = vol1,
                          destination_location = "new_volume_file.txt"
                )

## End(Not run)


## ------------------------------------------------
## Method `Exports$bulk_get`
## ------------------------------------------------

## Not run: 
 exports_object <- Exports$new(
                    auth = auth,
                   )

 # List export jobs
 exports_object$bulk_get(
  exports = list("export-job-id-1", "export-job-id-2")
  )

## End(Not run)


## ------------------------------------------------
## Method `Exports$bulk_submit_export`
## ------------------------------------------------

## Not run: 
 exports_object <- Exports$new(
                    auth = auth
                   )

 # Submit new bulk export into a volume
 exports_object$bulk_submit_export(items = list(
   list(
     source_file = "test_file-id",
     destination_volume = "volume-id",
     destination_location = "new_volume_file.txt"
   ),
   list(
     source_file = test_file_obj,
     destination_volume = test_volume_obj,
     destination_location = "/volume_folder/exported_file.txt",
     overwrite = TRUE
   ),
   list(
     source_file = "project_file_3_id",
     destination_volume = "volume-id",
     destination_location = "project_file_3.txt",
     properties = list(
      sse_algorithm = "AES256"
     )
   )
  ), copy_only = TRUE
 )

## End(Not run)

R6 Class representing a File

Description

R6 Class representing a resource for managing files and folders.

Super class

sevenbridges2::Item -> File

Public fields

Methods

Public methods

• File$new()

• File$print()

• File$detailed_print()

• File$reload()

• File$update()

• File$add_tag()

• File$copy_to()

• File$get_download_url()

• File$get_metadata()

• File$set_metadata()

• File$move_to_folder()

• File$list_contents()

• File$delete()

• File$download()

• File$submit_export()

• File$clone()

Method new()

Create a new File object.

Usage

File$new(res = NA, ...)

Arguments

Method print()

Print method for File class.

Usage

File$print()

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print file object
 file_object$print()
}

Method detailed_print()

Detailed print method for File class.

Usage

File$detailed_print()

Details

The call returns the file's name, its tags, and all of its metadata. Apart from regular file fields there are some additional fields:

• storage field denotes the type of storage for the file which can be either PLATFORM or VOLUME depending on where the file is stored.

• origin field denotes the task that produced the file, if it was created by a task on the Seven Bridges Platform.

• metadata field lists the metadata fields and values for the file.

• tags field lists the tags for the file. Learn more about tagging your files on the Platform.

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Detailed print of file object
 file_object$detailed_print()
}

Method reload()

Reload File object information.

Usage

File$reload(...)

Arguments

Returns

File object.

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload file object
 file_object$reload()
}

Method update()

Updates the name, the full set of metadata, and tags for a specified file.

Usage

File$update(name = NULL, metadata = NULL, tags = NULL, ...)

Arguments

Returns

Updated File object.

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Update file object
 file_object$update(name = "new_name")
}

Method add_tag()

This method allows you to tag files on the Platform. You can tag your files on the Platform with keywords to make it easier to identify and organize files you’ve imported from public datasets or copied between projects.
More details on how to use this call can be found here.

Usage

File$add_tag(tags, overwrite = FALSE, ...)

Arguments

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Add new tag to file object
 file_object$add_tag(tags = c("new_tag"))
}

Method copy_to()

This call copies the specified file to a new project. Files retain their metadata when copied, but may be assigned new names in their target project. To make this call, you should have copy permission within the project you are copying from.
Note: If you want to copy multiple files, the recommended way is to do it in bulk considering the API rate limit (learn more). You can do that using Auth$copy_files() operation.

Usage

File$copy_to(project, name = NULL, ...)

Arguments

Returns

Copied File object.

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Copy file object to project
 file_object$copy_to(project = project)
}

Method get_download_url()

This method returns a URL that you can use to download the specified file.

Usage

File$get_download_url(...)

Arguments

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get download url for file object
 file_object$get_download_url()
}

Method get_metadata()

This call returns the metadata values for the specified file.

Usage

File$get_metadata(...)

Arguments

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get metadata for file object
 file_object$get_metadata()
}

Method set_metadata()

This call changes the metadata values for the specified file.
More details about how to modify metadata, you can find in the API documentation.

Usage

File$set_metadata(metadata_fields, overwrite = FALSE, ...)

Arguments

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Set metadata for file object
 file_object$set_metadata(metadata_fields = list("field_1" = "value_1"))
}

Method move_to_folder()

This call moves a file from one folder to another. Moving of files is only allowed within the same project.

Usage

File$move_to_folder(parent, name = NULL)

Arguments

Returns

Moved File object.

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Move file object to a project
 file_object$move_to_folder(parent = "parent-folder-id")
}

Method list_contents()

List folder contents.

Usage

File$list_contents(
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of File objects.

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List folder's content
 file_object$list_contents()
}

Method delete()

Delete method for File objects.

Usage

File$delete()

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Delete file object
 file_object$delete()
}

Method download()

Download method for File objects. It allows downloading a platform file to your local computer. To specify the destination for your download, you should provide the path to the destination directory as directory_path parameter.

Usage

File$download(
  directory_path,
  filename = self$name,
  method = "curl",
  retry_count = getOption("sevenbridges2")$default_retry_count,
  retry_timeout = getOption("sevenbridges2")$default_retry_timeout
)

Arguments

Examples

\dontrun{
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Download file object
 file_object$download(directory_path = ".")
}

Method submit_export()

This call lets you queue a job to export this file from a project on the Platform into a volume. The file selected for export must not be a public file or an alias. Aliases are objects stored in your cloud storage bucket which have been made available on the Platform. The volume you are exporting to must be configured for read-write access. To do this, set the access_mode parameter to RW when creating or modifying a volume.

Essentially, the call writes to your cloud storage bucket via the volume. If this call is successful, the original project file will become an alias to the newly exported object on the volume. The source file will be deleted from the Platform and, if no more copies of this file exist, it will no longer count towards your total storage price on the Platform.
In summary, once you export a file from the Platform to a volume, it is no longer part of the storage on the Platform and cannot be exported again.

Read more about this operation in our documentation here.
If you want to export multiple files, the recommended way is to do it in bulk considering the API rate limit (learn more) (bulk operations will be implemented in next releases).

Usage

File$submit_export(
  destination_volume,
  destination_location,
  overwrite = FALSE,
  copy_only = FALSE,
  properties = NULL,
  ...
)

Arguments

Returns

Export object.

Examples

\dontrun{
 # x is API response when file is requested
 file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Export file object to a volume
 file_object$submit_export(
               destination_volume = volume,
               destination_location = location
             )
}

Method clone()

The objects of this class are cloneable with this method.

Usage

File$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `File$print`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print file object
 file_object$print()

## End(Not run)


## ------------------------------------------------
## Method `File$detailed_print`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Detailed print of file object
 file_object$detailed_print()

## End(Not run)


## ------------------------------------------------
## Method `File$reload`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload file object
 file_object$reload()

## End(Not run)


## ------------------------------------------------
## Method `File$update`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Update file object
 file_object$update(name = "new_name")

## End(Not run)


## ------------------------------------------------
## Method `File$add_tag`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Add new tag to file object
 file_object$add_tag(tags = c("new_tag"))

## End(Not run)


## ------------------------------------------------
## Method `File$copy_to`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Copy file object to project
 file_object$copy_to(project = project)

## End(Not run)


## ------------------------------------------------
## Method `File$get_download_url`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get download url for file object
 file_object$get_download_url()

## End(Not run)


## ------------------------------------------------
## Method `File$get_metadata`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get metadata for file object
 file_object$get_metadata()

## End(Not run)


## ------------------------------------------------
## Method `File$set_metadata`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Set metadata for file object
 file_object$set_metadata(metadata_fields = list("field_1" = "value_1"))

## End(Not run)


## ------------------------------------------------
## Method `File$move_to_folder`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Move file object to a project
 file_object$move_to_folder(parent = "parent-folder-id")

## End(Not run)


## ------------------------------------------------
## Method `File$list_contents`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List folder's content
 file_object$list_contents()

## End(Not run)


## ------------------------------------------------
## Method `File$delete`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Delete file object
 file_object$delete()

## End(Not run)


## ------------------------------------------------
## Method `File$download`
## ------------------------------------------------

## Not run: 
# x is API response when file is requested
file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Download file object
 file_object$download(directory_path = ".")

## End(Not run)


## ------------------------------------------------
## Method `File$submit_export`
## ------------------------------------------------

## Not run: 
 # x is API response when file is requested
 file_object <- File$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Export file object to a volume
 file_object$submit_export(
               destination_volume = volume,
               destination_location = location
             )

## End(Not run)

R6 Class representing files endpoints.

Description

R6 Class representing Files resource.

Super class

sevenbridges2::Resource -> Files

Public fields

Methods

Public methods

• Files$new()

• Files$query()

• Files$get()

• Files$delete()

• Files$copy()

• Files$create_folder()

• Files$bulk_delete()

• Files$bulk_get()

• Files$bulk_update()

• Files$bulk_edit()

• Files$async_bulk_copy()

• Files$async_bulk_delete()

• Files$async_bulk_move()

• Files$async_get_copy_job()

• Files$async_get_delete_job()

• Files$async_get_move_job()

• Files$async_list_file_jobs()

• Files$clone()

Method new()

Create new Files resource object.

Usage

Files$new(...)

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.
For more details, see 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

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

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

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 can be found here here.

Usage

Files$copy(files, destination_project)

Arguments

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

Examples

\dontrun{
 files_object <- Files$new(auth = auth)

 # Create folder in a project
 files_object$create_folder(
                name = name,
                project = project
               )
}

Method bulk_delete()

This method facilitates bulk file deletion. It accepts either a list of File objects or a list containing files' IDs.

Usage

Files$bulk_delete(files)

Arguments

Returns

None. The function only displays the IDs of the deleted files in the console.

Examples

\dontrun{
 # Delete two files by providing their IDs
 a$files$bulk_delete(files = list("file_1_ID", "file_2_ID"))
}

\dontrun{
 # Delete two files by providing a list of File objects
 a$files$bulk_delete(files = list(File_Object_1, File_Object_2))
}

Method bulk_get()

This call returns the details of multiple specified files, including file names and file metadata. The maximum number of files you can retrieve the details for per call is 100.

Usage

Files$bulk_get(files)

Arguments

Returns

Collection (list of File objects).

Examples

\dontrun{
 # Get details of multiple files
 a$files$bulk_get(
               files = list("file_1_ID", "file_2_ID")
              )
}

Method bulk_update()

A method that sets new information for specified files, replacing all existing information and erasing omitted parameters.

Usage

Files$bulk_update(files)

Arguments

Details

For each of the specified files, the call sets a new name, new tags, and metadata.

When editing fields in the File objects you wish to update, keep the following in mind:

• The name field should be a string representing the new name of the file.

• The metadata field should be a named list of key-value pairs. The keys and values should be strings.

• The tags field should be an unnamed list of values.

The maximum number of files you can update the details for per call is 100.

Returns

Collection (list of File objects).

Examples

\dontrun{
 # Update details of multiple files
 a$files$bulk_update(
               files = list(File_Object_1, File_Object_2)
              )
}

Method bulk_edit()

This method modifies the existing information for specified files or adds new information while preserving omitted parameters.

Usage

Files$bulk_edit(files)

Arguments

Details

For each of the specified files, the call edits its name, tags, and metadata.

When editing fields in the File objects you wish to update, keep the following in mind:

• The name field should be a string representing the new name of the file.

• The metadata field should be a named list of key-value pairs. The keys and values should be strings.

• The tags field should be an unnamed list of values.

The maximum number of files you can update the details for per call is 100.

Returns

Collection (list of File objects).

Examples

\dontrun{
 # Edit details of multiple files
 a$files$bulk_edit(
               files = list(File_Object_1, File_Object_2)
              )
}

Method async_bulk_copy()

This call lets you perform a bulk copy of files and folders. Any underlying folder structure will be preserved. You can copy:

• to a folder within the same project,

• to another project,

• to a folder in another project.

Usage

Files$async_bulk_copy(items)

Arguments

Returns

AsyncJob object.

Examples

\dontrun{
 # Copy multiple files
 a$files$async_bulk_copy(
   items = list(
           list(
             file = '<file-id-1>',
             parent = '<folder-id>'
           ),
           list(
             file = '<file-id-2>',
             project = '<project-id-1>',
             name = 'copied_file.txt'
           ),
           list(
             file = '<file-id-3>',
             parent = '<parent-id-2>',
             name = 'copied_file2.txt'
           )
         )
  )
}

Method async_bulk_delete()

This call lets you perform an asynchronous bulk deletion of files or folders. Deleting folders which aren't empty is allowed.

Usage

Files$async_bulk_delete(items)

Arguments

Returns

AsyncJob object.

Examples

\dontrun{
 # Delete multiple files
 a$files$async_bulk_delete(
   items = list(file_obj1, file_obj2, "<folder-id-string>", "<file-id>")
 )
}

Method async_bulk_move()

This call lets you perform a bulk move operation of files and folders. You can move:

• to a root project folder,

• to a subfolder within the same project or a different project.

Usage

Files$async_bulk_move(items)

Arguments

Details

Rules for moving files and folders:

• The file ID is preserved after the move.

• The folder ID is changed after the move.

• The destination must be an existing folder.

• If the target folder contains a folder with the same name, the contents of both folders will be merged.

• If a file with the same name already exists, the source file will be automatically renamed (by adding a numeric prefix).

• You need to have WRITE permissions for both source and destination folders.

Returns

AsyncJob object.

Examples

\dontrun{
 # Move multiple files
 a$files$async_bulk_move(
   items = list(
           list(
             file = '<file-id-1>',
             parent = '<folder-id>'
           ),
           list(
             file = '<file-id-2>',
             project = '<project-id-1>',
             name = 'moved_file.txt'
           ),
           list(
             file = '<file-id-3>',
             parent = '<parent-id-2>',
             name = 'moved_file2.txt'
           )
         )
  )
}

Method async_get_copy_job()

This call retrieves the details of an asynchronous bulk copy job. This information will be available for up to a month after the job has been completed.

Usage

Files$async_get_copy_job(job_id)

Arguments

Returns

AsyncJob object.

Examples

\dontrun{
 # Get details of an async copy job
 a$files$async_get_copy_job(job_id = "job-id")
}

Method async_get_delete_job()

This call retrieves the details of an asynchronous bulk deletion job. This information will be available for up to a month after the job has been completed.

Usage

Files$async_get_delete_job(job_id)

Arguments

Returns

AsyncJob object.

Examples

\dontrun{
 # Get details of an async delete job
 a$files$async_get_delete_job(job_id = "job-id")
}

Method async_get_move_job()

This call retrieves the details of an asynchronous bulk move job. This information will be available for up to a month after the job has been completed.

Usage

Files$async_get_move_job(job_id)

Arguments

Returns

An AsyncJob object containing details of the move job.

Examples

\dontrun{
 # Get details of an async move job
 a$files$async_get_move_job(job_id = "job-id")
}

Method async_list_file_jobs()

This call retrieves the details for all asynchronous bulk jobs you have started. This information will be available for up to a month after the job has been completed.

Usage

Files$async_list_file_jobs(
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset
)

Arguments

Returns

A Collection object containing a list of AsyncJob objects.

Examples

\dontrun{
 # Get details of the first 5 async jobs
 a$files$async_list_file_jobs(limit = 5)
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Files$clone(deep = FALSE)

Arguments

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)


## ------------------------------------------------
## Method `Files$bulk_delete`
## ------------------------------------------------

## Not run: 
 # Delete two files by providing their IDs
 a$files$bulk_delete(files = list("file_1_ID", "file_2_ID"))

## End(Not run)

## Not run: 
 # Delete two files by providing a list of File objects
 a$files$bulk_delete(files = list(File_Object_1, File_Object_2))

## End(Not run)


## ------------------------------------------------
## Method `Files$bulk_get`
## ------------------------------------------------

## Not run: 
 # Get details of multiple files
 a$files$bulk_get(
               files = list("file_1_ID", "file_2_ID")
              )

## End(Not run)


## ------------------------------------------------
## Method `Files$bulk_update`
## ------------------------------------------------

## Not run: 
 # Update details of multiple files
 a$files$bulk_update(
               files = list(File_Object_1, File_Object_2)
              )

## End(Not run)


## ------------------------------------------------
## Method `Files$bulk_edit`
## ------------------------------------------------

## Not run: 
 # Edit details of multiple files
 a$files$bulk_edit(
               files = list(File_Object_1, File_Object_2)
              )

## End(Not run)


## ------------------------------------------------
## Method `Files$async_bulk_copy`
## ------------------------------------------------

## Not run: 
 # Copy multiple files
 a$files$async_bulk_copy(
   items = list(
           list(
             file = '<file-id-1>',
             parent = '<folder-id>'
           ),
           list(
             file = '<file-id-2>',
             project = '<project-id-1>',
             name = 'copied_file.txt'
           ),
           list(
             file = '<file-id-3>',
             parent = '<parent-id-2>',
             name = 'copied_file2.txt'
           )
         )
  )

## End(Not run)


## ------------------------------------------------
## Method `Files$async_bulk_delete`
## ------------------------------------------------

## Not run: 
 # Delete multiple files
 a$files$async_bulk_delete(
   items = list(file_obj1, file_obj2, "<folder-id-string>", "<file-id>")
 )

## End(Not run)


## ------------------------------------------------
## Method `Files$async_bulk_move`
## ------------------------------------------------

## Not run: 
 # Move multiple files
 a$files$async_bulk_move(
   items = list(
           list(
             file = '<file-id-1>',
             parent = '<folder-id>'
           ),
           list(
             file = '<file-id-2>',
             project = '<project-id-1>',
             name = 'moved_file.txt'
           ),
           list(
             file = '<file-id-3>',
             parent = '<parent-id-2>',
             name = 'moved_file2.txt'
           )
         )
  )

## End(Not run)


## ------------------------------------------------
## Method `Files$async_get_copy_job`
## ------------------------------------------------

## Not run: 
 # Get details of an async copy job
 a$files$async_get_copy_job(job_id = "job-id")

## End(Not run)


## ------------------------------------------------
## Method `Files$async_get_delete_job`
## ------------------------------------------------

## Not run: 
 # Get details of an async delete job
 a$files$async_get_delete_job(job_id = "job-id")

## End(Not run)


## ------------------------------------------------
## Method `Files$async_get_move_job`
## ------------------------------------------------

## Not run: 
 # Get details of an async move job
 a$files$async_get_move_job(job_id = "job-id")

## End(Not run)


## ------------------------------------------------
## Method `Files$async_list_file_jobs`
## ------------------------------------------------

## Not run: 
 # Get details of the first 5 async jobs
 a$files$async_list_file_jobs(limit = 5)

## End(Not run)

R6 Class representing an Import job

Description

R6 Class representing a resource for managing volume import jobs.

Super class

sevenbridges2::Item -> Import

Public fields

Methods

Public methods

• Import$new()

• Import$print()

• Import$reload()

• Import$clone()

Method new()

Create a new Import object.

Usage

Import$new(res = NA, ...)

Arguments

Method print()

Print method for Import class.

Usage

Import$print()

Examples

\dontrun{
 # x is API response when import is requested
 import_object <- Import$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print import object
 import_object$print()
}

Method reload()

Reload Import object information.

Usage

Import$reload(...)

Arguments

Returns

Import object.

Examples

\dontrun{
 # x is API response when import is requested
 import_object <- Import$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload import object
 import_object$reload()
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Import$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Import$print`
## ------------------------------------------------

## Not run: 
 # x is API response when import is requested
 import_object <- Import$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print import object
 import_object$print()

## End(Not run)


## ------------------------------------------------
## Method `Import$reload`
## ------------------------------------------------

## Not run: 
 # x is API response when import is requested
 import_object <- Import$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload import object
 import_object$reload()

## End(Not run)

R6 Class representing storage imports endpoints

Description

R6 Class for managing storage imports resource endpoints.

Super class

sevenbridges2::Resource -> Imports

Public fields

Methods

Public methods

• Imports$new()

• Imports$query()

• Imports$get()

• Imports$submit_import()

• Imports$delete()

• Imports$bulk_get()

• Imports$bulk_submit_import()

• Imports$clone()

Method new()

Create a new Imports object.

Usage

Imports$new(...)

Arguments

Method query()

This call lists import jobs initiated by a particular user. Note that when you import a file from your volume on your cloud storage provider (Amazon Web Services or Google Cloud Storage), you are creating an alias on the Platform which points to the file in your cloud storage bucket. Aliases appear as files on the Platform and can be copied, executed, and modified as such. They refer back to the respective file on the given volume.

Usage

Imports$query(
  volume = NULL,
  project = NULL,
  state = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of Import objects.

Examples

\dontrun{
 imports_object <- Imports$new(
                    auth = auth
                   )

 # List import job
 imports_object$query()
}

Method get()

This call will return the details of an import job.

Usage

Imports$get(id, ...)

Arguments

Returns

Import object.

Examples

\dontrun{
 imports_object <- Imports$new(
                    auth = auth
                   )

 # List import job
 imports_object$get(id = id)
}

Method submit_import()

This call lets you queue a job to import a file or folder from a volume into a project on the Platform. Essentially, you are importing an item from your cloud storage provider (Amazon Web Services, Google Cloud Storage, Azure or Ali Cloud) via the volume onto the Platform.
If successful, an alias will be created on the Platform. Aliases appear on the Platform and can be copied, executed, and modified as such. They refer back to the respective item on the given volume.

If you want to import multiple files, the recommended way is to do it in bulk considering the API rate limit (learn more). Bulk operations will be implemented in next releases.

Usage

Imports$submit_import(
  source_volume,
  source_location,
  destination_project = NULL,
  destination_parent = NULL,
  name = NULL,
  overwrite = FALSE,
  autorename = FALSE,
  preserve_folder_structure = NULL,
  ...
)

Arguments

Returns

Import object.

Examples

\dontrun{
 imports_object <- Imports$new(
                    auth = auth
                   )

 # Submit new import into a project
 imports_object$submit_import(
  source_location = volume_file_object,
  destination_project = test_project_object,
  autorename = TRUE
 )
}

Method delete()

Import jobs cannot be deleted.

Usage

Imports$delete()

Method bulk_get()

This call returns the details of a bulk import job. Note that when you import files from your volume on a cloud storage provider (Amazon Web Services or Google Cloud Storage), you create an alias on the Platform which points to the files in your cloud storage bucket. Aliases appear as files on the Platform and can be copied, executed, and modified.

Usage

Imports$bulk_get(imports)

Arguments

Returns

Collection with list of Import objects.

Examples

\dontrun{
 imports_object <- Imports$new(
                    auth = auth
                   )

 # List import job
 imports_object$bulk_get(
  imports = list("import-job-id-1", "import-job-id-2")
  )
}

Method bulk_submit_import()

This call lets you perform a bulk import of files from your volume (either Amazon Web Services or Google Cloud Storage) into your project on the Platform.

You can use this call to either import files to a specific folder or a project but you can also use it to import a folder and its files into another destination folder while preserving folder structure. One call can contain up to 100 items. Learn more about using the Volumes API for Amazon S3 and for Google Cloud Storage.

Usage

Imports$bulk_submit_import(items)

Arguments

Returns

Collection with list of Import objects.

Examples

\dontrun{
 imports_object <- Imports$new(
                    auth = auth
                   )

 # Submit new import into a project
 imports_object$bulk_submit_import(items = list(
   list(
     source_volume = "rfranklin/my-volume",
     source_location = "my-file.txt",
     destination_project = test_project_object,
     autorename = TRUE
   ),
   list(
     source_volume = "rfranklin/my-volume",
     source_location = "my-folder/",
     destination_parent = "parent-folder-id",
     autorename = FALSE,
     preserve_folder_structure = TRUE
   )
  )
 )
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Imports$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Imports$query`
## ------------------------------------------------

## Not run: 
 imports_object <- Imports$new(
                    auth = auth
                   )

 # List import job
 imports_object$query()

## End(Not run)


## ------------------------------------------------
## Method `Imports$get`
## ------------------------------------------------

## Not run: 
 imports_object <- Imports$new(
                    auth = auth
                   )

 # List import job
 imports_object$get(id = id)

## End(Not run)


## ------------------------------------------------
## Method `Imports$submit_import`
## ------------------------------------------------

## Not run: 
 imports_object <- Imports$new(
                    auth = auth
                   )

 # Submit new import into a project
 imports_object$submit_import(
  source_location = volume_file_object,
  destination_project = test_project_object,
  autorename = TRUE
 )

## End(Not run)


## ------------------------------------------------
## Method `Imports$bulk_get`
## ------------------------------------------------

## Not run: 
 imports_object <- Imports$new(
                    auth = auth
                   )

 # List import job
 imports_object$bulk_get(
  imports = list("import-job-id-1", "import-job-id-2")
  )

## End(Not run)


## ------------------------------------------------
## Method `Imports$bulk_submit_import`
## ------------------------------------------------

## Not run: 
 imports_object <- Imports$new(
                    auth = auth
                   )

 # Submit new import into a project
 imports_object$bulk_submit_import(items = list(
   list(
     source_volume = "rfranklin/my-volume",
     source_location = "my-file.txt",
     destination_project = test_project_object,
     autorename = TRUE
   ),
   list(
     source_volume = "rfranklin/my-volume",
     source_location = "my-folder/",
     destination_parent = "parent-folder-id",
     autorename = FALSE,
     preserve_folder_structure = TRUE
   )
  )
 )

## End(Not run)

R6 Class representing invoice information.

Description

R6 Class representing invoice information.

Details

This object contains information about a selected invoice, including costs for analysis, storage, and the invoice period.

Super class

sevenbridges2::Item -> Invoice

Public fields

Methods

Public methods

• Invoice$new()

• Invoice$print()

• Invoice$reload()

• Invoice$clone()

Method new()

Create new Invoice object.

Usage

Invoice$new(res = NA, ...)

Arguments

Method print()

Print invoice information as a bullet list.

Usage

Invoice$print()

Examples

\dontrun{
 # x is API response when invoice is requested
 invoice_object <- Invoice$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print invoice object
 invoice_object$print()
}

Method reload()

Refresh the Invoice object with updated information.

Usage

Invoice$reload(...)

Arguments

Returns

Invoice object.

Examples

\dontrun{
 # x is API response when invoice is requested
 invoice_object <- Invoice$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload invoice object
 invoice_object$reload()
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Invoice$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Invoice$print`
## ------------------------------------------------

## Not run: 
 # x is API response when invoice is requested
 invoice_object <- Invoice$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print invoice object
 invoice_object$print()

## End(Not run)


## ------------------------------------------------
## Method `Invoice$reload`
## ------------------------------------------------

## Not run: 
 # x is API response when invoice is requested
 invoice_object <- Invoice$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload invoice object
 invoice_object$reload()

## End(Not run)

R6 Class representing invoices endpoints

Description

R6 Class representing invoice resource endpoints

Super class

sevenbridges2::Resource -> Invoices

Public fields

Methods

Public methods

• Invoices$new()

• Invoices$query()

• Invoices$get()

• Invoices$clone()

Method new()

Create a new Invoices object.

Usage

Invoices$new(...)

Arguments

Method query()

The call returns information about all your available invoices, unless you use the billing_group query parameter to specify the ID of a particular billing group, in which case it will return the invoice incurred by that billing group only.

Usage

Invoices$query(
  billing_group = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of Invoice objects.

Examples

\dontrun{
 invoices_object <- Invoices$new(
   auth = auth
 )

 # List all your invoices
 invoices_object$query(billing_group = billing_group)
}

Method get()

This call retrieves information about a selected invoice, including the costs for analysis and storage, and the invoice period. Use the call to list invoices to retrieve the invoice_ids for a specified billing group.

Usage

Invoices$get(id, ...)

Arguments

Returns

Invoice object.

Examples

\dontrun{
 invoices_object <- Invoices$new(
   auth = auth
 )

 # Get a single invoice by id
 invoices_object$get(id = id)
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Invoices$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Invoices$query`
## ------------------------------------------------

## Not run: 
 invoices_object <- Invoices$new(
   auth = auth
 )

 # List all your invoices
 invoices_object$query(billing_group = billing_group)

## End(Not run)


## ------------------------------------------------
## Method `Invoices$get`
## ------------------------------------------------

## Not run: 
 invoices_object <- Invoices$new(
   auth = auth
 )

 # Get a single invoice by id
 invoices_object$get(id = id)

## End(Not run)

R6 Class Representing an Item

Description

Base class for describing objects: Project, Task, App, File, etc.

Public fields

Methods

Public methods

• Item$new()

• Item$reload()

• Item$clone()

Method new()

Create a new Item object.

Usage

Item$new(href = NA, response = NA, auth = NA)

Arguments

Method reload()

Reload the Item (resource).

Usage

Item$reload(cls, ...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

Item$clone(deep = FALSE)

Arguments

R6 Class representing a project member

Description

R6 Class representing a resource for managing project members.

Super class

sevenbridges2::Item -> Member

Public fields

Methods

Public methods

• Member$new()

• Member$print()

• Member$reload()

• Member$clone()

Method new()

Create a new Member object.

Usage

Member$new(res = NA, ...)

Arguments

Method print()

Print method for Member class.

Usage

Member$print()

Examples

\dontrun{
 # x is API response when member is requested
 member_object <- Member$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print member object
 member_object$print()
}

Method reload()

Reload Member object information.

Usage

Member$reload()

Examples

\dontrun{
 # x is API response when member is requested
 member_object <- Member$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload member object
 member_object$reload()
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Member$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Member$print`
## ------------------------------------------------

## Not run: 
 # x is API response when member is requested
 member_object <- Member$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print member object
 member_object$print()

## End(Not run)


## ------------------------------------------------
## Method `Member$reload`
## ------------------------------------------------

## Not run: 
 # x is API response when member is requested
 member_object <- Member$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload member object
 member_object$reload()

## End(Not run)

R6 Class representing a part of the uploading file

Description

R6 Class representing a resource for managing parts of the files' uploads.

Public fields

Methods

Public methods

• Part$new()

• Part$print()

• Part$upload_info_part()

• Part$upload_complete_part()

• Part$clone()

Method new()

Create a new Part object.

Usage

Part$new(
  part_number = NA,
  part_size = NA,
  url = NA,
  expires = NA,
  headers = NA,
  success_codes = NA,
  report = NA,
  etag = NA,
  auth = NA
)

Arguments

Method print()

Print method for Part class.

Usage

Part$print()

Examples

\dontrun{
 upload_part_object <- Part$new(
                        part_number = part_number,
                        part_size = part_size,
                        auth = auth
                      )

 # Print upload part information
 upload_part_object$print()
}

Method upload_info_part()

Get upload part info.

Usage

Part$upload_info_part(upload_id)

Arguments

Examples

\dontrun{
 upload_part_object <- Part$new(
                        part_number = part_number,
                        part_size = part_size,
                        auth = auth
                      )

 # Get upload part status information
 upload_part_object$upload_info_part(upload_id = upload_id)
}

Method upload_complete_part()

Report an uploaded part.

Usage

Part$upload_complete_part(upload_id)

Arguments

Examples

\dontrun{
 upload_part_object <- Part$new(
                        part_number = part_number,
                        part_size = part_size,
                        auth = auth
                      )

 # Report an uploaded part
 upload_part_object$upload_complete_part(upload_id = upload_id)
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Part$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Part$print`
## ------------------------------------------------

## Not run: 
 upload_part_object <- Part$new(
                        part_number = part_number,
                        part_size = part_size,
                        auth = auth
                      )

 # Print upload part information
 upload_part_object$print()

## End(Not run)

## ------------------------------------------------
## Method `Part$upload_info_part`
## ------------------------------------------------

## Not run: 
 upload_part_object <- Part$new(
                        part_number = part_number,
                        part_size = part_size,
                        auth = auth
                      )

 # Get upload part status information
 upload_part_object$upload_info_part(upload_id = upload_id)

## End(Not run)

## ------------------------------------------------
## Method `Part$upload_complete_part`
## ------------------------------------------------

## Not run: 
 upload_part_object <- Part$new(
                        part_number = part_number,
                        part_size = part_size,
                        auth = auth
                      )

 # Report an uploaded part
 upload_part_object$upload_complete_part(upload_id = upload_id)

## End(Not run)

R6 Class representing member's permissions

Description

R6 Class representing member's permissions.

Super class

sevenbridges2::Item -> Permission

Public fields

Methods

Public methods

• Permission$new()

• Permission$print()

• Permission$reload()

• Permission$clone()

Method new()

Create a new Permission object.

Usage

Permission$new(
  read = TRUE,
  copy = FALSE,
  write = FALSE,
  execute = FALSE,
  admin = FALSE,
  ...
)

Arguments

Method print()

Print method for Permission class.

Usage

Permission$print()

Examples

\dontrun{
 # x is API response when permission is requested
 permission_object <- Permission$new(
                    write = x$write,
                    read = x$read,
                    copy = x$copy,
                    execute = x$execute,
                    admin = x$admin,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )
 # Print permission object
 permission_object$print()
}

Method reload()

Reload Permission object information.

Usage

Permission$reload()

Examples

\dontrun{
 # x is API response when permission is requested
 permission_object <- Permission$new(
                    write = x$write,
                    read = x$read,
                    copy = x$copy,
                    execute = x$execute,
                    admin = x$admin,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload permission object
 permission_object$reload()
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Permission$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Permission$print`
## ------------------------------------------------

## Not run: 
 # x is API response when permission is requested
 permission_object <- Permission$new(
                    write = x$write,
                    read = x$read,
                    copy = x$copy,
                    execute = x$execute,
                    admin = x$admin,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )
 # Print permission object
 permission_object$print()

## End(Not run)


## ------------------------------------------------
## Method `Permission$reload`
## ------------------------------------------------

## Not run: 
 # x is API response when permission is requested
 permission_object <- Permission$new(
                    write = x$write,
                    read = x$read,
                    copy = x$copy,
                    execute = x$execute,
                    admin = x$admin,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload permission object
 permission_object$reload()

## End(Not run)

R6 Class representing a project.

Description

R6 Class representing a central resource for managing projects.

Super class

sevenbridges2::Item -> Project

Public fields

Methods

Public methods

• Project$new()

• Project$print()

• Project$detailed_print()

• Project$reload()

• Project$update()

• Project$delete()

• Project$list_members()

• Project$add_member()

• Project$remove_member()

• Project$get_member()

• Project$modify_member_permissions()

• Project$list_files()

• Project$create_folder()

• Project$get_root_folder()

• Project$list_apps()

• Project$create_app()

• Project$list_tasks()

• Project$list_imports()

• Project$create_task()

• Project$clone()

Method new()

Create a new Project object.

Usage

Project$new(res = NA, ...)

Arguments

Method print()

Basic print method for Project class.

Usage

Project$print()

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print project object
 project_object$print()
}

Method detailed_print()

Detailed print method for Project class.

Usage

Project$detailed_print()

Details

This method allows users to print all the fields from the Project object more descriptively.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print project object in detail
 project_object$detailed_print()
}

Method reload()

Reload Project object information.

Usage

Project$reload(...)

Arguments

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload project object
 project_object$reload()
}

Method update()

Method that allows you to edit an already existing project. As a project Admin you can use it to change the name, settings, tags or ⁠billing group⁠ of the project. Users with write permissions in the project can change the project description.

Usage

Project$update(
  name = NULL,
  description = NULL,
  billing_group = NULL,
  settings = NULL,
  tags = NULL,
  ...
)

Arguments

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Change project object name
 project_object$update(name = name)
}

Method 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.
Please be careful when using this method and note that calling it will permanently delete the project from the platform.

Usage

Project$delete()

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Delete project object
 project_object$delete()
}

Method list_members()

Method for listing all the project members.

Usage

Project$list_members(
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of Member objects.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List members in a project
 project_object$list_members()
}

Method add_member()

Method for adding new members to a specified project. The call can only be successfully made by a user who has admin permissions in the project.

Usage

Project$add_member(
  user = NULL,
  email = NULL,
  permissions = list(read = TRUE, copy = FALSE, write = FALSE, execute = FALSE, admin =
    FALSE)
)

Arguments

Returns

Member object.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Add member to a project
 project_object$add_member(
      user = "<username_of_a_user_you_want_to_add>",
      permissions = list(write = TRUE, execute = TRUE)
  )
}

Method remove_member()

A method for removing members from the project. It can only be successfully run by a user who has admin privileges in the project.

Usage

Project$remove_member(user)

Arguments

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Remove member from a project
 project_object$remove_member(user = user)
}

Method get_member()

This method returns the information about the member of the specified project.

Usage

Project$get_member(user, ...)

Arguments

Returns

Member object.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get member from a project
 project_object$get_member(user = user)
}

Method modify_member_permissions()

This method can be used to edit a user's permissions in a specified project. It can only be successfully made by a user who has admin permissions in the project.

Usage

Project$modify_member_permissions(
  user = NULL,
  permissions = list(read = TRUE, copy = FALSE, write = FALSE, execute = FALSE, admin =
    FALSE)
)

Arguments

Returns

Permission object.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Modify member permissions in a project
 project_object$modify_member_permissions(
                  user = user,
                  permission = list(read = TRUE, copy = FALSE)
                  )
}

Method list_files()

List all project's files and folders.

Usage

Project$list_files(
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of File objects.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List files in a project
 project_object$list_files()
}

Method create_folder()

Create a new folder under the project's root directory. Every project on the Seven Bridges Platform is represented by a root folder which contains all the files associated with a particular project. You can create first level folders within this root folder by using this function.

Usage

Project$create_folder(name)

Arguments

Returns

File object of type 'FOLDER'.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List files in a project
 project_object$create_folder(name = "new_folder")
}

Method get_root_folder()

Get project's root folder object

Usage

Project$get_root_folder()

Returns

File object of type 'FOLDER'.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get root folder in a project
 project_object$get_root_folder()
}

Method list_apps()

This call lists all apps in the project.

Usage

Project$list_apps(
  query_terms = NULL,
  id = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of App objects.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List apps in a project
 project_object$list_apps(query_terms = query_term)
}

Method create_app()

This call creates app in project.

Usage

Project$create_app(
  raw = NULL,
  from_path = NULL,
  name,
  raw_format = c("JSON", "YAML")
)

Arguments

Returns

App object.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Create app in a project
 project_object$create_app(raw = raw)
}

Method list_tasks()

This call lists all tasks from project you can access.
Read more about how to use query parameters properly here.

Usage

Project$list_tasks(
  status = NULL,
  parent = NULL,
  created_from = NULL,
  created_to = NULL,
  started_from = NULL,
  started_to = NULL,
  ended_from = NULL,
  ended_to = NULL,
  order_by = c("created_time", "start_time", "name", "end_time", "created_by"),
  order = c("asc", "desc"),
  origin_id = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of Task objects.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List tasks in a project
 project_object$list_tasks()
}

Method list_imports()

This call lists imports initiated by a particular user into this destination project.

Usage

Project$list_imports(
  volume = NULL,
  state = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of Import objects.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List import jobs in a project
 project_object$list_imports()
}

Method create_task()

This call creates a new task. You can create either a single task or a batch task by using the app's default batching, override batching, or disable batching completely. A parent task is a task that specifies criteria by which to batch its inputs into a series of further sub-tasks, called child tasks. See the documentation on batching tasks for more details on batching criteria.

Usage

Project$create_task(
  app,
  revision = NULL,
  name = NULL,
  description = NULL,
  execution_settings = NULL,
  inputs = NULL,
  output_location = NULL,
  batch = NULL,
  batch_input = NULL,
  batch_by = NULL,
  use_interruptible_instances = NULL,
  action = NULL,
  ...
)

Arguments

Returns

Task object.

Examples

\dontrun{
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Create a task in a project
 project_object$create_task(app = app)
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Project$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Project$print`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print project object
 project_object$print()

## End(Not run)


## ------------------------------------------------
## Method `Project$detailed_print`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print project object in detail
 project_object$detailed_print()

## End(Not run)


## ------------------------------------------------
## Method `Project$reload`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload project object
 project_object$reload()

## End(Not run)


## ------------------------------------------------
## Method `Project$update`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Change project object name
 project_object$update(name = name)

## End(Not run)


## ------------------------------------------------
## Method `Project$delete`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Delete project object
 project_object$delete()

## End(Not run)


## ------------------------------------------------
## Method `Project$list_members`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List members in a project
 project_object$list_members()

## End(Not run)


## ------------------------------------------------
## Method `Project$add_member`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Add member to a project
 project_object$add_member(
      user = "<username_of_a_user_you_want_to_add>",
      permissions = list(write = TRUE, execute = TRUE)
  )

## End(Not run)


## ------------------------------------------------
## Method `Project$remove_member`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Remove member from a project
 project_object$remove_member(user = user)

## End(Not run)


## ------------------------------------------------
## Method `Project$get_member`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get member from a project
 project_object$get_member(user = user)

## End(Not run)


## ------------------------------------------------
## Method `Project$modify_member_permissions`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Modify member permissions in a project
 project_object$modify_member_permissions(
                  user = user,
                  permission = list(read = TRUE, copy = FALSE)
                  )

## End(Not run)


## ------------------------------------------------
## Method `Project$list_files`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List files in a project
 project_object$list_files()

## End(Not run)


## ------------------------------------------------
## Method `Project$create_folder`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List files in a project
 project_object$create_folder(name = "new_folder")

## End(Not run)


## ------------------------------------------------
## Method `Project$get_root_folder`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get root folder in a project
 project_object$get_root_folder()

## End(Not run)


## ------------------------------------------------
## Method `Project$list_apps`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List apps in a project
 project_object$list_apps(query_terms = query_term)

## End(Not run)


## ------------------------------------------------
## Method `Project$create_app`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Create app in a project
 project_object$create_app(raw = raw)

## End(Not run)


## ------------------------------------------------
## Method `Project$list_tasks`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List tasks in a project
 project_object$list_tasks()

## End(Not run)


## ------------------------------------------------
## Method `Project$list_imports`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List import jobs in a project
 project_object$list_imports()

## End(Not run)


## ------------------------------------------------
## Method `Project$create_task`
## ------------------------------------------------

## Not run: 
 # x is API response when project is requested
 project_object <- Project$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Create a task in a project
 project_object$create_task(app = app)

## End(Not run)

R6 Class representing projects endpoints.

Description

R6 Class representing a Projects resource.

Super class

sevenbridges2::Resource -> Projects

Public fields

Methods

Public methods

• Projects$new()

• Projects$query()

• Projects$get()

• Projects$delete()

• Projects$create()

• Projects$clone()

Method new()

Create new Projects resource object.

Usage

Projects$new(...)

Arguments

Method 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.

Usage

Projects$query(
  name = NULL,
  owner = NULL,
  tags = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of Project objects.

Examples

\dontrun{
 projects_object <- Projects$new(auth = auth)

 # Query projects
 projects_object$query(name = name)
}

Method get()

This call creates a Project object containing the details of a specified project.

Usage

Projects$get(id, ...)

Arguments

Returns

Project object.

Examples

\dontrun{
 projects_object <- Projects$new(auth = auth)

 # Get project by id
 projects_object$get(id = id)
}

Method 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.

Usage

Projects$delete(project, ...)

Arguments

Examples

\dontrun{
 projects_object <- Projects$new(auth = auth)

 # Delete a project
 projects_object$delete(project = project)
}

Method create()

A method for creating a new project.

Usage

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),
  ...
)

Arguments

Returns

Project object.

Examples

\dontrun{
 projects_object <- Projects$new(auth = auth)

 # Create a project
 projects_object$create(
                    name = name,
                    billing_group = billing_group,
                    description = description
                  )
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Projects$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## 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)

R6 Class Representing a Rate Limit for a user

Description

Rate object containing information about user's rate limit.

Details

This is the main object for Rate Limit.

Super class

sevenbridges2::Item -> Rate

Public fields

Methods

Public methods

• Rate$new()

• Rate$print()

• Rate$clone()

Method new()

Create a new Rate limit object.

Usage

Rate$new(res = NA, ...)

Arguments

Method print()

Print rate limit information as a bullet list.

Usage

Rate$print()

Method clone()

The objects of this class are cloneable with this method.

Usage

Rate$clone(deep = FALSE)

Arguments

R6 Class Representing a Resource

Description

Base class for describing a resource.

Details

This is a base class for describing a resource on the platform: Projects, Tasks, Volumes, Files, Apps etc.

Public fields

Methods

Public methods

• Resource$new()

• Resource$query()

• Resource$get()

• Resource$delete()

• Resource$clone()

Method new()

Create a new Resource object.

Usage

Resource$new(auth = NA)

Arguments

Method query()

Generic query implementation that is used by the resources.

Usage

Resource$query(...)

Arguments

Method get()

Generic get implementation that fetches a single resource from the server.

Usage

Resource$get(cls, id, ...)

Arguments

Method delete()

Generic implementation to delete a resource from the server.

Usage

Resource$delete(id, ...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

Resource$clone(deep = FALSE)

Arguments

R6 Class representing a Task

Description

R6 Class representing a resource for managing tasks.

Super class

sevenbridges2::Item -> Task

Public fields

Methods

Public methods

• Task$new()

• Task$print()

• Task$reload()

• Task$run()

• Task$abort()

• Task$clone_task()

• Task$get_execution_details()

• Task$list_batch_children()

• Task$delete()

• Task$rerun()

• Task$update()

• Task$clone()

Method new()

Create new Task object.

Usage

Task$new(res = NA, ...)

Arguments

Method print()

Print method for Task class.

Usage

Task$print()

Examples

\dontrun{
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print task object
 task_object$print()
}

Method reload()

Reload Task object information.

Usage

Task$reload(...)

Arguments

Returns

Task object.

Examples

\dontrun{
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload task object
 task_object$reload()
}

Method run()

This call runs (executes) the task. Only tasks whose status is DRAFT can be run.

Usage

Task$run(
  batch = NULL,
  use_interruptible_instances = NULL,
  in_place = TRUE,
  ...
)

Arguments

Returns

Task object.

Examples

\dontrun{
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Run task
 task_object$run()
}

Method abort()

This call aborts the specified task. Only tasks whose status is RUNNING or QUEUED may be aborted.

Usage

Task$abort(in_place = TRUE, ...)

Arguments

Returns

Task object.

Examples

\dontrun{
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

. # Run task
 task_object$run()

 # Then abort task
 task_object$abort()
}

Method clone_task()

This call clones the specified task. Once cloned, the task can either be in DRAFT mode or immediately ran, by setting the run parameter to TRUE.

Usage

Task$clone_task(run = FALSE, ...)

Arguments

Returns

Task object.

Examples

\dontrun{
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Clone task object
 task_object$clone_task()
}

Method get_execution_details()

This call returns execution details of the specified task. The task is referred to by its ID, which you can obtain by making the call to list all tasks you can access. The call breaks down the information into the task's distinct jobs. A job is a single subprocess carried out in a task. The information returned by this call is broadly similar to that which can be found in the task stats and logs provided on the Platform. The task execution details include the following information:

• The name of the command line job that executed

• The start time of the job

• End time of the job (if it completed)

• The status of the job (DONE, FAILED, or RUNNING)

• Information on the computational instance that the job was run on, including the provider ID, the type of instance used and the cloud service provider

• A link that can be used to download the standard error logs for the job.

• SHA hash of the Docker image ('checksum').

Usage

Task$get_execution_details(...)

Arguments

Returns

List of execution details.

Examples

\dontrun{
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get task execution details
 task_object$get_execution_details()
}

Method list_batch_children()

This call retrieves batch child tasks for this task if its a batch task.

Usage

Task$list_batch_children(
  status = NULL,
  project = NULL,
  created_from = NULL,
  created_to = NULL,
  started_from = NULL,
  started_to = NULL,
  ended_from = NULL,
  ended_to = NULL,
  order_by = NULL,
  order = NULL,
  origin_id = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of Task objects.

Examples

\dontrun{
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List batch children of a task
 task_object$list_batch_children()
}

Method delete()

This call deletes the specified task. The task is referred to by its ID, which you can obtain by making the call to list all tasks you can access.

Usage

Task$delete(...)

Arguments

Examples

\dontrun{
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Delete task
 task_object$delete()
}

Method rerun()

This call reruns (executes) the specified task.

Usage

Task$rerun(...)

Arguments

Returns

Task object.

Examples

\dontrun{
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Rerun task
 task_object$rerun()
}

Method update()

Change the details of the specified task, including its name, description, and inputs. Note that you can only modify tasks with a task status of DRAFT. Tasks which are RUNNING, QUEUED, ABORTED, COMPLETED or FAILED cannot be modified in order to enable the reproducibility of analyses which have been queued for execution or has initiated executing. There are two things to note if you are editing a batch task:

• 1 If you want to change the input on which to batch and the batch criteria, you need to specify the batch_input and batch_by parameters together in the same function call.

• 2 If you want to disable batching on a task, set batch to false. Or, you can also set the parameters batch_input and batch_by to NULL.

Usage

Task$update(
  name = NULL,
  description = NULL,
  execution_settings = NULL,
  inputs = NULL,
  output_location = NULL,
  batch = NULL,
  batch_input = NULL,
  batch_by = NULL,
  ...
)

Arguments

Returns

Task object.

Examples

\dontrun{
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Update task
 task_object$update(name = new_name)
}

Method clone()

The objects of this class are cloneable with this method.

Usage

Task$clone(deep = FALSE)

Arguments

Examples

## ------------------------------------------------
## Method `Task$print`
## ------------------------------------------------

## Not run: 
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print task object
 task_object$print()

## End(Not run)


## ------------------------------------------------
## Method `Task$reload`
## ------------------------------------------------

## Not run: 
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload task object
 task_object$reload()

## End(Not run)


## ------------------------------------------------
## Method `Task$run`
## ------------------------------------------------

## Not run: 
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Run task
 task_object$run()

## End(Not run)


## ------------------------------------------------
## Method `Task$abort`
## ------------------------------------------------

## Not run: 
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

. # Run task
 task_object$run()

 # Then abort task
 task_object$abort()

## End(Not run)


## ------------------------------------------------
## Method `Task$clone_task`
## ------------------------------------------------

## Not run: 
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Clone task object
 task_object$clone_task()

## End(Not run)


## ------------------------------------------------
## Method `Task$get_execution_details`
## ------------------------------------------------

## Not run: 
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Get task execution details
 task_object$get_execution_details()

## End(Not run)


## ------------------------------------------------
## Method `Task$list_batch_children`
## ------------------------------------------------

## Not run: 
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # List batch children of a task
 task_object$list_batch_children()

## End(Not run)


## ------------------------------------------------
## Method `Task$delete`
## ------------------------------------------------

## Not run: 
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Delete task
 task_object$delete()

## End(Not run)


## ------------------------------------------------
## Method `Task$rerun`
## ------------------------------------------------

## Not run: 
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Rerun task
 task_object$rerun()

## End(Not run)


## ------------------------------------------------
## Method `Task$update`
## ------------------------------------------------

## Not run: 
# x is API response when task is requested
task_object <- Task$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Update task
 task_object$update(name = new_name)

## End(Not run)

R6 Class representing tasks endpoints

Description

R6 Class representing tasks resource endpoints.

Super class

sevenbridges2::Resource -> Tasks

Public fields

Methods

Public methods

• Tasks$new()

• Tasks$query()

• Tasks$get()

• Tasks$delete()

• Tasks$create()

• Tasks$bulk_get()

• Tasks$clone()

Method new()

Create new Tasks resource object.

Usage

Tasks$new(...)

Arguments

Method query()

This call lists all tasks you can access.

Read more about how to use query parameters properly here.

Usage

Tasks$query(
  status = NULL,
  parent = NULL,
  project = NULL,
  created_from = NULL,
  created_to = NULL,
  started_from = NULL,
  started_to = NULL,
  ended_from = NULL,
  ended_to = NULL,
  order_by = c("created_time", "start_time", "name", "end_time", "created_by"),
  order = c("asc", "desc"),
  origin_id = NULL,
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)

Arguments

Returns

Collection of Task objects.

Method get()

This call returns details of the specified task. The task is referred to by its ID, which you can obtain by making the call to list all tasks you can access. The task details include its creator, its start and end time, the number of jobs completed in it, and its input and output files. You can also see the status of the task.

Usage

Tasks$get(id, ...)

Arguments

Returns

Task object.

Method delete()

Tasks are identified by their IDs, which can be obtained using Tasks$query() to list tasks or Tasks$get() to retrieve a single task.

Usage

Tasks$delete(task, ...)

Arguments

Method create()

This call creates a new task. You can create either a single task or a batch task by using the app's default batching, override batching, or disable batching completely. A parent task is a task that specifies criteria by which to batch its inputs into a series of further sub-tasks, called child tasks. the documentation on batching tasks for more details on batching criteria.

Usage

Tasks$create(
  project,
  app,
  revision = NULL,
  name = NULL,
  description = NULL,
  execution_settings = NULL,
  inputs = NULL,
  output_location = NULL,
  batch = NULL,
  batch_input = NULL,
  batch_by = NULL,
  use_interruptible_instances = NULL,
  action = NULL,
  ...
)

Arguments