sbgr (version 1.0.0)

task_details: Returns information about the task

Description

Returns information about the task.

Usage

task_details(auth_token = NULL, project_id = NULL, task_id = NULL, download.url = FALSE, ...)

Arguments

auth_token

auth token

project_id

ID of a project you want to access.

task_id

ID of a task you want to access.

download.url

Logical. Return the download URL or not.

...

parameters passed to sbgapi function

Value

parsed list of the returned json

Details

Each task has a status and status message, containing the more detailed information about the task status, associated with it. This is a list of all values that task status can have:

• active - Task is currently running.
• completed - Task has finished successfully.
• aborted - Task was aborted by user.
• failed - Task has failed to finish due to either bad inputs and/or parameters, or because of the internal infrastructure failures.

Examples

token = '420b4672ebfc43bab48dc0d18a32fb6f'
req1 = task_details(token,
                 project_id = '1c1d06d2-5862-48f6-b595-e0099b20937e',
                 task_id = '22237')
req2 = task_details(token,
       project_id = '1c1d06d2-5862-48f6-b595-e0099b20937e',
       task_id = '22237', download.url = TRUE)