Skip to contents

Tasks operations

Source: R/tasks_api.R
TasksApi.Rd

tiledbcloud.Tasks

Format

An R6Class generator object

Methods

RunSQL Run a sql query @param namespace character @param sql SQLParameters @param accept.encoding character status code : 200 | JSON results in array of objects form, if the query returns results return type : array[object] response headers :
X-TILEDB-CLOUD-TASK-IDTask ID for just completed request
status code : 204 | SQL executed successfully response headers :
X-TILEDB-CLOUD-TASK-IDTask ID for just completed request
status code : 0 | error response return type : Error response headers :
TaskIdGet Fetch an array task @param id character @returnType ArrayTask
status code : 200 | Array task return type : ArrayTask response headers :
status code : 0 | error response return type : Error response headers :
TaskIdResultGet Retrieve results of an array task @param id character @param accept.encoding character status code : 200 | output and format of originating request return type : character response headers :
Content-Typeformat results are delivered in
status code : 202 | task is still executing response headers :
status code : 404 | results were not saved, or results have expored return type : Error response headers :
status code : 0 | error response return type : Error response headers :
TasksGet Fetch a list of all array tasks a user has access to @param namespace character @param created.by character @param array character @param start integer @param end integer @param page integer @param per.page integer @param type character @param exclude.type list( character ) @param file.type list( character ) @param exclude.file.type list( character ) @param status character @param search character @param orderby character @returnType ArrayTaskData
status code : 200 | Array of all tasks user has access too return type : ArrayTaskData response headers :
status code : 0 | error response return type : Error response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

Method new()

Usage

TasksApi$new(apiClient)

Method RunSQL()

Usage

TasksApi$RunSQL(namespace, sql, accept.encoding = NULL, ...)

Method RunSQLWithHttpInfo()

Usage

TasksApi$RunSQLWithHttpInfo(namespace, sql, accept.encoding = NULL, ...)

Method TaskIdGet()

Usage

TasksApi$TaskIdGet(id, ...)

Method TaskIdGetWithHttpInfo()

Usage

TasksApi$TaskIdGetWithHttpInfo(id, ...)

Method TaskIdResultGet()

Usage

TasksApi$TaskIdResultGet(id, accept.encoding = NULL, ...)

Method TaskIdResultGetWithHttpInfo()

Usage

TasksApi$TaskIdResultGetWithHttpInfo(id, accept.encoding = NULL, ...)

Method TasksGet()

Usage

TasksApi$TasksGet(
  namespace = NULL,
  created.by = NULL,
  array = NULL,
  start = NULL,
  end = NULL,
  page = NULL,
  per.page = NULL,
  type = NULL,
  exclude.type = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  status = NULL,
  search = NULL,
  orderby = NULL,
  ...
)

Method TasksGetWithHttpInfo()

Usage

TasksApi$TasksGetWithHttpInfo(
  namespace = NULL,
  created.by = NULL,
  array = NULL,
  start = NULL,
  end = NULL,
  page = NULL,
  per.page = NULL,
  type = NULL,
  exclude.type = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  status = NULL,
  search = NULL,
  orderby = NULL,
  ...
)

Method clone()

The objects of this class are cloneable with this method.

Usage

TasksApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples