TasksApi: Tasks operations
In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package
TasksApi R Documentation
Tasks operations
Description
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-ID Task ID for just completed request
status code : 204 | SQL executed successfully
response headers :
X-TILEDB-CLOUD-TASK-ID Task 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-Type format 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
apiClientHandles 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
deepWhether to make a deep clone.
Examples
## Not run:
#################### RunSQL ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace to run task under is in (an organization name or user's username)
var.sql <- SQLParameters$new() # SQLParameters | sql being submitted
var.accept.encoding <- 'accept.encoding_example' # character | Encoding to use
api.instance <- TasksApi$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$RunSQL(var.namespace, var.sql, accept.encoding=var.accept.encoding)
#################### TaskIdGet ####################
library(tiledbcloud)
var.id <- 'id_example' # character | task ID to fetch
api.instance <- TasksApi$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$TaskIdGet(var.id)
#################### TaskIdResultGet ####################
library(tiledbcloud)
var.id <- 'id_example' # character | task ID to retrieve stored results
var.accept.encoding <- 'accept.encoding_example' # character | Encoding to use
api.instance <- TasksApi$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$TaskIdResultGet(var.id, accept.encoding=var.accept.encoding)
#################### TasksGet ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace to filter
var.created.by <- 'created.by_example' # character | username to filter
var.array <- 'array_example' # character | name/uri of array that is url-encoded to filter
var.start <- 56 # integer | start time for tasks to filter by
var.end <- 56 # integer | end time for tasks to filter by
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.type <- 'type_example' # character | task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\"
var.exclude.type <- ['exclude.type_example'] # array[character] | task_type to exclude matching array in results, more than one can be included
var.file.type <- ['file.type_example'] # array[character] | match file_type of task array, more than one can be included
var.exclude.file.type <- ['exclude.file.type_example'] # array[character] | exclude file_type of task arrays, more than one can be included
var.status <- 'status_example' # character | Filter to only return these statuses
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.orderby <- 'orderby_example' # character | sort by which field valid values include start_time, name
api.instance <- TasksApi$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$TasksGet(namespace=var.namespace, created.by=var.created.by, array=var.array, start=var.start, end=var.end, page=var.page, per.page=var.per.page, type=var.type, exclude.type=var.exclude.type, file.type=var.file.type, exclude.file.type=var.exclude.file.type, status=var.status, search=var.search, orderby=var.orderby)
## End(Not run)
TileDB-Inc/TileDB-Cloud-R documentation built on July 18, 2024, 3:33 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| TasksApi | R Documentation |
Tasks operations
Description
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-ID Task ID for just completed request status code : 204 | SQL executed successfully
response headers :
X-TILEDB-CLOUD-TASK-ID Task 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-Type format 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
apiClientHandles 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
deepWhether to make a deep clone.
Examples
## Not run:
#################### RunSQL ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace to run task under is in (an organization name or user's username)
var.sql <- SQLParameters$new() # SQLParameters | sql being submitted
var.accept.encoding <- 'accept.encoding_example' # character | Encoding to use
api.instance <- TasksApi$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$RunSQL(var.namespace, var.sql, accept.encoding=var.accept.encoding)
#################### TaskIdGet ####################
library(tiledbcloud)
var.id <- 'id_example' # character | task ID to fetch
api.instance <- TasksApi$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$TaskIdGet(var.id)
#################### TaskIdResultGet ####################
library(tiledbcloud)
var.id <- 'id_example' # character | task ID to retrieve stored results
var.accept.encoding <- 'accept.encoding_example' # character | Encoding to use
api.instance <- TasksApi$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$TaskIdResultGet(var.id, accept.encoding=var.accept.encoding)
#################### TasksGet ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace to filter
var.created.by <- 'created.by_example' # character | username to filter
var.array <- 'array_example' # character | name/uri of array that is url-encoded to filter
var.start <- 56 # integer | start time for tasks to filter by
var.end <- 56 # integer | end time for tasks to filter by
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.type <- 'type_example' # character | task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\"
var.exclude.type <- ['exclude.type_example'] # array[character] | task_type to exclude matching array in results, more than one can be included
var.file.type <- ['file.type_example'] # array[character] | match file_type of task array, more than one can be included
var.exclude.file.type <- ['exclude.file.type_example'] # array[character] | exclude file_type of task arrays, more than one can be included
var.status <- 'status_example' # character | Filter to only return these statuses
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.orderby <- 'orderby_example' # character | sort by which field valid values include start_time, name
api.instance <- TasksApi$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$TasksGet(namespace=var.namespace, created.by=var.created.by, array=var.array, start=var.start, end=var.end, page=var.page, per.page=var.per.page, type=var.type, exclude.type=var.exclude.type, file.type=var.file.type, exclude.file.type=var.exclude.file.type, status=var.status, search=var.search, orderby=var.orderby)
## End(Not run)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.