ArrayTasksApi: ArrayTasks operations

In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package

ArrayTasks operations

Description

tiledbcloud.ArrayTasks

Format

An R6Class generator object

Methods

GetArrayTasksSidebar

• @param start integer

• @param end integer

• @returnType ArrayTaskBrowserSidebar
  

• status code : 200 | sidebar metadata for task definitions for all arrays user has access to

• return type : ArrayTaskBrowserSidebar

• response headers :

• status code : 404 | array tasks not found

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• ArrayTasksApi$new()

• ArrayTasksApi$GetArrayTasksSidebar()

• ArrayTasksApi$GetArrayTasksSidebarWithHttpInfo()

• ArrayTasksApi$clone()

---

Method new()

Usage

ArrayTasksApi$new(apiClient)

---

Method GetArrayTasksSidebar()

Usage

ArrayTasksApi$GetArrayTasksSidebar(start = NULL, end = NULL, ...)

---

Method GetArrayTasksSidebarWithHttpInfo()

Usage

ArrayTasksApi$GetArrayTasksSidebarWithHttpInfo(start = NULL, end = NULL, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayTasksApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  GetArrayTasksSidebar  ####################

library(tiledbcloud)
var.start <- 56 # integer | Fetch tasks created after this time, unix epoch in seconds, default 7 days ago
var.end <- 56 # integer | Fetch tasks created before this time, unix epoch in seconds, default now

api.instance <- ArrayTasksApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetArrayTasksSidebar(start=var.start, end=var.end)



## End(Not run)

TileDB-Inc/TileDB-Cloud-R documentation built on July 18, 2024, 3:33 p.m.