Title: | TileDB Cloud Platform R Client Package |
---|---|
Description: | The TileDB Cloud Platform API Client Package offers access to the TileDB Cloud service. |
Authors: | TileDB, Inc. [aut, cph], OpenAPI Generator community [ctb], John Kerl [cre] |
Maintainer: | John Kerl <[email protected]> |
License: | MIT + file LICENSE |
Version: | 0.0.11 |
Built: | 2024-10-07 05:50:19 UTC |
Source: | https://github.com/TileDB-Inc/TileDB-Cloud-R |
This is a package-internal function for code-deduplication within various manual-layer functions.
.get_decoded_response_body_or_stop( resultObject, result_format, entire_json_is_result = FALSE )
.get_decoded_response_body_or_stop( resultObject, result_format, entire_json_is_result = FALSE )
resultObject |
Should be a return value from an API function which uses
|
entire_json_is_result |
If false, return the |
It wraps .get_raw_response_body_or_stop
by decoding
the raw response body using any of the three result-format types
we support for UDFs. It's a keystroke-saving wrapper around
.get_raw_response_body_or_stop
.
The argument, decoded according to the specified result format.
This is a package-internal function for code-deduplication within various manual-layer functions.
.get_empty_response_body_or_stop(resultObject)
.get_empty_response_body_or_stop(resultObject)
resultObject |
Should be a return value from an API function which uses
|
This wraps .get_raw_response_body_or_stop
, doing stop
if there is an API-response error, or if the response is not the empty string.
This is for API functions where the expected response is the empty string.
Invisible on success, or stop()
on failure.
This is a package-internal function for code-deduplication within various manual-layer functions.
.get_raw_response_body_or_stop(resultObject)
.get_raw_response_body_or_stop(resultObject)
resultObject |
Should be a return value from an API function which uses
|
For the API-level functions which use .wrap_as_api_response
,
manual-layer functions will receive either (a) the raw HTTP body,
if the status_code
was 2xx, or (b) an ApiResponse
object. Using this function, callsites can get the HTTP body (if
available), else an informative stop()
.
The argument, as long as it's of type raw
. Else, stops. The
caller can then decode the raw body.
Used for overriding the OpenAPI-autogenerated HTTP-response handling.
.wrap_as_api_response(resp)
.wrap_as_api_response(resp)
resp |
A |
Makes the handling compatible with TileDB REST-server response format; surfaces error messages back to the user. Not intended to be exported from this package; for package-internal use only.
An object of type ApiResponse
. In the success case (HTTP 2xx)
its content
slot is the raw HTTP body. In the failure case (otherwise)
its content
slot is error-text from the server.
ActivityEventType Class
An R6Class
generator object
new()
ActivityEventType$new(...)
toJSON()
ActivityEventType$toJSON()
fromJSON()
ActivityEventType$fromJSON(ActivityEventTypeJson)
toJSONString()
ActivityEventType$toJSONString()
fromJSONString()
ActivityEventType$fromJSONString(ActivityEventTypeJson)
clone()
The objects of this class are cloneable with this method.
ActivityEventType$clone(deep = FALSE)
deep
Whether to make a deep clone.
ApiClient Class
An R6Class
generator object
ApiClient Class
Generic API client for OpenAPI client library builds. OpenAPI generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the OpenAPI Generator templates.
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). Ref: https://openapi-generator.tech Do not edit the class manually.
basePath
Base url
userAgent
Default user agent
username
Username for HTTP basic authentication
password
Password for HTTP basic authentication
timeout
Default timeout in seconds
retryStatusCodes
vector of status codes to retry
maxRetryAttempts
maximum number of retries for the status codes
new()
ApiClient$new( basePath = NULL, userAgent = NULL, defaultHeaders = NULL, username = NULL, password = NULL, apiKeys = NULL, accessToken = NULL, timeout = NULL, retryStatusCodes = NULL, maxRetryAttempts = NULL )
CallApi()
ApiClient$CallApi(url, method, queryParams, headerParams, body, ...)
ExecuteWrapped()
ApiClient$ExecuteWrapped(url, method, queryParams, headerParams, body, ...)
Execute()
ApiClient$Execute(url, method, queryParams, headerParams, body, ...)
deserialize()
ApiClient$deserialize(resp, returnType, pkgEnv)
deserializeObj()
ApiClient$deserializeObj(obj, returnType, pkgEnv)
clone()
The objects of this class are cloneable with this method.
ApiClient$clone(deep = FALSE)
deep
Whether to make a deep clone.
ApiResponse Class
An R6Class
generator object
content
The deserialized response body.
response
The raw response from the endpoint.
new()
ApiResponse$new(content, response)
clone()
The objects of this class are cloneable with this method.
ApiResponse$clone(deep = FALSE)
deep
Whether to make a deep clone.
Array Class
An R6Class
generator object
timestamp
numeric
queryType
uri
character
new()
Array$new(timestamp, queryType, uri, ...)
toJSON()
Array$toJSON()
fromJSON()
Array$fromJSON(ArrayJson)
toJSONString()
Array$toJSONString()
fromJSONString()
Array$fromJSONString(ArrayJson)
clone()
The objects of this class are cloneable with this method.
Array$clone(deep = FALSE)
deep
Whether to make a deep clone.
This function shows array information on TileDB Cloud.
array_info(namespace, arrayname)
array_info(namespace, arrayname)
namespace |
Like "TileDB-Inc" |
arrayname |
Like "quickstart_dense" |
Nominally you will first call login
; if not, the results of
the last login at ~/.tiledb/cloud.json
will be used.
A list of array properties
Other manual-layer functions:
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
ArrayActions Class
An R6Class
generator object
new()
ArrayActions$new(...)
toJSON()
ArrayActions$toJSON()
fromJSON()
ArrayActions$fromJSON(ArrayActionsJson)
toJSONString()
ArrayActions$toJSONString()
fromJSONString()
ArrayActions$fromJSONString(ArrayActionsJson)
clone()
The objects of this class are cloneable with this method.
ArrayActions$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayActivityLog Class
An R6Class
generator object
event_at
character [optional]
action
ActivityEventType [optional]
username
character [optional]
bytes_sent
integer [optional]
bytes_received
integer [optional]
array_task_id
character [optional]
id
character [optional]
query_ranges
character [optional]
query_stats
character [optional]
new()
ArrayActivityLog$new( event_at = NULL, action = NULL, username = NULL, bytes_sent = NULL, bytes_received = NULL, array_task_id = NULL, id = NULL, query_ranges = NULL, query_stats = NULL, ... )
toJSON()
ArrayActivityLog$toJSON()
fromJSON()
ArrayActivityLog$fromJSON(ArrayActivityLogJson)
toJSONString()
ArrayActivityLog$toJSONString()
fromJSONString()
ArrayActivityLog$fromJSONString(ArrayActivityLogJson)
clone()
The objects of this class are cloneable with this method.
ArrayActivityLog$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.Array
An R6Class
generator object
ArrayActivityLog get array activity logs
@param namespace character
@param array character
@param start integer
@param end integer
@param event.types character
@param task.id character
@param has.task.id character
@returnType list( ArrayActivityLog )
status code : 200 | log of array activity
return type : array[ArrayActivityLog]
response headers :
status code : 0 | error response
return type : Error
response headers :
ArraysBrowserOwnedGet Fetch a list of all arrays that are owned directly by user or user's organizations
@param page integer
@param per.page integer
@param search character
@param namespace character
@param orderby character
@param permissions character
@param tag list( character )
@param exclude.tag list( character )
@param file.type list( character )
@param exclude.file.type list( character )
@param file.property list( character )
@returnType ArrayBrowserData
status code : 200 | Array of array info that are owned directly by user or user's organizations
return type : ArrayBrowserData
response headers :
status code : 0 | error response
return type : Error
response headers :
ArraysBrowserOwnedSidebarGet Fetch a sidebar for arrays that are owned directly by user or user's organizations
@returnType ArrayBrowserSidebar
status code : 200 | Array of array info that are owned directly by user or user's organizations
return type : ArrayBrowserSidebar
response headers :
status code : 0 | error response
return type : Error
response headers :
ArraysBrowserPublicGet Fetch a list of all arrays that have been shared publically
@param page integer
@param per.page integer
@param search character
@param namespace character
@param orderby character
@param permissions character
@param tag list( character )
@param exclude.tag list( character )
@param file.type list( character )
@param exclude.file.type list( character )
@param file.property list( character )
@returnType ArrayBrowserData
status code : 200 | Array of array info that has been shared publically
return type : ArrayBrowserData
response headers :
status code : 0 | error response
return type : Error
response headers :
ArraysBrowserPublicSidebarGet Fetch a sidebar of all arrays that have been shared publically
@returnType ArrayBrowserSidebar
status code : 200 | Array of array info that has been shared publically
return type : ArrayBrowserSidebar
response headers :
status code : 0 | error response
return type : Error
response headers :
ArraysBrowserSharedGet Fetch a list of all arrays that have been shared with the user
@param page integer
@param per.page integer
@param search character
@param namespace character
@param orderby character
@param permissions character
@param tag list( character )
@param exclude.tag list( character )
@param file.type list( character )
@param exclude.file.type list( character )
@param file.property list( character )
@returnType ArrayBrowserData
status code : 200 | Array of array info that has been shared with the user
return type : ArrayBrowserData
response headers :
status code : 0 | error response
return type : Error
response headers :
ArraysBrowserSharedSidebarGet Fetch a list of all arrays that have been shared with the user
@returnType ArrayBrowserSidebar
status code : 200 | Array of array info that has been shared with the user
return type : ArrayBrowserSidebar
response headers :
status code : 0 | error response
return type : Error
response headers :
ArraysNamespaceArrayEndTimestampsGet retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated
@param namespace character
@param array character
@param page integer
@param per.page integer
@returnType ArrayEndTimestampData
status code : 200 | list of timestamps in milliseconds, paginated
return type : ArrayEndTimestampData
response headers :
status code : 0 | error response
return type : Error
response headers :
ConsolidateArray consolidate an array at a specified URI
@param namespace character
@param array character
@param tiledb.config TileDBConfig
status code : 204 | array consolidated successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
CreateArray create a array schema at a specified URI registered to a group/project
@param namespace character
@param array character
@param content.type character
@param array.schema ArraySchema
@param X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME character
status code : 204 | schema created successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteArray delete a array
@param namespace character
@param array character
@param content.type character
status code : 204 | delete array successful
response headers :
status code : 0 | error response
return type : Error
response headers :
DeregisterArray deregister a array
@param namespace character
@param array character
status code : 204 | deregistered array successful
response headers :
status code : 0 | error response
return type : Error
response headers :
GetActivityLogById get activity log by ID
@param namespace character
@param array character
@param id character
@returnType ArrayActivityLog
status code : 200 | array activity
return type : ArrayActivityLog
response headers :
status code : 0 | error response
return type : Error
response headers :
GetAllArrayMetadata get all array metadata user has access to
@param public.share character
@returnType list( ArrayInfo )
status code : 200 | array metadata for all arrays user has access to
return type : array[ArrayInfo]
response headers :
status code : 0 | error response
return type : Error
response headers :
GetArray get an ArraySchema using a url encoded uri
@param namespace character
@param array character
@param content.type character
@returnType ArraySchema
status code : 200 | get ArraySchema
return type : ArraySchema
response headers :
status code : 0 | error response
return type : Error
response headers :
GetArrayMaxBufferSizes get the max buffer sizes of an array for a subarray
@param namespace character
@param array character
@param subarray character
@param content.type character
@param x.payer character
@returnType MaxBufferSizes
status code : 200 | get the max buffer sizes of an array for a subarray
return type : MaxBufferSizes
response headers :
status code : 0 | error response
return type : Error
response headers :
GetArrayMetaDataJson get metadata from the array in JSON format
@param namespace character
@param array character
@param length integer
@param end.timestamp integer
status code : 200 | get array metadata
return type : object
response headers :
status code : 0 | error response
return type : Error
response headers :
GetArrayMetadata get metadata on an array
@param namespace character
@param array character
@returnType ArrayInfo
status code : 200 | array metadata for an array
return type : ArrayInfo
response headers :
status code : 0 | error response
return type : Error
response headers :
GetArrayMetadataCapnp get metadata on an array
@param namespace character
@param array character
@returnType ArrayMetadata
status code : 200 | array metadata for an array
return type : ArrayMetadata
response headers :
status code : 0 | error response
return type : Error
response headers :
GetArrayNonEmptyDomain get the non empty domain of an array
@param namespace character
@param array character
@param content.type character
@param x.payer character
@returnType NonEmptyDomain
status code : 200 | get the non empty domain of an array
return type : NonEmptyDomain
response headers :
status code : 0 | error response
return type : Error
response headers :
GetArrayNonEmptyDomainJson get non-empty domain from the array in json format
@param namespace character
@param array character
status code : 200 | get array non-empty domaim
return type : object
response headers :
status code : 0 | error response
return type : Error
response headers :
GetArraySampleData get an sample set of data from the array
@param namespace character
@param array character
@param samples numeric
@returnType ArraySample
status code : 200 | get array sample data
return type : ArraySample
response headers :
status code : 0 | error response
return type : Error
response headers :
GetArraySharingPolicies Get all sharing details of the array
@param namespace character
@param array character
@returnType list( ArraySharing )
status code : 200 | List of all specific sharing policies
return type : array[ArraySharing]
response headers :
status code : 404 | Array does not exist or user does not have permissions to view array-sharing policies
response headers :
status code : 0 | error response
return type : Error
response headers :
GetArraysInNamespace get metadata on all arrays in a namespace
@param namespace character
@returnType list( ArrayInfo )
status code : 200 | array metadata for all arrays in a namespace
return type : array[ArrayInfo]
response headers :
status code : 0 | error response
return type : Error
response headers :
GetFragmentEndTimestamp Get fragment end_timestamp on an array, will search for the closest end_timestamp to the timestamp asked
@param namespace character
@param array character
@param end.timestamp integer
status code : 200 | fragment end_timestamp on an array
return type : integer
response headers :
status code : 0 | error response
return type : Error
response headers :
GetLastAccessedArrays
@returnType list( LastAccessedArray )
status code : 200 | gets last accessed arrays
return type : array[LastAccessedArray]
response headers :
status code : 0 | error response
return type : Error
response headers :
RegisterArray register an array at a specified URI registered to the given namespace
@param namespace character
@param array character
@param array.metadata ArrayInfoUpdate
status code : 204 | schema registered successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
ShareArray Share an array with a user
@param namespace character
@param array character
@param array.sharing ArraySharing
status code : 204 | Array shared successfully
response headers :
status code : 404 | Array does not exist or user does not have permissions to share array
response headers :
status code : 0 | error response
return type : Error
response headers :
UpdateArrayMetadata update metadata on an array
@param namespace character
@param array character
@param array.metadata ArrayInfoUpdate
status code : 204 | array metadata updated successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
UpdateArrayMetadataCapnp update metadata on an array
@param namespace character
@param array character
@param array.metadata.entries ArrayMetadata
status code : 200 | array metadata updated successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
VacuumArray vacuum an array at a specified URI
@param namespace character
@param array character
@param tiledb.config TileDBConfig
status code : 204 | array vacuumed successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
ArrayApi$new(apiClient)
ArrayActivityLog()
ArrayApi$ArrayActivityLog( namespace, array, start = NULL, end = NULL, event.types = NULL, task.id = NULL, has.task.id = NULL, ... )
ArrayActivityLogWithHttpInfo()
ArrayApi$ArrayActivityLogWithHttpInfo( namespace, array, start = NULL, end = NULL, event.types = NULL, task.id = NULL, has.task.id = NULL, ... )
ArraysBrowserOwnedGet()
ArrayApi$ArraysBrowserOwnedGet( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, file.type = NULL, exclude.file.type = NULL, file.property = NULL, ... )
ArraysBrowserOwnedGetWithHttpInfo()
ArrayApi$ArraysBrowserOwnedGetWithHttpInfo( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, file.type = NULL, exclude.file.type = NULL, file.property = NULL, ... )
ArraysBrowserOwnedSidebarGet()
ArrayApi$ArraysBrowserOwnedSidebarGet(...)
ArraysBrowserOwnedSidebarGetWithHttpInfo()
ArrayApi$ArraysBrowserOwnedSidebarGetWithHttpInfo(...)
ArraysBrowserPublicGet()
ArrayApi$ArraysBrowserPublicGet( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, file.type = NULL, exclude.file.type = NULL, file.property = NULL, ... )
ArraysBrowserPublicGetWithHttpInfo()
ArrayApi$ArraysBrowserPublicGetWithHttpInfo( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, file.type = NULL, exclude.file.type = NULL, file.property = NULL, ... )
ArraysBrowserPublicSidebarGet()
ArrayApi$ArraysBrowserPublicSidebarGet(...)
ArraysBrowserPublicSidebarGetWithHttpInfo()
ArrayApi$ArraysBrowserPublicSidebarGetWithHttpInfo(...)
ArraysBrowserSharedGet()
ArrayApi$ArraysBrowserSharedGet( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, file.type = NULL, exclude.file.type = NULL, file.property = NULL, ... )
ArraysBrowserSharedGetWithHttpInfo()
ArrayApi$ArraysBrowserSharedGetWithHttpInfo( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, file.type = NULL, exclude.file.type = NULL, file.property = NULL, ... )
ArraysBrowserSharedSidebarGet()
ArrayApi$ArraysBrowserSharedSidebarGet(...)
ArraysBrowserSharedSidebarGetWithHttpInfo()
ArrayApi$ArraysBrowserSharedSidebarGetWithHttpInfo(...)
ArraysNamespaceArrayEndTimestampsGet()
ArrayApi$ArraysNamespaceArrayEndTimestampsGet( namespace, array, page = NULL, per.page = NULL, ... )
ArraysNamespaceArrayEndTimestampsGetWithHttpInfo()
ArrayApi$ArraysNamespaceArrayEndTimestampsGetWithHttpInfo( namespace, array, page = NULL, per.page = NULL, ... )
ConsolidateArray()
ArrayApi$ConsolidateArray(namespace, array, tiledb.config, ...)
ConsolidateArrayWithHttpInfo()
ArrayApi$ConsolidateArrayWithHttpInfo(namespace, array, tiledb.config, ...)
CreateArray()
ArrayApi$CreateArray( namespace, array, content.type, array.schema, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = NULL, ... )
CreateArrayWithHttpInfo()
ArrayApi$CreateArrayWithHttpInfo( namespace, array, content.type, array.schema, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = NULL, ... )
DeleteArray()
ArrayApi$DeleteArray(namespace, array, content.type, ...)
DeleteArrayWithHttpInfo()
ArrayApi$DeleteArrayWithHttpInfo(namespace, array, content.type, ...)
DeregisterArray()
ArrayApi$DeregisterArray(namespace, array, ...)
DeregisterArrayWithHttpInfo()
ArrayApi$DeregisterArrayWithHttpInfo(namespace, array, ...)
GetActivityLogById()
ArrayApi$GetActivityLogById(namespace, array, id, ...)
GetActivityLogByIdWithHttpInfo()
ArrayApi$GetActivityLogByIdWithHttpInfo(namespace, array, id, ...)
GetAllArrayMetadata()
ArrayApi$GetAllArrayMetadata(public.share = NULL, ...)
GetAllArrayMetadataWithHttpInfo()
ArrayApi$GetAllArrayMetadataWithHttpInfo(public.share = NULL, ...)
GetArray()
ArrayApi$GetArray(namespace, array, content.type, ...)
GetArrayWithHttpInfo()
ArrayApi$GetArrayWithHttpInfo(namespace, array, content.type, ...)
GetArrayMaxBufferSizes()
ArrayApi$GetArrayMaxBufferSizes( namespace, array, subarray, content.type, x.payer = NULL, ... )
GetArrayMaxBufferSizesWithHttpInfo()
ArrayApi$GetArrayMaxBufferSizesWithHttpInfo( namespace, array, subarray, content.type, x.payer = NULL, ... )
GetArrayMetaDataJson()
ArrayApi$GetArrayMetaDataJson( namespace, array, length = NULL, end.timestamp = NULL, ... )
GetArrayMetaDataJsonWithHttpInfo()
ArrayApi$GetArrayMetaDataJsonWithHttpInfo( namespace, array, length = NULL, end.timestamp = NULL, ... )
GetArrayMetadata()
ArrayApi$GetArrayMetadata(namespace, array, ...)
GetArrayMetadataWithHttpInfo()
ArrayApi$GetArrayMetadataWithHttpInfo(namespace, array, ...)
GetArrayMetadataCapnp()
ArrayApi$GetArrayMetadataCapnp(namespace, array, ...)
GetArrayMetadataCapnpWithHttpInfo()
ArrayApi$GetArrayMetadataCapnpWithHttpInfo(namespace, array, ...)
GetArrayNonEmptyDomain()
ArrayApi$GetArrayNonEmptyDomain( namespace, array, content.type, x.payer = NULL, ... )
GetArrayNonEmptyDomainWithHttpInfo()
ArrayApi$GetArrayNonEmptyDomainWithHttpInfo( namespace, array, content.type, x.payer = NULL, ... )
GetArrayNonEmptyDomainJson()
ArrayApi$GetArrayNonEmptyDomainJson(namespace, array, ...)
GetArrayNonEmptyDomainJsonWithHttpInfo()
ArrayApi$GetArrayNonEmptyDomainJsonWithHttpInfo(namespace, array, ...)
GetArraySampleData()
ArrayApi$GetArraySampleData(namespace, array, samples = 5, ...)
GetArraySampleDataWithHttpInfo()
ArrayApi$GetArraySampleDataWithHttpInfo(namespace, array, samples = 5, ...)
GetArraySharingPolicies()
ArrayApi$GetArraySharingPolicies(namespace, array, ...)
GetArraySharingPoliciesWithHttpInfo()
ArrayApi$GetArraySharingPoliciesWithHttpInfo(namespace, array, ...)
GetArraysInNamespace()
ArrayApi$GetArraysInNamespace(namespace, ...)
GetArraysInNamespaceWithHttpInfo()
ArrayApi$GetArraysInNamespaceWithHttpInfo(namespace, ...)
GetFragmentEndTimestamp()
ArrayApi$GetFragmentEndTimestamp(namespace, array, end.timestamp = NULL, ...)
GetFragmentEndTimestampWithHttpInfo()
ArrayApi$GetFragmentEndTimestampWithHttpInfo( namespace, array, end.timestamp = NULL, ... )
GetLastAccessedArrays()
ArrayApi$GetLastAccessedArrays(...)
GetLastAccessedArraysWithHttpInfo()
ArrayApi$GetLastAccessedArraysWithHttpInfo(...)
RegisterArray()
ArrayApi$RegisterArray(namespace, array, array.metadata, ...)
RegisterArrayWithHttpInfo()
ArrayApi$RegisterArrayWithHttpInfo(namespace, array, array.metadata, ...)
ShareArray()
ArrayApi$ShareArray(namespace, array, array.sharing, ...)
ShareArrayWithHttpInfo()
ArrayApi$ShareArrayWithHttpInfo(namespace, array, array.sharing, ...)
UpdateArrayMetadata()
ArrayApi$UpdateArrayMetadata(namespace, array, array.metadata, ...)
UpdateArrayMetadataWithHttpInfo()
ArrayApi$UpdateArrayMetadataWithHttpInfo(namespace, array, array.metadata, ...)
UpdateArrayMetadataCapnp()
ArrayApi$UpdateArrayMetadataCapnp( namespace, array, array.metadata.entries, ... )
UpdateArrayMetadataCapnpWithHttpInfo()
ArrayApi$UpdateArrayMetadataCapnpWithHttpInfo( namespace, array, array.metadata.entries, ... )
VacuumArray()
ArrayApi$VacuumArray(namespace, array, tiledb.config, ...)
VacuumArrayWithHttpInfo()
ArrayApi$VacuumArrayWithHttpInfo(namespace, array, tiledb.config, ...)
clone()
The objects of this class are cloneable with this method.
ArrayApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run: #################### ArrayActivityLog #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.start <- 56 # integer | Start time of window of fetch logs, unix epoch in seconds (default: seven days ago) var.end <- 56 # integer | End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp) var.event.types <- 'event.types_example' # character | Event values can be one or more of the following read, write, create, delete, register, deregister, comma separated var.task.id <- 'task.id_example' # character | Array task ID To filter activity to var.has.task.id <- 'has.task.id_example' # character | Excludes activity log results that do not contain an array task UUID api.instance <- ArrayApi$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$ArrayActivityLog(var.namespace, var.array, start=var.start, end=var.end, event.types=var.event.types, task.id=var.task.id, has.task.id=var.has.task.id) #################### ArraysBrowserOwnedGet #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit var.search <- 'search_example' # character | search string that will look at name, namespace or description fields var.namespace <- 'namespace_example' # character | namespace var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.file.type <- ['file.type_example'] # array[character] | file_type to search for, more than one can be included var.exclude.file.type <- ['exclude.file.type_example'] # array[character] | file_type to exclude matching array in results, more than one can be included var.file.property <- ['file.property_example'] # array[character] | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included api.instance <- ArrayApi$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$ArraysBrowserOwnedGet(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, file.type=var.file.type, exclude.file.type=var.exclude.file.type, file.property=var.file.property) #################### ArraysBrowserOwnedSidebarGet #################### library(tiledbcloud) api.instance <- ArrayApi$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$ArraysBrowserOwnedSidebarGet() #################### ArraysBrowserPublicGet #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit var.search <- 'search_example' # character | search string that will look at name, namespace or description fields var.namespace <- 'namespace_example' # character | namespace var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.file.type <- ['file.type_example'] # array[character] | file_type to search for, more than one can be included var.exclude.file.type <- ['exclude.file.type_example'] # array[character] | file_type to exclude matching array in results, more than one can be included var.file.property <- ['file.property_example'] # array[character] | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included api.instance <- ArrayApi$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$ArraysBrowserPublicGet(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, file.type=var.file.type, exclude.file.type=var.exclude.file.type, file.property=var.file.property) #################### ArraysBrowserPublicSidebarGet #################### library(tiledbcloud) api.instance <- ArrayApi$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$ArraysBrowserPublicSidebarGet() #################### ArraysBrowserSharedGet #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit var.search <- 'search_example' # character | search string that will look at name, namespace or description fields var.namespace <- 'namespace_example' # character | namespace var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.file.type <- ['file.type_example'] # array[character] | file_type to search for, more than one can be included var.exclude.file.type <- ['exclude.file.type_example'] # array[character] | file_type to exclude matching array in results, more than one can be included var.file.property <- ['file.property_example'] # array[character] | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included api.instance <- ArrayApi$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$ArraysBrowserSharedGet(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, file.type=var.file.type, exclude.file.type=var.exclude.file.type, file.property=var.file.property) #################### ArraysBrowserSharedSidebarGet #################### library(tiledbcloud) api.instance <- ArrayApi$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$ArraysBrowserSharedSidebarGet() #################### ArraysNamespaceArrayEndTimestampsGet #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- ArrayApi$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$ArraysNamespaceArrayEndTimestampsGet(var.namespace, var.array, page=var.page, per.page=var.per.page) #################### ConsolidateArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.tiledb.config <- TileDBConfig$new() # TileDBConfig | tiledb configuration api.instance <- ArrayApi$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$ConsolidateArray(var.namespace, var.array, var.tiledb.config) #################### CreateArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.content.type <- 'application/json' # character | Content Type of input and return mime var.array.schema <- ArraySchema$new() # ArraySchema | ArraySchema being created var.X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME <- 'X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME_example' # character | Optional registered access credentials to use for creation api.instance <- ArrayApi$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$CreateArray(var.namespace, var.array, var.content.type, var.array.schema, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME=var.X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME) #################### DeleteArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.content.type <- 'application/json' # character | Content Type of input and return mime api.instance <- ArrayApi$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$DeleteArray(var.namespace, var.array, var.content.type) #################### DeregisterArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded api.instance <- ArrayApi$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$DeregisterArray(var.namespace, var.array) #################### GetActivityLogById #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.id <- 'id_example' # character | ID of the activity api.instance <- ArrayApi$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$GetActivityLogById(var.namespace, var.array, var.id) #################### GetAllArrayMetadata #################### library(tiledbcloud) var.public.share <- 'public.share_example' # character | Public share values can be one of exclude, only api.instance <- ArrayApi$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$GetAllArrayMetadata(public.share=var.public.share) #################### GetArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.content.type <- 'application/json' # character | Content Type of input and return mime api.instance <- ArrayApi$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$GetArray(var.namespace, var.array, var.content.type) #################### GetArrayMaxBufferSizes #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.subarray <- 'subarray_example' # character | CSV string of subarray to get max buffer sizes for var.content.type <- 'application/json' # character | Content Type of input and return mime var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request api.instance <- ArrayApi$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$GetArrayMaxBufferSizes(var.namespace, var.array, var.subarray, var.content.type, x.payer=var.x.payer) #################### GetArrayMetaDataJson #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.length <- 56 # integer | (optional) limit character length of returned values var.end.timestamp <- 56 # integer | Milliseconds since Unix epoch, metadata will use open_at functionality to open array at the specific timestamp api.instance <- ArrayApi$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$GetArrayMetaDataJson(var.namespace, var.array, length=var.length, end.timestamp=var.end.timestamp) #################### GetArrayMetadata #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded api.instance <- ArrayApi$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$GetArrayMetadata(var.namespace, var.array) #################### GetArrayMetadataCapnp #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded api.instance <- ArrayApi$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$GetArrayMetadataCapnp(var.namespace, var.array) #################### GetArrayNonEmptyDomain #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.content.type <- 'application/json' # character | Content Type of input and return mime var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request api.instance <- ArrayApi$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$GetArrayNonEmptyDomain(var.namespace, var.array, var.content.type, x.payer=var.x.payer) #################### GetArrayNonEmptyDomainJson #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded api.instance <- ArrayApi$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$GetArrayNonEmptyDomainJson(var.namespace, var.array) #################### GetArraySampleData #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.samples <- 5.0 # numeric | Number of sample results to return api.instance <- ArrayApi$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$GetArraySampleData(var.namespace, var.array, samples=var.samples) #################### GetArraySharingPolicies #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded api.instance <- ArrayApi$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$GetArraySharingPolicies(var.namespace, var.array) #################### GetArraysInNamespace #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) api.instance <- ArrayApi$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$GetArraysInNamespace(var.namespace) #################### GetFragmentEndTimestamp #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.end.timestamp <- 56 # integer | Milliseconds since Unix epoch api.instance <- ArrayApi$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$GetFragmentEndTimestamp(var.namespace, var.array, end.timestamp=var.end.timestamp) #################### GetLastAccessedArrays #################### library(tiledbcloud) api.instance <- ArrayApi$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$GetLastAccessedArrays() #################### RegisterArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.array.metadata <- ArrayInfoUpdate$new() # ArrayInfoUpdate | metadata associated with array api.instance <- ArrayApi$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$RegisterArray(var.namespace, var.array, var.array.metadata) #################### ShareArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.array.sharing <- ArraySharing$new() # ArraySharing | Namespace and list of permissions to share with. An empty list of permissions will remove the namespace; if permissions already exist they will be deleted then new ones added. In the event of a failure, the new policies will be rolled back to prevent partial policies, and it's likely the array will not be shared with the namespace at all. api.instance <- ArrayApi$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$ShareArray(var.namespace, var.array, var.array.sharing) #################### UpdateArrayMetadata #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.array.metadata <- ArrayInfoUpdate$new() # ArrayInfoUpdate | array metadata to update api.instance <- ArrayApi$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$UpdateArrayMetadata(var.namespace, var.array, var.array.metadata) #################### UpdateArrayMetadataCapnp #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.array.metadata.entries <- ArrayMetadata$new() # ArrayMetadata | List of metadata entries api.instance <- ArrayApi$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$UpdateArrayMetadataCapnp(var.namespace, var.array, var.array.metadata.entries) #################### VacuumArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.tiledb.config <- TileDBConfig$new() # TileDBConfig | tiledb configuration api.instance <- ArrayApi$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$VacuumArray(var.namespace, var.array, var.tiledb.config) ## End(Not run)
## Not run: #################### ArrayActivityLog #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.start <- 56 # integer | Start time of window of fetch logs, unix epoch in seconds (default: seven days ago) var.end <- 56 # integer | End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp) var.event.types <- 'event.types_example' # character | Event values can be one or more of the following read, write, create, delete, register, deregister, comma separated var.task.id <- 'task.id_example' # character | Array task ID To filter activity to var.has.task.id <- 'has.task.id_example' # character | Excludes activity log results that do not contain an array task UUID api.instance <- ArrayApi$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$ArrayActivityLog(var.namespace, var.array, start=var.start, end=var.end, event.types=var.event.types, task.id=var.task.id, has.task.id=var.has.task.id) #################### ArraysBrowserOwnedGet #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit var.search <- 'search_example' # character | search string that will look at name, namespace or description fields var.namespace <- 'namespace_example' # character | namespace var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.file.type <- ['file.type_example'] # array[character] | file_type to search for, more than one can be included var.exclude.file.type <- ['exclude.file.type_example'] # array[character] | file_type to exclude matching array in results, more than one can be included var.file.property <- ['file.property_example'] # array[character] | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included api.instance <- ArrayApi$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$ArraysBrowserOwnedGet(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, file.type=var.file.type, exclude.file.type=var.exclude.file.type, file.property=var.file.property) #################### ArraysBrowserOwnedSidebarGet #################### library(tiledbcloud) api.instance <- ArrayApi$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$ArraysBrowserOwnedSidebarGet() #################### ArraysBrowserPublicGet #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit var.search <- 'search_example' # character | search string that will look at name, namespace or description fields var.namespace <- 'namespace_example' # character | namespace var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.file.type <- ['file.type_example'] # array[character] | file_type to search for, more than one can be included var.exclude.file.type <- ['exclude.file.type_example'] # array[character] | file_type to exclude matching array in results, more than one can be included var.file.property <- ['file.property_example'] # array[character] | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included api.instance <- ArrayApi$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$ArraysBrowserPublicGet(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, file.type=var.file.type, exclude.file.type=var.exclude.file.type, file.property=var.file.property) #################### ArraysBrowserPublicSidebarGet #################### library(tiledbcloud) api.instance <- ArrayApi$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$ArraysBrowserPublicSidebarGet() #################### ArraysBrowserSharedGet #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit var.search <- 'search_example' # character | search string that will look at name, namespace or description fields var.namespace <- 'namespace_example' # character | namespace var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.file.type <- ['file.type_example'] # array[character] | file_type to search for, more than one can be included var.exclude.file.type <- ['exclude.file.type_example'] # array[character] | file_type to exclude matching array in results, more than one can be included var.file.property <- ['file.property_example'] # array[character] | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included api.instance <- ArrayApi$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$ArraysBrowserSharedGet(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, file.type=var.file.type, exclude.file.type=var.exclude.file.type, file.property=var.file.property) #################### ArraysBrowserSharedSidebarGet #################### library(tiledbcloud) api.instance <- ArrayApi$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$ArraysBrowserSharedSidebarGet() #################### ArraysNamespaceArrayEndTimestampsGet #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- ArrayApi$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$ArraysNamespaceArrayEndTimestampsGet(var.namespace, var.array, page=var.page, per.page=var.per.page) #################### ConsolidateArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.tiledb.config <- TileDBConfig$new() # TileDBConfig | tiledb configuration api.instance <- ArrayApi$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$ConsolidateArray(var.namespace, var.array, var.tiledb.config) #################### CreateArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.content.type <- 'application/json' # character | Content Type of input and return mime var.array.schema <- ArraySchema$new() # ArraySchema | ArraySchema being created var.X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME <- 'X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME_example' # character | Optional registered access credentials to use for creation api.instance <- ArrayApi$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$CreateArray(var.namespace, var.array, var.content.type, var.array.schema, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME=var.X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME) #################### DeleteArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.content.type <- 'application/json' # character | Content Type of input and return mime api.instance <- ArrayApi$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$DeleteArray(var.namespace, var.array, var.content.type) #################### DeregisterArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded api.instance <- ArrayApi$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$DeregisterArray(var.namespace, var.array) #################### GetActivityLogById #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.id <- 'id_example' # character | ID of the activity api.instance <- ArrayApi$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$GetActivityLogById(var.namespace, var.array, var.id) #################### GetAllArrayMetadata #################### library(tiledbcloud) var.public.share <- 'public.share_example' # character | Public share values can be one of exclude, only api.instance <- ArrayApi$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$GetAllArrayMetadata(public.share=var.public.share) #################### GetArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.content.type <- 'application/json' # character | Content Type of input and return mime api.instance <- ArrayApi$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$GetArray(var.namespace, var.array, var.content.type) #################### GetArrayMaxBufferSizes #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.subarray <- 'subarray_example' # character | CSV string of subarray to get max buffer sizes for var.content.type <- 'application/json' # character | Content Type of input and return mime var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request api.instance <- ArrayApi$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$GetArrayMaxBufferSizes(var.namespace, var.array, var.subarray, var.content.type, x.payer=var.x.payer) #################### GetArrayMetaDataJson #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.length <- 56 # integer | (optional) limit character length of returned values var.end.timestamp <- 56 # integer | Milliseconds since Unix epoch, metadata will use open_at functionality to open array at the specific timestamp api.instance <- ArrayApi$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$GetArrayMetaDataJson(var.namespace, var.array, length=var.length, end.timestamp=var.end.timestamp) #################### GetArrayMetadata #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded api.instance <- ArrayApi$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$GetArrayMetadata(var.namespace, var.array) #################### GetArrayMetadataCapnp #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded api.instance <- ArrayApi$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$GetArrayMetadataCapnp(var.namespace, var.array) #################### GetArrayNonEmptyDomain #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.content.type <- 'application/json' # character | Content Type of input and return mime var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request api.instance <- ArrayApi$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$GetArrayNonEmptyDomain(var.namespace, var.array, var.content.type, x.payer=var.x.payer) #################### GetArrayNonEmptyDomainJson #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded api.instance <- ArrayApi$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$GetArrayNonEmptyDomainJson(var.namespace, var.array) #################### GetArraySampleData #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.samples <- 5.0 # numeric | Number of sample results to return api.instance <- ArrayApi$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$GetArraySampleData(var.namespace, var.array, samples=var.samples) #################### GetArraySharingPolicies #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded api.instance <- ArrayApi$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$GetArraySharingPolicies(var.namespace, var.array) #################### GetArraysInNamespace #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) api.instance <- ArrayApi$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$GetArraysInNamespace(var.namespace) #################### GetFragmentEndTimestamp #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.end.timestamp <- 56 # integer | Milliseconds since Unix epoch api.instance <- ArrayApi$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$GetFragmentEndTimestamp(var.namespace, var.array, end.timestamp=var.end.timestamp) #################### GetLastAccessedArrays #################### library(tiledbcloud) api.instance <- ArrayApi$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$GetLastAccessedArrays() #################### RegisterArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.array.metadata <- ArrayInfoUpdate$new() # ArrayInfoUpdate | metadata associated with array api.instance <- ArrayApi$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$RegisterArray(var.namespace, var.array, var.array.metadata) #################### ShareArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.array.sharing <- ArraySharing$new() # ArraySharing | Namespace and list of permissions to share with. An empty list of permissions will remove the namespace; if permissions already exist they will be deleted then new ones added. In the event of a failure, the new policies will be rolled back to prevent partial policies, and it's likely the array will not be shared with the namespace at all. api.instance <- ArrayApi$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$ShareArray(var.namespace, var.array, var.array.sharing) #################### UpdateArrayMetadata #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.array.metadata <- ArrayInfoUpdate$new() # ArrayInfoUpdate | array metadata to update api.instance <- ArrayApi$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$UpdateArrayMetadata(var.namespace, var.array, var.array.metadata) #################### UpdateArrayMetadataCapnp #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.array.metadata.entries <- ArrayMetadata$new() # ArrayMetadata | List of metadata entries api.instance <- ArrayApi$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$UpdateArrayMetadataCapnp(var.namespace, var.array, var.array.metadata.entries) #################### VacuumArray #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.tiledb.config <- TileDBConfig$new() # TileDBConfig | tiledb configuration api.instance <- ArrayApi$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$VacuumArray(var.namespace, var.array, var.tiledb.config) ## End(Not run)
ArrayBrowserData Class
An R6Class
generator object
arrays
list( ArrayInfo ) [optional]
pagination_metadata
PaginationMetadata [optional]
new()
ArrayBrowserData$new(arrays = NULL, pagination_metadata = NULL, ...)
toJSON()
ArrayBrowserData$toJSON()
fromJSON()
ArrayBrowserData$fromJSON(ArrayBrowserDataJson)
toJSONString()
ArrayBrowserData$toJSONString()
fromJSONString()
ArrayBrowserData$fromJSONString(ArrayBrowserDataJson)
clone()
The objects of this class are cloneable with this method.
ArrayBrowserData$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayBrowserSidebar Class
An R6Class
generator object
namespaces
list( character ) [optional]
result_count_for_all
integer [optional]
result_count_by_namespace
object [optional]
new()
ArrayBrowserSidebar$new( namespaces = NULL, result_count_for_all = NULL, result_count_by_namespace = NULL, ... )
toJSON()
ArrayBrowserSidebar$toJSON()
fromJSON()
ArrayBrowserSidebar$fromJSON(ArrayBrowserSidebarJson)
toJSONString()
ArrayBrowserSidebar$toJSONString()
fromJSONString()
ArrayBrowserSidebar$fromJSONString(ArrayBrowserSidebarJson)
clone()
The objects of this class are cloneable with this method.
ArrayBrowserSidebar$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayEndTimestampData Class
An R6Class
generator object
end_timestamps
list( integer ) [optional]
pagination_metadata
PaginationMetadata [optional]
new()
ArrayEndTimestampData$new( end_timestamps = NULL, pagination_metadata = NULL, ... )
toJSON()
ArrayEndTimestampData$toJSON()
fromJSON()
ArrayEndTimestampData$fromJSON(ArrayEndTimestampDataJson)
toJSONString()
ArrayEndTimestampData$toJSONString()
fromJSONString()
ArrayEndTimestampData$fromJSONString(ArrayEndTimestampDataJson)
clone()
The objects of this class are cloneable with this method.
ArrayEndTimestampData$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayFavorite Class
An R6Class
generator object
array_uuid
character [optional]
namespace
character [optional]
name
character [optional]
new()
ArrayFavorite$new(array_uuid = NULL, namespace = NULL, name = NULL, ...)
toJSON()
ArrayFavorite$toJSON()
fromJSON()
ArrayFavorite$fromJSON(ArrayFavoriteJson)
toJSONString()
ArrayFavorite$toJSONString()
fromJSONString()
ArrayFavorite$fromJSONString(ArrayFavoriteJson)
clone()
The objects of this class are cloneable with this method.
ArrayFavorite$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayFavoritesData Class
An R6Class
generator object
arrays
list( ArrayInfo ) [optional]
pagination_metadata
PaginationMetadata [optional]
new()
ArrayFavoritesData$new(arrays = NULL, pagination_metadata = NULL, ...)
toJSON()
ArrayFavoritesData$toJSON()
fromJSON()
ArrayFavoritesData$fromJSON(ArrayFavoritesDataJson)
toJSONString()
ArrayFavoritesData$toJSONString()
fromJSONString()
ArrayFavoritesData$fromJSONString(ArrayFavoritesDataJson)
clone()
The objects of this class are cloneable with this method.
ArrayFavoritesData$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayInfo Class
An R6Class
generator object
id
character [optional]
file_type
FileType [optional]
file_properties
named list( character ) [optional]
uri
character [optional]
namespace
character [optional]
size
numeric [optional]
last_accessed
character [optional]
description
character [optional]
name
character [optional]
allowed_actions
list( ArrayActions ) [optional]
pricing
list( Pricing ) [optional]
subscriptions
list( Subscription ) [optional]
logo
character [optional]
access_credentials_name
character [optional]
type
character [optional]
share_count
numeric [optional]
public_share
character [optional]
namespace_subscribed
character [optional]
tiledb_uri
character [optional]
tags
list( character ) [optional]
license_id
character [optional]
license_text
character [optional]
read_only
character [optional]
is_favorite
character [optional]
new()
ArrayInfo$new( id = NULL, file_type = NULL, file_properties = NULL, uri = NULL, namespace = NULL, size = NULL, last_accessed = NULL, description = NULL, name = NULL, allowed_actions = NULL, pricing = NULL, subscriptions = NULL, logo = NULL, access_credentials_name = NULL, type = NULL, share_count = NULL, public_share = NULL, namespace_subscribed = NULL, tiledb_uri = NULL, tags = NULL, license_id = NULL, license_text = NULL, read_only = NULL, is_favorite = NULL, ... )
toJSON()
ArrayInfo$toJSON()
fromJSON()
ArrayInfo$fromJSON(ArrayInfoJson)
toJSONString()
ArrayInfo$toJSONString()
fromJSONString()
ArrayInfo$fromJSONString(ArrayInfoJson)
clone()
The objects of this class are cloneable with this method.
ArrayInfo$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayInfoUpdate Class
An R6Class
generator object
description
character [optional]
name
character [optional]
uri
character [optional]
file_type
FileType [optional]
file_properties
named list( character ) [optional]
access_credentials_name
character [optional]
logo
character [optional]
tags
list( character ) [optional]
license_id
character [optional]
license_text
character [optional]
read_only
character [optional]
new()
ArrayInfoUpdate$new( description = NULL, name = NULL, uri = NULL, file_type = NULL, file_properties = NULL, access_credentials_name = NULL, logo = NULL, tags = NULL, license_id = NULL, license_text = NULL, read_only = NULL, ... )
toJSON()
ArrayInfoUpdate$toJSON()
fromJSON()
ArrayInfoUpdate$fromJSON(ArrayInfoUpdateJson)
toJSONString()
ArrayInfoUpdate$toJSONString()
fromJSONString()
ArrayInfoUpdate$fromJSONString(ArrayInfoUpdateJson)
clone()
The objects of this class are cloneable with this method.
ArrayInfoUpdate$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayMetadata Class
An R6Class
generator object
entries
list( ArrayMetadataEntry ) [optional]
new()
ArrayMetadata$new(entries = NULL, ...)
toJSON()
ArrayMetadata$toJSON()
fromJSON()
ArrayMetadata$fromJSON(ArrayMetadataJson)
toJSONString()
ArrayMetadata$toJSONString()
fromJSONString()
ArrayMetadata$fromJSONString(ArrayMetadataJson)
clone()
The objects of this class are cloneable with this method.
ArrayMetadata$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayMetadataEntry Class
An R6Class
generator object
key
character [optional]
type
character [optional]
valueNum
integer [optional]
value
list( integer ) [optional]
del
character [optional]
new()
ArrayMetadataEntry$new( key = NULL, type = NULL, valueNum = NULL, value = NULL, del = NULL, ... )
toJSON()
ArrayMetadataEntry$toJSON()
fromJSON()
ArrayMetadataEntry$fromJSON(ArrayMetadataEntryJson)
toJSONString()
ArrayMetadataEntry$toJSONString()
fromJSONString()
ArrayMetadataEntry$fromJSONString(ArrayMetadataEntryJson)
clone()
The objects of this class are cloneable with this method.
ArrayMetadataEntry$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArraySample Class
An R6Class
generator object
data
object [optional]
new()
ArraySample$new(data = NULL, ...)
toJSON()
ArraySample$toJSON()
fromJSON()
ArraySample$fromJSON(ArraySampleJson)
toJSONString()
ArraySample$toJSONString()
fromJSONString()
ArraySample$fromJSONString(ArraySampleJson)
clone()
The objects of this class are cloneable with this method.
ArraySample$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArraySchema Class
An R6Class
generator object
uri
character [optional]
version
list( integer )
arrayType
tileOrder
cellOrder
capacity
integer
coordsFilterPipeline
offsetFilterPipeline
domain
attributes
list( Attribute )
allowsDuplicates
character [optional]
new()
ArraySchema$new( version, arrayType, tileOrder, cellOrder, capacity, coordsFilterPipeline, offsetFilterPipeline, domain, attributes, uri = NULL, allowsDuplicates = NULL, ... )
toJSON()
ArraySchema$toJSON()
fromJSON()
ArraySchema$fromJSON(ArraySchemaJson)
toJSONString()
ArraySchema$toJSONString()
fromJSONString()
ArraySchema$fromJSONString(ArraySchemaJson)
clone()
The objects of this class are cloneable with this method.
ArraySchema$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArraySharing Class
An R6Class
generator object
actions
list( ArrayActions ) [optional]
namespace
character [optional]
namespace_type
character [optional]
new()
ArraySharing$new(actions = NULL, namespace = NULL, namespace_type = NULL, ...)
toJSON()
ArraySharing$toJSON()
fromJSON()
ArraySharing$fromJSON(ArraySharingJson)
toJSONString()
ArraySharing$toJSONString()
fromJSONString()
ArraySharing$fromJSONString(ArraySharingJson)
clone()
The objects of this class are cloneable with this method.
ArraySharing$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayTask Class
An R6Class
generator object
id
character [optional]
name
character [optional]
description
character [optional]
array_metadata
ArrayInfo [optional]
subarray
DomainArray [optional]
memory
integer [optional]
cpu
integer [optional]
namespace
character [optional]
status
ArrayTaskStatus [optional]
start_time
character [optional]
finish_time
character [optional]
cost
numeric [optional]
egress_cost
numeric [optional]
access_cost
numeric [optional]
query_type
Querytype [optional]
udf_code
character [optional]
udf_language
character [optional]
sql_query
character [optional]
type
ArrayTaskType [optional]
activity
list( ArrayActivityLog ) [optional]
logs
character [optional]
duration
numeric [optional]
sql_init_commands
list( character ) [optional]
sql_parameters
list( object ) [optional]
result_format
ResultFormat [optional]
task_graph_uuid
character [optional]
client_node_uuid
character [optional]
new()
ArrayTask$new( id = NULL, name = NULL, description = NULL, array_metadata = NULL, subarray = NULL, memory = NULL, cpu = NULL, namespace = NULL, status = NULL, start_time = NULL, finish_time = NULL, cost = NULL, egress_cost = NULL, access_cost = NULL, query_type = NULL, udf_code = NULL, udf_language = NULL, sql_query = NULL, type = NULL, activity = NULL, logs = NULL, duration = NULL, sql_init_commands = NULL, sql_parameters = NULL, result_format = NULL, task_graph_uuid = NULL, client_node_uuid = NULL, ... )
toJSON()
ArrayTask$toJSON()
fromJSON()
ArrayTask$fromJSON(ArrayTaskJson)
toJSONString()
ArrayTask$toJSONString()
fromJSONString()
ArrayTask$fromJSONString(ArrayTaskJson)
clone()
The objects of this class are cloneable with this method.
ArrayTask$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayTaskBrowserSidebar Class
An R6Class
generator object
organizations
list( character ) [optional]
result_count_for_all
integer [optional]
result_count_by_namespace
object [optional]
new()
ArrayTaskBrowserSidebar$new( organizations = NULL, result_count_for_all = NULL, result_count_by_namespace = NULL, ... )
toJSON()
ArrayTaskBrowserSidebar$toJSON()
fromJSON()
ArrayTaskBrowserSidebar$fromJSON(ArrayTaskBrowserSidebarJson)
toJSONString()
ArrayTaskBrowserSidebar$toJSONString()
fromJSONString()
ArrayTaskBrowserSidebar$fromJSONString(ArrayTaskBrowserSidebarJson)
clone()
The objects of this class are cloneable with this method.
ArrayTaskBrowserSidebar$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayTaskData Class
An R6Class
generator object
array_tasks
list( ArrayTask ) [optional]
pagination_metadata
PaginationMetadata [optional]
new()
ArrayTaskData$new(array_tasks = NULL, pagination_metadata = NULL, ...)
toJSON()
ArrayTaskData$toJSON()
fromJSON()
ArrayTaskData$fromJSON(ArrayTaskDataJson)
toJSONString()
ArrayTaskData$toJSONString()
fromJSONString()
ArrayTaskData$fromJSONString(ArrayTaskDataJson)
clone()
The objects of this class are cloneable with this method.
ArrayTaskData$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayTaskLog Class
An R6Class
generator object
array_task_id
character [optional]
logs
character [optional]
new()
ArrayTaskLog$new(array_task_id = NULL, logs = NULL, ...)
toJSON()
ArrayTaskLog$toJSON()
fromJSON()
ArrayTaskLog$fromJSON(ArrayTaskLogJson)
toJSONString()
ArrayTaskLog$toJSONString()
fromJSONString()
ArrayTaskLog$fromJSONString(ArrayTaskLogJson)
clone()
The objects of this class are cloneable with this method.
ArrayTaskLog$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.ArrayTasks
An R6Class
generator object
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 :
apiClient
Handles the client-server communication.
new()
ArrayTasksApi$new(apiClient)
GetArrayTasksSidebar()
ArrayTasksApi$GetArrayTasksSidebar(start = NULL, end = NULL, ...)
GetArrayTasksSidebarWithHttpInfo()
ArrayTasksApi$GetArrayTasksSidebarWithHttpInfo(start = NULL, end = NULL, ...)
clone()
The objects of this class are cloneable with this method.
ArrayTasksApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## 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)
## 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)
ArrayTaskStatus Class
An R6Class
generator object
new()
ArrayTaskStatus$new(...)
toJSON()
ArrayTaskStatus$toJSON()
fromJSON()
ArrayTaskStatus$fromJSON(ArrayTaskStatusJson)
toJSONString()
ArrayTaskStatus$toJSONString()
fromJSONString()
ArrayTaskStatus$fromJSONString(ArrayTaskStatusJson)
clone()
The objects of this class are cloneable with this method.
ArrayTaskStatus$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayTaskType Class
An R6Class
generator object
new()
ArrayTaskType$new(...)
toJSON()
ArrayTaskType$toJSON()
fromJSON()
ArrayTaskType$fromJSON(ArrayTaskTypeJson)
toJSONString()
ArrayTaskType$toJSONString()
fromJSONString()
ArrayTaskType$fromJSONString(ArrayTaskTypeJson)
clone()
The objects of this class are cloneable with this method.
ArrayTaskType$clone(deep = FALSE)
deep
Whether to make a deep clone.
ArrayType Class
An R6Class
generator object
new()
ArrayType$new(...)
toJSON()
ArrayType$toJSON()
fromJSON()
ArrayType$fromJSON(ArrayTypeJson)
toJSONString()
ArrayType$toJSONString()
fromJSONString()
ArrayType$fromJSONString(ArrayTypeJson)
clone()
The objects of this class are cloneable with this method.
ArrayType$clone(deep = FALSE)
deep
Whether to make a deep clone.
Attribute Class
An R6Class
generator object
name
character
type
filterPipeline
cellValNum
integer
nullable
character [optional]
fillValue
list( integer ) [optional]
new()
Attribute$new( name, type, filterPipeline, cellValNum, nullable = NULL, fillValue = NULL, ... )
toJSON()
Attribute$toJSON()
fromJSON()
Attribute$fromJSON(AttributeJson)
toJSONString()
Attribute$toJSONString()
fromJSONString()
Attribute$fromJSONString(AttributeJson)
clone()
The objects of this class are cloneable with this method.
Attribute$clone(deep = FALSE)
deep
Whether to make a deep clone.
AttributeBufferHeader Class
An R6Class
generator object
name
character
fixedLenBufferSizeInBytes
integer
varLenBufferSizeInBytes
integer
new()
AttributeBufferHeader$new( name, fixedLenBufferSizeInBytes, varLenBufferSizeInBytes, ... )
toJSON()
AttributeBufferHeader$toJSON()
fromJSON()
AttributeBufferHeader$fromJSON(AttributeBufferHeaderJson)
toJSONString()
AttributeBufferHeader$toJSONString()
fromJSONString()
AttributeBufferHeader$fromJSONString(AttributeBufferHeaderJson)
clone()
The objects of this class are cloneable with this method.
AttributeBufferHeader$clone(deep = FALSE)
deep
Whether to make a deep clone.
AttributeBufferSize Class
An R6Class
generator object
attribute
character
offsetBytes
integer
dataBytes
integer
new()
AttributeBufferSize$new(attribute, offsetBytes, dataBytes, ...)
toJSON()
AttributeBufferSize$toJSON()
fromJSON()
AttributeBufferSize$fromJSON(AttributeBufferSizeJson)
toJSONString()
AttributeBufferSize$toJSONString()
fromJSONString()
AttributeBufferSize$fromJSONString(AttributeBufferSizeJson)
clone()
The objects of this class are cloneable with this method.
AttributeBufferSize$clone(deep = FALSE)
deep
Whether to make a deep clone.
AWSAccessCredentials Class
An R6Class
generator object
secret_access_key
character [optional]
access_key_id
character [optional]
service_role_arn
character [optional]
name
character [optional]
default
character [optional]
buckets
list( character ) [optional]
created_at
character [optional]
updated_at
character [optional]
new()
AWSAccessCredentials$new( secret_access_key = NULL, access_key_id = NULL, service_role_arn = NULL, name = NULL, default = NULL, buckets = NULL, created_at = NULL, updated_at = NULL, ... )
toJSON()
AWSAccessCredentials$toJSON()
fromJSON()
AWSAccessCredentials$fromJSON(AWSAccessCredentialsJson)
toJSONString()
AWSAccessCredentials$toJSONString()
fromJSONString()
AWSAccessCredentials$fromJSONString(AWSAccessCredentialsJson)
clone()
The objects of this class are cloneable with this method.
AWSAccessCredentials$clone(deep = FALSE)
deep
Whether to make a deep clone.
The task graph is implicitly defined by various delayed
objects having others
in their argument lists.
compute( node, timeout_seconds = NULL, verbose = FALSE, namespace = NULL, force_all_local = FALSE )
compute( node, timeout_seconds = NULL, verbose = FALSE, namespace = NULL, force_all_local = FALSE )
node |
The object whose args are being set – nominally, produced by
|
timeout_seconds |
Number of seconds after which to stop waiting for results. Note that in-flight computationsa are not cancelled; this is not supported by the underlying R package we use for concurrency. |
verbose |
If supplied, show the DAG state at the start and end, along with all node start/end. Also shown are any stdout prints from the individual nodes, but these are only visible once the compute node has completed. |
namespace |
The namespace to charge for any cloud costs during the execution of the
task graph. This can be null only when all nodes have |
force_all_local |
While individual nodes can be marked with |
The value of the computation.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
Runs all nodes in a correct dependency ordering, but all within the context of the same process, and all locally. See also the Task Graphs vignette.
compute_sequentially(node)
compute_sequentially(node)
node |
Nominally, produced by |
The value of the computation.
Other manual-layer functions:
array_info()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
Provide the setup configuration for the TileDB Cloud package.
configure()
configure()
It considers four different environment variables:
TILEDB_REST_TOKEN
, TILEDB_REST_HOST
,
TILEDB_REST_USERNAME
, and TILEDB_REST_PASSWORD
.
To operate, either an API token has to be provided and will be used, or the username and password combination will be used to log in with a new session.
A named vector with configuration values is returned.
Datatype Class
An R6Class
generator object
new()
Datatype$new(...)
toJSON()
Datatype$toJSON()
fromJSON()
Datatype$fromJSON(DatatypeJson)
toJSONString()
Datatype$toJSONString()
fromJSONString()
Datatype$fromJSONString(DatatypeJson)
clone()
The objects of this class are cloneable with this method.
Datatype$clone(deep = FALSE)
deep
Whether to make a deep clone.
Define a function to be executed within a task graph
delayed(func, args = NULL, name = NULL, namespace = NULL, local = FALSE)
delayed(func, args = NULL, name = NULL, namespace = NULL, local = FALSE)
name |
Optional – e.g. |
namespace |
If supplied, a namespace to use for executing this particular node.
If omitted, a namespace can be applied at your top-level call to |
local |
If true, execute the functions on the local host; if else, execute them as UDFs in TileDB Cloud. |
A task-graph node object on which you can later call compute
.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
Get arguments for a delayed function, as a list.
delayed_args(node)
delayed_args(node)
node |
The object whose args are being set – nominally, produced by
|
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
Args can be set when delayed
is called, or afterward using this function.
delayed_args(node) <- value
delayed_args(node) <- value
node |
The object whose args are being set – nominally, produced by
|
value |
A list of arguments to the delayed function, e.g. |
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
Define a single-array UDF to be executed within a task graph
delayed_array_udf( array, udf = NULL, registered_udf_name = NULL, selectedRanges, attrs, layout = NULL, args = NULL, result_format = "native", name = NULL, namespace = NULL, language = "r" )
delayed_array_udf( array, udf = NULL, registered_udf_name = NULL, selectedRanges, attrs, layout = NULL, args = NULL, result_format = "native", name = NULL, namespace = NULL, language = "r" )
array |
TileDB URI – see vignette for examples. |
udf |
User-defined function, as in UDF examples. Arguments are specified separately via |
registered_udf_name |
Name of a registered UDF, of the form |
selectedRanges |
As in UDF examples. |
attrs |
As in UDF examples. |
layout |
As in UDF examples. |
result_format |
As in UDF examples. |
name |
A display name for the query |
namespace |
If supplied, a namespace to use for executing this particular node.
If omitted, a namespace can be applied at your top-level call to |
language |
If omitted, defaults to |
The return value from the UDF as an R object.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
Define a generic UDF to be executed within a task graph
delayed_generic_udf( udf = NULL, registered_udf_name = NULL, args = NULL, name = NULL, namespace = NULL, language = "r" )
delayed_generic_udf( udf = NULL, registered_udf_name = NULL, args = NULL, name = NULL, namespace = NULL, language = "r" )
udf |
An R function. Arguments are specified separately via |
registered_udf_name |
Name of a registered UDF, of the form |
name |
Optional – e.g. |
namespace |
If supplied, a namespace to use for executing this particular node.
If omitted, a namespace can be applied at your top-level call to |
language |
If omitted, defaults to |
The return value from the UDF as an R object.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
Define a SQL query function to be executed within a task graph
delayed_sql(query, name = NULL, namespace = NULL)
delayed_sql(query, name = NULL, namespace = NULL)
query |
SQL query string – see vignette for examples |
name |
A display name for the query |
namespace |
If supplied, the TileDB-Cloud namespace to charge the query to.
If omitted, a namespace can be applied at your top-level call to |
A task-graph node object on which you can later call compute
. The return value from
compute() will be the query result as a dataframe. Note that results will be strings, so numerical
results will need to be explicitly cast as such.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
The underlying storage will not be removed.
deregister_array(namespace = NULL, array_name)
deregister_array(namespace = NULL, array_name)
namespace |
Namespace within TileDB cloud to charge. If this is null, the logged-in user's username will be used for the namespace. |
array_name |
The name to call the array in TileDB Cloud. |
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
This function de-registers a 'Group' object, the 'Group' objects therein as well as any arrays.
deregister_group( uri, namespace, name, delete_from_group = TRUE, delete_array = FALSE, verbose = FALSE )
deregister_group( uri, namespace, name, delete_from_group = TRUE, delete_array = FALSE, verbose = FALSE )
uri |
A TileDB + S3 URI |
namespace |
A character like "TileDB-Inc" |
name |
A characther "groupABC" |
delete_from_group |
A logical value, default 'TRUE', whether arrays are removed from the group |
delete_array |
A logical value, default 'TRUE', whether arrays are deleted too |
verbose |
A logical value, default 'FALSE', whether operations are verbose or not |
Note that 'Group' objects remain on the underlying storage such as S3.
Nothing is returned, the function is invoked for its side-effect
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
Deletes a registered UDF. This removes all sharing and cannot be undone.
deregister_udf(name, namespace)
deregister_udf(name, namespace)
name |
Name of the UDF in TileDB Cloud, e.g. |
namespace |
Namespace for the UDF in TileDB Cloud, e.g. |
No return value.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
Dimension Class
An R6Class
generator object
name
character [optional]
type
domain
nullTileExtent
character
tileExtent
DimensionTileExtent [optional]
filterPipeline
FilterPipeline [optional]
new()
Dimension$new( type, domain, nullTileExtent, name = NULL, tileExtent = NULL, filterPipeline = NULL, ... )
toJSON()
Dimension$toJSON()
fromJSON()
Dimension$fromJSON(DimensionJson)
toJSONString()
Dimension$toJSONString()
fromJSONString()
Dimension$fromJSONString(DimensionJson)
clone()
The objects of this class are cloneable with this method.
Dimension$clone(deep = FALSE)
deep
Whether to make a deep clone.
DimensionCoordinate Class
An R6Class
generator object
int8
integer [optional]
uint8
integer [optional]
int16
integer [optional]
uint16
integer [optional]
int32
integer [optional]
uint32
integer [optional]
int64
integer [optional]
uint64
integer [optional]
float32
numeric [optional]
float64
numeric [optional]
new()
DimensionCoordinate$new( int8 = NULL, uint8 = NULL, int16 = NULL, uint16 = NULL, int32 = NULL, uint32 = NULL, int64 = NULL, uint64 = NULL, float32 = NULL, float64 = NULL, ... )
toJSON()
DimensionCoordinate$toJSON()
fromJSON()
DimensionCoordinate$fromJSON(DimensionCoordinateJson)
toJSONString()
DimensionCoordinate$toJSONString()
fromJSONString()
DimensionCoordinate$fromJSONString(DimensionCoordinateJson)
clone()
The objects of this class are cloneable with this method.
DimensionCoordinate$clone(deep = FALSE)
deep
Whether to make a deep clone.
DimensionTileExtent Class
An R6Class
generator object
int8
integer [optional]
uint8
integer [optional]
int16
integer [optional]
uint16
integer [optional]
int32
integer [optional]
uint32
integer [optional]
int64
integer [optional]
uint64
integer [optional]
float32
integer [optional]
float64
integer [optional]
new()
DimensionTileExtent$new( int8 = NULL, uint8 = NULL, int16 = NULL, uint16 = NULL, int32 = NULL, uint32 = NULL, int64 = NULL, uint64 = NULL, float32 = NULL, float64 = NULL, ... )
toJSON()
DimensionTileExtent$toJSON()
fromJSON()
DimensionTileExtent$fromJSON(DimensionTileExtentJson)
toJSONString()
DimensionTileExtent$toJSONString()
fromJSONString()
DimensionTileExtent$fromJSONString(DimensionTileExtentJson)
clone()
The objects of this class are cloneable with this method.
DimensionTileExtent$clone(deep = FALSE)
deep
Whether to make a deep clone.
Domain Class
An R6Class
generator object
new()
Domain$new(type, tileOrder, cellOrder, dimensions, ...)
toJSON()
Domain$toJSON()
fromJSON()
Domain$fromJSON(DomainJson)
toJSONString()
Domain$toJSONString()
fromJSONString()
Domain$fromJSONString(DomainJson)
clone()
The objects of this class are cloneable with this method.
Domain$clone(deep = FALSE)
deep
Whether to make a deep clone.
DomainArray Class
An R6Class
generator object
int8
list( integer ) [optional]
uint8
list( integer ) [optional]
int16
list( integer ) [optional]
uint16
list( integer ) [optional]
int32
list( integer ) [optional]
uint32
list( integer ) [optional]
int64
list( integer ) [optional]
uint64
list( integer ) [optional]
float32
list( numeric ) [optional]
float64
list( numeric ) [optional]
new()
DomainArray$new( int8 = NULL, uint8 = NULL, int16 = NULL, uint16 = NULL, int32 = NULL, uint32 = NULL, int64 = NULL, uint64 = NULL, float32 = NULL, float64 = NULL, ... )
toJSON()
DomainArray$toJSON()
fromJSON()
DomainArray$fromJSON(DomainArrayJson)
toJSONString()
DomainArray$toJSONString()
fromJSONString()
DomainArray$fromJSONString(DomainArrayJson)
clone()
The objects of this class are cloneable with this method.
DomainArray$clone(deep = FALSE)
deep
Whether to make a deep clone.
Error Class
An R6Class
generator object
code
integer [optional]
message
character [optional]
request_id
character [optional]
new()
Error$new(code = NULL, message = NULL, request_id = NULL, ...)
toJSON()
Error$toJSON()
fromJSON()
Error$fromJSON(ErrorJson)
toJSONString()
Error$toJSONString()
fromJSONString()
Error$fromJSONString(ErrorJson)
clone()
The objects of this class are cloneable with this method.
Error$clone(deep = FALSE)
deep
Whether to make a deep clone.
This invokes a user-defined function in TileDB Cloud.
execute_array_udf( array, udf = NULL, registered_udf_name = NULL, selectedRanges, attrs = NULL, layout = NULL, args = NULL, result_format = "native", args_format = "native", namespace = NULL, language = "r", resource_class = NULL )
execute_array_udf( array, udf = NULL, registered_udf_name = NULL, selectedRanges, attrs = NULL, layout = NULL, args = NULL, result_format = "native", args_format = "native", namespace = NULL, language = "r", resource_class = NULL )
array |
Name of the array, in the form either |
udf |
An R function which takes a dataframe as argument.
Arguments are specified separately via |
registered_udf_name |
Name of a registered UDF, of the form |
selectedRanges |
List of two-column matrices, one matrix per dimension,
each matrix being a start-end pair: e.g. |
attrs |
Optional list of attributes (default: all) for the server-side code to select for UDF execution. Specifying only what your UDF needs is useful for memory-usage control. |
layout |
One of |
args |
Arguments to the function. If the function takes
no arguments, this can be omitted. If you want to call by
position, use a list like |
result_format |
One of |
args_format |
One of |
namespace |
Namespace within TileDB cloud to charge. If this is null, the logged-in user's username will be used for the namespace. |
language |
If omitted, defaults to |
resource_class |
The resource class to use for the UDF execution. Resource classes define
resource limits for memory and CPUs. If this is 'NULL', then the UDF will execute in the
standard resource class of the TileDB Cloud provider. This can be set to |
Nominally you will first call login
; if not, the results
of the last login at ~/.tiledb/cloud.json
will be used.
All arguments are required.
Return value from the UDF.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
This invokes a user-defined function in TileDB Cloud.
execute_generic_udf( udf = NULL, registered_udf_name = NULL, args = NULL, result_format = "native", args_format = "native", namespace = NULL, language = "r", resource_class = NULL )
execute_generic_udf( udf = NULL, registered_udf_name = NULL, args = NULL, result_format = "native", args_format = "native", namespace = NULL, language = "r", resource_class = NULL )
udf |
An R function. Arguments are specified separately via |
registered_udf_name |
Name of a registered UDF, of the form |
args |
Arguments to the function. If the function takes
no arguments, this can be omitted. If you want to call by
position, use a list like |
result_format |
One of |
args_format |
One of |
namespace |
Namespace within TileDB cloud to charge. If this is null, the logged-in user's username will be used for the namespace. |
language |
If omitted, defaults to |
resource_class |
The resource class to use for the UDF execution. Resource classes define
resource limits for memory and CPUs. If this is 'NULL', then the UDF will execute in the
standard resource class of the TileDB Cloud provider. This can be set to |
Nominally you will first call login
; if not, the results
of the last login at ~/.tiledb/cloud.json
will be used.
The udf
and namespace
arguments are required; the args
argument is optional.
The R object which is the return value from the UDF.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
This invokes a user-defined function in TileDB Cloud.
execute_multi_array_udf( array_list, udf = NULL, registered_udf_name = NULL, args = NULL, result_format = "native", args_format = "native", namespace = NULL, language = "r", resource_class = NULL )
execute_multi_array_udf( array_list, udf = NULL, registered_udf_name = NULL, args = NULL, result_format = "native", args_format = "native", namespace = NULL, language = "r", resource_class = NULL )
array_list |
List of |
udf |
An R function which takes dataframes as arguments, one dataframe argument for each element in |
registered_udf_name |
Name of a registered UDF, of the form |
args |
Arguments to the function. If the function takes
no arguments, this can be omitted. If you want to call by
position, use a list like |
result_format |
One of |
args_format |
One of |
namespace |
Namespace within TileDB cloud to charge. If this is null, the logged-in user's username will be used for the namespace. |
language |
If omitted, defaults to |
resource_class |
The resource class to use for the UDF execution. Resource classes define
resource limits for memory and CPUs. If this is 'NULL', then the UDF will execute in the
standard resource class of the TileDB Cloud provider. This can be set to |
Nominally you will first call login
; if not, the results
of the last login at ~/.tiledb/cloud.json
will be used.
All arguments are required.
Return value from the UDF.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
This invokes a user-defined function in TileDB Cloud.
execute_sql_query(query, name = NULL, namespace = NULL)
execute_sql_query(query, name = NULL, namespace = NULL)
query |
SQL query as a string. |
name |
A descriptive name to give the query. |
namespace |
Namespace within TileDB cloud to charge. If this is null, the logged-in user's username will be used for the namespace. |
Nominally you will first call login
; if not, the results
of the last login at ~/.tiledb/cloud.json
will be used.
The udf
and namespace
arguments are required; the args
argument is optional.
The result of the SQL query.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
tiledbcloud.Favorites
An R6Class
generator object
AddArrayFavorite Add a new array favorite
@param namespace character
@param name character
status code : 204 | Item added to favorites successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
AddMLModelFavorite Add a new ML model favorite
@param namespace character
@param name character
status code : 204 | Item added to favorites successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
AddNotebookFavorite Add a new notebook favorite
@param namespace character
@param name character
status code : 204 | Item added to favorites successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
AddUDFFavorite Add a new UDF favorite
@param namespace character
@param name character
status code : 204 | Item added to favorites successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteArrayFavorite Delete specific array favorite
@param namespace character
@param name character
status code : 204 | array favorite item deleted successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteMLModelFavorite Delete specific ML model favorite
@param namespace character
@param name character
status code : 204 | ML model favorite item deleted successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteNotebookFavorite Delete specific notebook favorite
@param namespace character
@param name character
status code : 204 | notebook favorite item deleted successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteUDFFavorite Delete specific UDF favorite
@param namespace character
@param name character
status code : 204 | UDF favorite item deleted successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
GetArrayFavorite Fetch array favorite of a specific array
@param namespace character
@param name character
@returnType ArrayFavorite
status code : 200 | OK
return type : ArrayFavorite
response headers :
status code : 0 | error response
return type : Error
response headers :
GetMLModelFavorite Fetch ML model favorite of a specific ML model
@param namespace character
@param name character
@returnType MLModelFavorite
status code : 200 | OK
return type : MLModelFavorite
response headers :
status code : 0 | error response
return type : Error
response headers :
GetNotebookFavorite Fetch notebook favorite of a specific notebook
@param namespace character
@param name character
@returnType NotebookFavorite
status code : 200 | OK
return type : NotebookFavorite
response headers :
status code : 0 | error response
return type : Error
response headers :
GetUDFFavorite Fetch UDF favorite of a specific UDF
@param namespace character
@param name character
@returnType UDFFavorite
status code : 200 | OK
return type : UDFFavorite
response headers :
status code : 0 | error response
return type : Error
response headers :
ListArrayFavorites Fetch a page of array favorites of connected user
@param page integer
@param per.page integer
@returnType ArrayFavoritesData
status code : 200 | Available array favorites are returned
return type : ArrayFavoritesData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListArrayFavoritesUUIDs Fetch all favorite array uuids of connected user
@returnType list( ArrayFavorite )
status code : 200 | Available favorites array uuids are returned
return type : array[ArrayFavorite]
response headers :
status code : 0 | error response
return type : Error
response headers :
ListMLModelFavorites Fetch a page of ML models favorites of connected user
@param page integer
@param per.page integer
@returnType MLModelFavoritesData
status code : 200 | Available ML models favorites are returned
return type : MLModelFavoritesData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListMLModelFavoritesUUIDs Fetch all favorite ML models uuids of connected user
@returnType list( MLModelFavorite )
status code : 200 | Available favorites ML model uuids are returned
return type : array[MLModelFavorite]
response headers :
status code : 0 | error response
return type : Error
response headers :
ListNotebookFavorites Fetch a page of notebook favorites of connected user
@param is.dashboard character
@param page integer
@param per.page integer
@returnType NotebookFavoritesData
status code : 200 | Available notebook favorites are returned
return type : NotebookFavoritesData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListNotebookFavoritesUUIDs Fetch all favorite notebook uuids of connected user
@returnType list( NotebookFavorite )
status code : 200 | Available favorites notebook uuids are returned
return type : array[NotebookFavorite]
response headers :
status code : 0 | error response
return type : Error
response headers :
ListUDFFavorites Fetch a page of UDF favorites of connected user
@param page integer
@param per.page integer
@returnType UDFFavoritesData
status code : 200 | Available UDF favorites are returned
return type : UDFFavoritesData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListUDFFavoritesUUIDs Fetch all favorite UDF uuids of connected user
@returnType list( UDFFavorite )
status code : 200 | Available favorites UDF uuids are returned
return type : array[UDFFavorite]
response headers :
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
FavoritesApi$new(apiClient)
AddArrayFavorite()
FavoritesApi$AddArrayFavorite(namespace, name, ...)
AddArrayFavoriteWithHttpInfo()
FavoritesApi$AddArrayFavoriteWithHttpInfo(namespace, name, ...)
AddMLModelFavorite()
FavoritesApi$AddMLModelFavorite(namespace, name, ...)
AddMLModelFavoriteWithHttpInfo()
FavoritesApi$AddMLModelFavoriteWithHttpInfo(namespace, name, ...)
AddNotebookFavorite()
FavoritesApi$AddNotebookFavorite(namespace, name, ...)
AddNotebookFavoriteWithHttpInfo()
FavoritesApi$AddNotebookFavoriteWithHttpInfo(namespace, name, ...)
AddUDFFavorite()
FavoritesApi$AddUDFFavorite(namespace, name, ...)
AddUDFFavoriteWithHttpInfo()
FavoritesApi$AddUDFFavoriteWithHttpInfo(namespace, name, ...)
DeleteArrayFavorite()
FavoritesApi$DeleteArrayFavorite(namespace, name, ...)
DeleteArrayFavoriteWithHttpInfo()
FavoritesApi$DeleteArrayFavoriteWithHttpInfo(namespace, name, ...)
DeleteMLModelFavorite()
FavoritesApi$DeleteMLModelFavorite(namespace, name, ...)
DeleteMLModelFavoriteWithHttpInfo()
FavoritesApi$DeleteMLModelFavoriteWithHttpInfo(namespace, name, ...)
DeleteNotebookFavorite()
FavoritesApi$DeleteNotebookFavorite(namespace, name, ...)
DeleteNotebookFavoriteWithHttpInfo()
FavoritesApi$DeleteNotebookFavoriteWithHttpInfo(namespace, name, ...)
DeleteUDFFavorite()
FavoritesApi$DeleteUDFFavorite(namespace, name, ...)
DeleteUDFFavoriteWithHttpInfo()
FavoritesApi$DeleteUDFFavoriteWithHttpInfo(namespace, name, ...)
GetArrayFavorite()
FavoritesApi$GetArrayFavorite(namespace, name, ...)
GetArrayFavoriteWithHttpInfo()
FavoritesApi$GetArrayFavoriteWithHttpInfo(namespace, name, ...)
GetMLModelFavorite()
FavoritesApi$GetMLModelFavorite(namespace, name, ...)
GetMLModelFavoriteWithHttpInfo()
FavoritesApi$GetMLModelFavoriteWithHttpInfo(namespace, name, ...)
GetNotebookFavorite()
FavoritesApi$GetNotebookFavorite(namespace, name, ...)
GetNotebookFavoriteWithHttpInfo()
FavoritesApi$GetNotebookFavoriteWithHttpInfo(namespace, name, ...)
GetUDFFavorite()
FavoritesApi$GetUDFFavorite(namespace, name, ...)
GetUDFFavoriteWithHttpInfo()
FavoritesApi$GetUDFFavoriteWithHttpInfo(namespace, name, ...)
ListArrayFavorites()
FavoritesApi$ListArrayFavorites(page = NULL, per.page = NULL, ...)
ListArrayFavoritesWithHttpInfo()
FavoritesApi$ListArrayFavoritesWithHttpInfo(page = NULL, per.page = NULL, ...)
ListArrayFavoritesUUIDs()
FavoritesApi$ListArrayFavoritesUUIDs(...)
ListArrayFavoritesUUIDsWithHttpInfo()
FavoritesApi$ListArrayFavoritesUUIDsWithHttpInfo(...)
ListMLModelFavorites()
FavoritesApi$ListMLModelFavorites(page = NULL, per.page = NULL, ...)
ListMLModelFavoritesWithHttpInfo()
FavoritesApi$ListMLModelFavoritesWithHttpInfo( page = NULL, per.page = NULL, ... )
ListMLModelFavoritesUUIDs()
FavoritesApi$ListMLModelFavoritesUUIDs(...)
ListMLModelFavoritesUUIDsWithHttpInfo()
FavoritesApi$ListMLModelFavoritesUUIDsWithHttpInfo(...)
ListNotebookFavorites()
FavoritesApi$ListNotebookFavorites( is.dashboard = NULL, page = NULL, per.page = NULL, ... )
ListNotebookFavoritesWithHttpInfo()
FavoritesApi$ListNotebookFavoritesWithHttpInfo( is.dashboard = NULL, page = NULL, per.page = NULL, ... )
ListNotebookFavoritesUUIDs()
FavoritesApi$ListNotebookFavoritesUUIDs(...)
ListNotebookFavoritesUUIDsWithHttpInfo()
FavoritesApi$ListNotebookFavoritesUUIDsWithHttpInfo(...)
ListUDFFavorites()
FavoritesApi$ListUDFFavorites(page = NULL, per.page = NULL, ...)
ListUDFFavoritesWithHttpInfo()
FavoritesApi$ListUDFFavoritesWithHttpInfo(page = NULL, per.page = NULL, ...)
ListUDFFavoritesUUIDs()
FavoritesApi$ListUDFFavoritesUUIDs(...)
ListUDFFavoritesUUIDsWithHttpInfo()
FavoritesApi$ListUDFFavoritesUUIDsWithHttpInfo(...)
clone()
The objects of this class are cloneable with this method.
FavoritesApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run: #################### AddArrayFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the array var.name <- 'name_example' # character | The name of the array api.instance <- FavoritesApi$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$AddArrayFavorite(var.namespace, var.name) #################### AddMLModelFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the ML model var.name <- 'name_example' # character | The name of the ML model api.instance <- FavoritesApi$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$AddMLModelFavorite(var.namespace, var.name) #################### AddNotebookFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the notebook var.name <- 'name_example' # character | The name of the notebook api.instance <- FavoritesApi$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$AddNotebookFavorite(var.namespace, var.name) #################### AddUDFFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the UDF var.name <- 'name_example' # character | The name of the UDF api.instance <- FavoritesApi$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$AddUDFFavorite(var.namespace, var.name) #################### DeleteArrayFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the array var.name <- 'name_example' # character | The name of the array api.instance <- FavoritesApi$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$DeleteArrayFavorite(var.namespace, var.name) #################### DeleteMLModelFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the ML model var.name <- 'name_example' # character | The name of the ML model api.instance <- FavoritesApi$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$DeleteMLModelFavorite(var.namespace, var.name) #################### DeleteNotebookFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the notebook var.name <- 'name_example' # character | The name of the notebook api.instance <- FavoritesApi$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$DeleteNotebookFavorite(var.namespace, var.name) #################### DeleteUDFFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the UDF var.name <- 'name_example' # character | The name of the UDF api.instance <- FavoritesApi$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$DeleteUDFFavorite(var.namespace, var.name) #################### GetArrayFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the array var.name <- 'name_example' # character | The name of the array api.instance <- FavoritesApi$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$GetArrayFavorite(var.namespace, var.name) #################### GetMLModelFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the ML model var.name <- 'name_example' # character | The name of the ML model api.instance <- FavoritesApi$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$GetMLModelFavorite(var.namespace, var.name) #################### GetNotebookFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the notebook var.name <- 'name_example' # character | The name of the notebook api.instance <- FavoritesApi$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$GetNotebookFavorite(var.namespace, var.name) #################### GetUDFFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the UDF var.name <- 'name_example' # character | The name of the UDF api.instance <- FavoritesApi$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$GetUDFFavorite(var.namespace, var.name) #################### ListArrayFavorites #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- FavoritesApi$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$ListArrayFavorites(page=var.page, per.page=var.per.page) #################### ListArrayFavoritesUUIDs #################### library(tiledbcloud) api.instance <- FavoritesApi$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$ListArrayFavoritesUUIDs() #################### ListMLModelFavorites #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- FavoritesApi$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$ListMLModelFavorites(page=var.page, per.page=var.per.page) #################### ListMLModelFavoritesUUIDs #################### library(tiledbcloud) api.instance <- FavoritesApi$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$ListMLModelFavoritesUUIDs() #################### ListNotebookFavorites #################### library(tiledbcloud) var.is.dashboard <- 'is.dashboard_example' # character | return only dashboards var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- FavoritesApi$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$ListNotebookFavorites(is.dashboard=var.is.dashboard, page=var.page, per.page=var.per.page) #################### ListNotebookFavoritesUUIDs #################### library(tiledbcloud) api.instance <- FavoritesApi$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$ListNotebookFavoritesUUIDs() #################### ListUDFFavorites #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- FavoritesApi$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$ListUDFFavorites(page=var.page, per.page=var.per.page) #################### ListUDFFavoritesUUIDs #################### library(tiledbcloud) api.instance <- FavoritesApi$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$ListUDFFavoritesUUIDs() ## End(Not run)
## Not run: #################### AddArrayFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the array var.name <- 'name_example' # character | The name of the array api.instance <- FavoritesApi$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$AddArrayFavorite(var.namespace, var.name) #################### AddMLModelFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the ML model var.name <- 'name_example' # character | The name of the ML model api.instance <- FavoritesApi$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$AddMLModelFavorite(var.namespace, var.name) #################### AddNotebookFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the notebook var.name <- 'name_example' # character | The name of the notebook api.instance <- FavoritesApi$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$AddNotebookFavorite(var.namespace, var.name) #################### AddUDFFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the UDF var.name <- 'name_example' # character | The name of the UDF api.instance <- FavoritesApi$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$AddUDFFavorite(var.namespace, var.name) #################### DeleteArrayFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the array var.name <- 'name_example' # character | The name of the array api.instance <- FavoritesApi$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$DeleteArrayFavorite(var.namespace, var.name) #################### DeleteMLModelFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the ML model var.name <- 'name_example' # character | The name of the ML model api.instance <- FavoritesApi$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$DeleteMLModelFavorite(var.namespace, var.name) #################### DeleteNotebookFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the notebook var.name <- 'name_example' # character | The name of the notebook api.instance <- FavoritesApi$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$DeleteNotebookFavorite(var.namespace, var.name) #################### DeleteUDFFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the UDF var.name <- 'name_example' # character | The name of the UDF api.instance <- FavoritesApi$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$DeleteUDFFavorite(var.namespace, var.name) #################### GetArrayFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the array var.name <- 'name_example' # character | The name of the array api.instance <- FavoritesApi$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$GetArrayFavorite(var.namespace, var.name) #################### GetMLModelFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the ML model var.name <- 'name_example' # character | The name of the ML model api.instance <- FavoritesApi$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$GetMLModelFavorite(var.namespace, var.name) #################### GetNotebookFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the notebook var.name <- 'name_example' # character | The name of the notebook api.instance <- FavoritesApi$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$GetNotebookFavorite(var.namespace, var.name) #################### GetUDFFavorite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the UDF var.name <- 'name_example' # character | The name of the UDF api.instance <- FavoritesApi$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$GetUDFFavorite(var.namespace, var.name) #################### ListArrayFavorites #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- FavoritesApi$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$ListArrayFavorites(page=var.page, per.page=var.per.page) #################### ListArrayFavoritesUUIDs #################### library(tiledbcloud) api.instance <- FavoritesApi$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$ListArrayFavoritesUUIDs() #################### ListMLModelFavorites #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- FavoritesApi$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$ListMLModelFavorites(page=var.page, per.page=var.per.page) #################### ListMLModelFavoritesUUIDs #################### library(tiledbcloud) api.instance <- FavoritesApi$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$ListMLModelFavoritesUUIDs() #################### ListNotebookFavorites #################### library(tiledbcloud) var.is.dashboard <- 'is.dashboard_example' # character | return only dashboards var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- FavoritesApi$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$ListNotebookFavorites(is.dashboard=var.is.dashboard, page=var.page, per.page=var.per.page) #################### ListNotebookFavoritesUUIDs #################### library(tiledbcloud) api.instance <- FavoritesApi$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$ListNotebookFavoritesUUIDs() #################### ListUDFFavorites #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- FavoritesApi$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$ListUDFFavorites(page=var.page, per.page=var.per.page) #################### ListUDFFavoritesUUIDs #################### library(tiledbcloud) api.instance <- FavoritesApi$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$ListUDFFavoritesUUIDs() ## End(Not run)
FileCreate Class
An R6Class
generator object
input_uri
character [optional]
output_uri
character [optional]
name
character [optional]
new()
FileCreate$new(input_uri = NULL, output_uri = NULL, name = NULL, ...)
toJSON()
FileCreate$toJSON()
fromJSON()
FileCreate$fromJSON(FileCreateJson)
toJSONString()
FileCreate$toJSONString()
fromJSONString()
FileCreate$fromJSONString(FileCreateJson)
clone()
The objects of this class are cloneable with this method.
FileCreate$clone(deep = FALSE)
deep
Whether to make a deep clone.
FileCreated Class
An R6Class
generator object
output_uri
character [optional]
file_name
character [optional]
new()
FileCreated$new(output_uri = NULL, file_name = NULL, ...)
toJSON()
FileCreated$toJSON()
fromJSON()
FileCreated$fromJSON(FileCreatedJson)
toJSONString()
FileCreated$toJSONString()
fromJSONString()
FileCreated$fromJSONString(FileCreatedJson)
clone()
The objects of this class are cloneable with this method.
FileCreated$clone(deep = FALSE)
deep
Whether to make a deep clone.
FileExport Class
An R6Class
generator object
output_uri
character [optional]
new()
FileExport$new(output_uri = NULL, ...)
toJSON()
FileExport$toJSON()
fromJSON()
FileExport$fromJSON(FileExportJson)
toJSONString()
FileExport$toJSONString()
fromJSONString()
FileExport$fromJSONString(FileExportJson)
clone()
The objects of this class are cloneable with this method.
FileExport$clone(deep = FALSE)
deep
Whether to make a deep clone.
FileExported Class
An R6Class
generator object
output_uri
character [optional]
new()
FileExported$new(output_uri = NULL, ...)
toJSON()
FileExported$toJSON()
fromJSON()
FileExported$fromJSON(FileExportedJson)
toJSONString()
FileExported$toJSONString()
fromJSONString()
FileExported$fromJSONString(FileExportedJson)
clone()
The objects of this class are cloneable with this method.
FileExported$clone(deep = FALSE)
deep
Whether to make a deep clone.
FilePropertyName Class
An R6Class
generator object
new()
FilePropertyName$new(...)
toJSON()
FilePropertyName$toJSON()
fromJSON()
FilePropertyName$fromJSON(FilePropertyNameJson)
toJSONString()
FilePropertyName$toJSONString()
fromJSONString()
FilePropertyName$fromJSONString(FilePropertyNameJson)
clone()
The objects of this class are cloneable with this method.
FilePropertyName$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.Files
An R6Class
generator object
HandleCreateFile Create a tiledb file at the specified location
@param namespace character
@param file.create FileCreate
@param X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME character
@returnType FileCreated
status code : 201 | File created
return type : FileCreated
response headers :
status code : 0 | error response
return type : Error
response headers :
HandleExportFile Export a TileDB File back to its original file format
@param namespace character
@param file character
@param file.export FileExport
@returnType FileExported
status code : 201 | File exported
return type : FileExported
response headers :
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
FilesApi$new(apiClient)
HandleCreateFile()
FilesApi$HandleCreateFile( namespace, file.create, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = NULL, ... )
HandleCreateFileWithHttpInfo()
FilesApi$HandleCreateFileWithHttpInfo( namespace, file.create, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = NULL, ... )
HandleExportFile()
FilesApi$HandleExportFile(namespace, file, file.export, ...)
HandleExportFileWithHttpInfo()
FilesApi$HandleExportFileWithHttpInfo(namespace, file, file.export, ...)
clone()
The objects of this class are cloneable with this method.
FilesApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run: #################### HandleCreateFile #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the file var.file.create <- FileCreate$new() # FileCreate | Input/Output information to create a new TileDB file var.X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME <- 'X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME_example' # character | Optional registered access credentials to use for creation api.instance <- FilesApi$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$HandleCreateFile(var.namespace, var.file.create, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME=var.X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME) #################### HandleExportFile #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the file var.file <- 'file_example' # character | The file identifier var.file.export <- FileExport$new() # FileExport | Export configuration information api.instance <- FilesApi$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$HandleExportFile(var.namespace, var.file, var.file.export) ## End(Not run)
## Not run: #################### HandleCreateFile #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the file var.file.create <- FileCreate$new() # FileCreate | Input/Output information to create a new TileDB file var.X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME <- 'X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME_example' # character | Optional registered access credentials to use for creation api.instance <- FilesApi$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$HandleCreateFile(var.namespace, var.file.create, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME=var.X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME) #################### HandleExportFile #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the file var.file <- 'file_example' # character | The file identifier var.file.export <- FileExport$new() # FileExport | Export configuration information api.instance <- FilesApi$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$HandleExportFile(var.namespace, var.file, var.file.export) ## End(Not run)
FileType Class
An R6Class
generator object
new()
FileType$new(...)
toJSON()
FileType$toJSON()
fromJSON()
FileType$fromJSON(FileTypeJson)
toJSONString()
FileType$toJSONString()
fromJSONString()
FileType$fromJSONString(FileTypeJson)
clone()
The objects of this class are cloneable with this method.
FileType$clone(deep = FALSE)
deep
Whether to make a deep clone.
Filter Class
An R6Class
generator object
type
data
FilterData [optional]
new()
Filter$new(type, data = NULL, ...)
toJSON()
Filter$toJSON()
fromJSON()
Filter$fromJSON(FilterJson)
toJSONString()
Filter$toJSONString()
fromJSONString()
Filter$fromJSONString(FilterJson)
clone()
The objects of this class are cloneable with this method.
Filter$clone(deep = FALSE)
deep
Whether to make a deep clone.
FilterData Class
An R6Class
generator object
int8
integer [optional]
uint8
integer [optional]
int16
integer [optional]
uint16
integer [optional]
int32
integer [optional]
uint32
integer [optional]
int64
integer [optional]
uint64
integer [optional]
float32
integer [optional]
float64
integer [optional]
new()
FilterData$new( int8 = NULL, uint8 = NULL, int16 = NULL, uint16 = NULL, int32 = NULL, uint32 = NULL, int64 = NULL, uint64 = NULL, float32 = NULL, float64 = NULL, ... )
toJSON()
FilterData$toJSON()
fromJSON()
FilterData$fromJSON(FilterDataJson)
toJSONString()
FilterData$toJSONString()
fromJSONString()
FilterData$fromJSONString(FilterDataJson)
clone()
The objects of this class are cloneable with this method.
FilterData$clone(deep = FALSE)
deep
Whether to make a deep clone.
FilterOption Class
An R6Class
generator object
new()
FilterOption$new(...)
toJSON()
FilterOption$toJSON()
fromJSON()
FilterOption$fromJSON(FilterOptionJson)
toJSONString()
FilterOption$toJSONString()
fromJSONString()
FilterOption$fromJSONString(FilterOptionJson)
clone()
The objects of this class are cloneable with this method.
FilterOption$clone(deep = FALSE)
deep
Whether to make a deep clone.
FilterPipeline Class
An R6Class
generator object
filters
list( Filter ) [optional]
new()
FilterPipeline$new(filters = NULL, ...)
toJSON()
FilterPipeline$toJSON()
fromJSON()
FilterPipeline$fromJSON(FilterPipelineJson)
toJSONString()
FilterPipeline$toJSONString()
fromJSONString()
FilterPipeline$fromJSONString(FilterPipelineJson)
clone()
The objects of this class are cloneable with this method.
FilterPipeline$clone(deep = FALSE)
deep
Whether to make a deep clone.
FilterType Class
An R6Class
generator object
new()
FilterType$new(...)
toJSON()
FilterType$toJSON()
fromJSON()
FilterType$fromJSON(FilterTypeJson)
toJSONString()
FilterType$toJSONString()
fromJSONString()
FilterType$fromJSONString(FilterTypeJson)
clone()
The objects of this class are cloneable with this method.
FilterType$clone(deep = FALSE)
deep
Whether to make a deep clone.
GenericUDF Class
An R6Class
generator object
udf_info_name
character [optional]
language
UDFLanguage [optional]
version
character [optional]
image_name
character [optional]
resource_class
character [optional]
exec
character [optional]
exec_raw
character [optional]
argument
character [optional]
stored_param_uuids
list( character ) [optional]
result_format
ResultFormat [optional]
task_name
character [optional]
store_results
character [optional]
timeout
integer [optional]
dont_download_results
character [optional]
task_graph_uuid
character [optional]
client_node_uuid
character [optional]
new()
GenericUDF$new( udf_info_name = NULL, language = NULL, version = NULL, image_name = NULL, resource_class = NULL, exec = NULL, exec_raw = NULL, argument = NULL, stored_param_uuids = NULL, result_format = NULL, task_name = NULL, store_results = NULL, timeout = NULL, dont_download_results = NULL, task_graph_uuid = NULL, client_node_uuid = NULL, ... )
toJSON()
GenericUDF$toJSON()
fromJSON()
GenericUDF$fromJSON(GenericUDFJson)
toJSONString()
GenericUDF$toJSONString()
fromJSONString()
GenericUDF$fromJSONString(GenericUDFJson)
clone()
The objects of this class are cloneable with this method.
GenericUDF$clone(deep = FALSE)
deep
Whether to make a deep clone.
This is a package-internal function.
get_api_client_instance()
get_api_client_instance()
It returns the cached ApiClient
object, or stops. The
ApiClient
instance is constructor input to UserApi
,
ArrayApi
, etc. as generated by OpenAPI. Note that
with in the OpenAPI autogen code, there is the ApiClient
instance which is used as constructor input to UserApi
,
ArrayApi
, UdfAPI
, etc.
The cached ApiClient
object, or stops.
Reads back information for a specified user-defined function on TileDB Cloud.
Note that version
, image_name
, exec
, and exec_raw
are writable via register_udf
but are not read back by this function.
get_udf_info(name, namespace)
get_udf_info(name, namespace)
name |
Name of the UDF in TileDB Cloud, e.g. |
namespace |
Namespace for the UDF in TileDB Cloud, e.g. |
List of key-value pairs of UDF information.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
Group Class
An R6Class
generator object
id
character [optional]
namespace
character [optional]
name
character [optional]
description
character [optional]
new()
Group$new(id = NULL, namespace = NULL, name = NULL, description = NULL, ...)
toJSON()
Group$toJSON()
fromJSON()
Group$fromJSON(GroupJson)
toJSONString()
Group$toJSONString()
fromJSONString()
Group$fromJSONString(GroupJson)
clone()
The objects of this class are cloneable with this method.
Group$clone(deep = FALSE)
deep
Whether to make a deep clone.
Show information about a group on TileDB Cloud.
group_info(namespace, name)
group_info(namespace, name)
namespace |
Like "TileDB-Inc" |
name |
Name of the group |
A list of properties
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
GroupActions Class
An R6Class
generator object
new()
GroupActions$new(...)
toJSON()
GroupActions$toJSON()
fromJSON()
GroupActions$fromJSON(GroupActionsJson)
toJSONString()
GroupActions$toJSONString()
fromJSONString()
GroupActions$fromJSONString(GroupActionsJson)
clone()
The objects of this class are cloneable with this method.
GroupActions$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupBrowserData Class
An R6Class
generator object
groups
list( GroupInfo ) [optional]
pagination_metadata
PaginationMetadata [optional]
new()
GroupBrowserData$new(groups = NULL, pagination_metadata = NULL, ...)
toJSON()
GroupBrowserData$toJSON()
fromJSON()
GroupBrowserData$fromJSON(GroupBrowserDataJson)
toJSONString()
GroupBrowserData$toJSONString()
fromJSONString()
GroupBrowserData$fromJSONString(GroupBrowserDataJson)
clone()
The objects of this class are cloneable with this method.
GroupBrowserData$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupBrowserFilterData Class
An R6Class
generator object
namespaces
list( character ) [optional]
new()
GroupBrowserFilterData$new(namespaces = NULL, ...)
toJSON()
GroupBrowserFilterData$toJSON()
fromJSON()
GroupBrowserFilterData$fromJSON(GroupBrowserFilterDataJson)
toJSONString()
GroupBrowserFilterData$toJSONString()
fromJSONString()
GroupBrowserFilterData$fromJSONString(GroupBrowserFilterDataJson)
clone()
The objects of this class are cloneable with this method.
GroupBrowserFilterData$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupChanges Class
An R6Class
generator object
add
list( GroupMember ) [optional]
remove
list( GroupMember ) [optional]
new()
GroupChanges$new(add = NULL, remove = NULL, ...)
toJSON()
GroupChanges$toJSON()
fromJSON()
GroupChanges$fromJSON(GroupChangesJson)
toJSONString()
GroupChanges$toJSONString()
fromJSONString()
GroupChanges$fromJSONString(GroupChangesJson)
clone()
The objects of this class are cloneable with this method.
GroupChanges$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupContents Class
An R6Class
generator object
entries
list( GroupEntry ) [optional]
pagination_metadata
PaginationMetadata [optional]
new()
GroupContents$new(entries = NULL, pagination_metadata = NULL, ...)
toJSON()
GroupContents$toJSON()
fromJSON()
GroupContents$fromJSON(GroupContentsJson)
toJSONString()
GroupContents$toJSONString()
fromJSONString()
GroupContents$fromJSONString(GroupContentsJson)
clone()
The objects of this class are cloneable with this method.
GroupContents$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupContentsFilterData Class
An R6Class
generator object
namespaces
list( character ) [optional]
new()
GroupContentsFilterData$new(namespaces = NULL, ...)
toJSON()
GroupContentsFilterData$toJSON()
fromJSON()
GroupContentsFilterData$fromJSON(GroupContentsFilterDataJson)
toJSONString()
GroupContentsFilterData$toJSONString()
fromJSONString()
GroupContentsFilterData$fromJSONString(GroupContentsFilterDataJson)
clone()
The objects of this class are cloneable with this method.
GroupContentsFilterData$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupCreate Class
An R6Class
generator object
description
character [optional]
name
character [optional]
parent
character [optional]
uri
character [optional]
logo
character [optional]
access_credentials_name
character [optional]
tags
list( character ) [optional]
license_id
character [optional]
license_text
character [optional]
new()
GroupCreate$new( description = NULL, name = NULL, parent = NULL, uri = NULL, logo = NULL, access_credentials_name = NULL, tags = NULL, license_id = NULL, license_text = NULL, ... )
toJSON()
GroupCreate$toJSON()
fromJSON()
GroupCreate$fromJSON(GroupCreateJson)
toJSONString()
GroupCreate$toJSONString()
fromJSONString()
GroupCreate$fromJSONString(GroupCreateJson)
clone()
The objects of this class are cloneable with this method.
GroupCreate$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupEntry Class
An R6Class
generator object
new()
GroupEntry$new(member_id = NULL, group = NULL, array = NULL, ...)
toJSON()
GroupEntry$toJSON()
fromJSON()
GroupEntry$fromJSON(GroupEntryJson)
toJSONString()
GroupEntry$toJSONString()
fromJSONString()
GroupEntry$fromJSONString(GroupEntryJson)
clone()
The objects of this class are cloneable with this method.
GroupEntry$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupInfo Class
An R6Class
generator object
id
character [optional]
namespace
character [optional]
name
character [optional]
description
character [optional]
uri
character [optional]
tiledb_uri
character [optional]
asset_count
numeric [optional]
group_count
numeric [optional]
size
numeric [optional]
last_accessed
character [optional]
allowed_actions
list( GroupActions ) [optional]
logo
character [optional]
access_credentials_name
character [optional]
share_count
numeric [optional]
public_share
character [optional]
tags
list( character ) [optional]
license_id
character [optional]
license_text
character [optional]
new()
GroupInfo$new( id = NULL, namespace = NULL, name = NULL, description = NULL, uri = NULL, tiledb_uri = NULL, asset_count = NULL, group_count = NULL, size = NULL, last_accessed = NULL, allowed_actions = NULL, logo = NULL, access_credentials_name = NULL, share_count = NULL, public_share = NULL, tags = NULL, license_id = NULL, license_text = NULL, ... )
toJSON()
GroupInfo$toJSON()
fromJSON()
GroupInfo$fromJSON(GroupInfoJson)
toJSONString()
GroupInfo$toJSONString()
fromJSONString()
GroupInfo$fromJSONString(GroupInfoJson)
clone()
The objects of this class are cloneable with this method.
GroupInfo$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupListing Class
An R6Class
generator object
id
character [optional]
namespace
character [optional]
name
character [optional]
description
character [optional]
groups
list( Group ) [optional]
assets
list( ArrayInfo ) [optional]
pagination_metadata
PaginationMetadata [optional]
new()
GroupListing$new( id = NULL, namespace = NULL, name = NULL, description = NULL, groups = NULL, assets = NULL, pagination_metadata = NULL, ... )
toJSON()
GroupListing$toJSON()
fromJSON()
GroupListing$fromJSON(GroupListingJson)
toJSONString()
GroupListing$toJSONString()
fromJSONString()
GroupListing$fromJSONString(GroupListingJson)
clone()
The objects of this class are cloneable with this method.
GroupListing$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupListingAllOf Class
An R6Class
generator object
groups
list( Group ) [optional]
assets
list( ArrayInfo ) [optional]
pagination_metadata
PaginationMetadata [optional]
new()
GroupListingAllOf$new( groups = NULL, assets = NULL, pagination_metadata = NULL, ... )
toJSON()
GroupListingAllOf$toJSON()
fromJSON()
GroupListingAllOf$fromJSON(GroupListingAllOfJson)
toJSONString()
GroupListingAllOf$toJSONString()
fromJSONString()
GroupListingAllOf$fromJSONString(GroupListingAllOfJson)
clone()
The objects of this class are cloneable with this method.
GroupListingAllOf$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupMember Class
An R6Class
generator object
namespace
character [optional]
name
character [optional]
member_type
GroupMemberType [optional]
new()
GroupMember$new(namespace = NULL, name = NULL, member_type = NULL, ...)
toJSON()
GroupMember$toJSON()
fromJSON()
GroupMember$fromJSON(GroupMemberJson)
toJSONString()
GroupMember$toJSONString()
fromJSONString()
GroupMember$fromJSONString(GroupMemberJson)
clone()
The objects of this class are cloneable with this method.
GroupMember$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupMemberAssetType Class
An R6Class
generator object
new()
GroupMemberAssetType$new(...)
toJSON()
GroupMemberAssetType$toJSON()
fromJSON()
GroupMemberAssetType$fromJSON(GroupMemberAssetTypeJson)
toJSONString()
GroupMemberAssetType$toJSONString()
fromJSONString()
GroupMemberAssetType$fromJSONString(GroupMemberAssetTypeJson)
clone()
The objects of this class are cloneable with this method.
GroupMemberAssetType$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupMemberType Class
An R6Class
generator object
new()
GroupMemberType$new(...)
toJSON()
GroupMemberType$toJSON()
fromJSON()
GroupMemberType$fromJSON(GroupMemberTypeJson)
toJSONString()
GroupMemberType$toJSONString()
fromJSONString()
GroupMemberType$fromJSONString(GroupMemberTypeJson)
clone()
The objects of this class are cloneable with this method.
GroupMemberType$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupRegister Class
An R6Class
generator object
description
character [optional]
name
character [optional]
parent
character [optional]
uri
character [optional]
logo
character [optional]
access_credentials_name
character [optional]
tags
list( character ) [optional]
license_id
character [optional]
license_text
character [optional]
new()
GroupRegister$new( description = NULL, name = NULL, parent = NULL, uri = NULL, logo = NULL, access_credentials_name = NULL, tags = NULL, license_id = NULL, license_text = NULL, ... )
toJSON()
GroupRegister$toJSON()
fromJSON()
GroupRegister$fromJSON(GroupRegisterJson)
toJSONString()
GroupRegister$toJSONString()
fromJSONString()
GroupRegister$fromJSONString(GroupRegisterJson)
clone()
The objects of this class are cloneable with this method.
GroupRegister$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.Groups
An R6Class
generator object
ChangeGroupContents Changes the contents of the group by adding/removing members.
@param group.namespace character
@param group.name character
@param group.changes GroupChanges
status code : 204 | all changes applied successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
CreateGroup Creates a new group in the namespace.
@param namespace character
@param group.create GroupCreate
status code : 204 | group created successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteGroup Deletes the group. The assets are not deleted nor are not relocated to any other group
@param group.namespace character
@param group.name character
status code : 204 | group deleted successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
GetGroup Returns the the group
@param group.namespace character
@param group.name character
@returnType GroupInfo
status code : 200 | the group metadata
return type : GroupInfo
response headers :
status code : 0 | error response
return type : Error
response headers :
GetGroupContents Returns the contents of the group
@param group.namespace character
@param group.name character
@param page integer
@param per.page integer
@param namespace character
@param search character
@param orderby character
@param tag list( character )
@param exclude.tag list( character )
@param member.type list( character )
@param exclude.member.type list( character )
@returnType GroupContents
status code : 200 | the group contents
return type : GroupContents
response headers :
status code : 0 | error response
return type : Error
response headers :
GetGroupSharingPolicies Get all sharing details of the group
@param group.namespace character
@param group.name character
@returnType list( GroupSharing )
status code : 200 | List of all specific sharing policies
return type : array[GroupSharing]
response headers :
status code : 404 | Group does not exist or user does not have permissions to view group-sharing policies
response headers :
status code : 0 | error response
return type : Error
response headers :
GroupsBrowserOwnedFiltersGet Fetch data to initialize filters for the groups browser
@returnType GroupBrowserFilterData
status code : 200 | Filter data
return type : GroupBrowserFilterData
response headers :
status code : 0 | error response
return type : Error
response headers :
GroupsBrowserPublicFiltersGet Fetch data to initialize filters for the groups browser
@returnType GroupBrowserFilterData
status code : 200 | Filter data
return type : GroupBrowserFilterData
response headers :
status code : 0 | error response
return type : Error
response headers :
GroupsBrowserSharedFiltersGet Fetch data to initialize filters for the groups browser
@returnType GroupBrowserFilterData
status code : 200 | Filter data
return type : GroupBrowserFilterData
response headers :
status code : 0 | error response
return type : Error
response headers :
GroupsGroupNamespaceGroupNameContentsFiltersGet Fetch data to initialize filters for the group contents
@param group.namespace character
@param group.name character
@returnType GroupContentsFilterData
status code : 200 | Filter data
return type : GroupContentsFilterData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListOwnedGroups Returns one page of owned groups.
@param page integer
@param per.page integer
@param search character
@param namespace character
@param orderby character
@param permissions character
@param tag list( character )
@param exclude.tag list( character )
@param flat character
@param parent character
@returnType GroupBrowserData
status code : 200 | the group contents
return type : GroupBrowserData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListPublicGroups Returns one page of public groups.
@param page integer
@param per.page integer
@param search character
@param namespace character
@param orderby character
@param permissions character
@param tag list( character )
@param exclude.tag list( character )
@param flat character
@param parent character
@returnType GroupBrowserData
status code : 200 | the group contents
return type : GroupBrowserData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListSharedGroups Returns one page of shared groups.
@param page integer
@param per.page integer
@param search character
@param namespace character
@param orderby character
@param permissions character
@param tag list( character )
@param exclude.tag list( character )
@param flat character
@param parent character
@param shared.to list( character )
@returnType GroupBrowserData
status code : 200 | the group contents
return type : GroupBrowserData
response headers :
status code : 0 | error response
return type : Error
response headers :
RegisterGroup Registers an existing group in the namespace.
@param namespace character
@param array character
@param group.register GroupRegister
status code : 204 | group created successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
ShareGroup Share a group with a namespace
@param group.namespace character
@param group.name character
@param group.sharing.request GroupSharingRequest
status code : 204 | Group shared successfully
response headers :
status code : 404 | Group does not exist or user does not have permissions to share group
response headers :
status code : 0 | error response
return type : Error
response headers :
UpdateGroup Changes attributes of the group
@param group.namespace character
@param group.name character
@param group.update GroupUpdate
status code : 204 | attributes changed successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
GroupsApi$new(apiClient)
ChangeGroupContents()
GroupsApi$ChangeGroupContents( group.namespace, group.name, group.changes = NULL, ... )
ChangeGroupContentsWithHttpInfo()
GroupsApi$ChangeGroupContentsWithHttpInfo( group.namespace, group.name, group.changes = NULL, ... )
CreateGroup()
GroupsApi$CreateGroup(namespace, group.create = NULL, ...)
CreateGroupWithHttpInfo()
GroupsApi$CreateGroupWithHttpInfo(namespace, group.create = NULL, ...)
DeleteGroup()
GroupsApi$DeleteGroup(group.namespace, group.name, ...)
DeleteGroupWithHttpInfo()
GroupsApi$DeleteGroupWithHttpInfo(group.namespace, group.name, ...)
GetGroup()
GroupsApi$GetGroup(group.namespace, group.name, ...)
GetGroupWithHttpInfo()
GroupsApi$GetGroupWithHttpInfo(group.namespace, group.name, ...)
GetGroupContents()
GroupsApi$GetGroupContents( group.namespace, group.name, page = NULL, per.page = NULL, namespace = NULL, search = NULL, orderby = NULL, tag = NULL, exclude.tag = NULL, member.type = NULL, exclude.member.type = NULL, ... )
GetGroupContentsWithHttpInfo()
GroupsApi$GetGroupContentsWithHttpInfo( group.namespace, group.name, page = NULL, per.page = NULL, namespace = NULL, search = NULL, orderby = NULL, tag = NULL, exclude.tag = NULL, member.type = NULL, exclude.member.type = NULL, ... )
GetGroupSharingPolicies()
GroupsApi$GetGroupSharingPolicies(group.namespace, group.name, ...)
GetGroupSharingPoliciesWithHttpInfo()
GroupsApi$GetGroupSharingPoliciesWithHttpInfo(group.namespace, group.name, ...)
GroupsBrowserOwnedFiltersGet()
GroupsApi$GroupsBrowserOwnedFiltersGet(...)
GroupsBrowserOwnedFiltersGetWithHttpInfo()
GroupsApi$GroupsBrowserOwnedFiltersGetWithHttpInfo(...)
GroupsBrowserPublicFiltersGet()
GroupsApi$GroupsBrowserPublicFiltersGet(...)
GroupsBrowserPublicFiltersGetWithHttpInfo()
GroupsApi$GroupsBrowserPublicFiltersGetWithHttpInfo(...)
GroupsBrowserSharedFiltersGet()
GroupsApi$GroupsBrowserSharedFiltersGet(...)
GroupsBrowserSharedFiltersGetWithHttpInfo()
GroupsApi$GroupsBrowserSharedFiltersGetWithHttpInfo(...)
GroupsGroupNamespaceGroupNameContentsFiltersGet()
GroupsApi$GroupsGroupNamespaceGroupNameContentsFiltersGet( group.namespace, group.name, ... )
GroupsGroupNamespaceGroupNameContentsFiltersGetWithHttpInfo()
GroupsApi$GroupsGroupNamespaceGroupNameContentsFiltersGetWithHttpInfo( group.namespace, group.name, ... )
ListOwnedGroups()
GroupsApi$ListOwnedGroups( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = NULL, parent = NULL, ... )
ListOwnedGroupsWithHttpInfo()
GroupsApi$ListOwnedGroupsWithHttpInfo( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = NULL, parent = NULL, ... )
ListPublicGroups()
GroupsApi$ListPublicGroups( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = NULL, parent = NULL, ... )
ListPublicGroupsWithHttpInfo()
GroupsApi$ListPublicGroupsWithHttpInfo( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = NULL, parent = NULL, ... )
ListSharedGroups()
GroupsApi$ListSharedGroups( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = NULL, parent = NULL, shared.to = NULL, ... )
ListSharedGroupsWithHttpInfo()
GroupsApi$ListSharedGroupsWithHttpInfo( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = NULL, parent = NULL, shared.to = NULL, ... )
RegisterGroup()
GroupsApi$RegisterGroup(namespace, array, group.register = NULL, ...)
RegisterGroupWithHttpInfo()
GroupsApi$RegisterGroupWithHttpInfo( namespace, array, group.register = NULL, ... )
ShareGroup()
GroupsApi$ShareGroup(group.namespace, group.name, group.sharing.request, ...)
ShareGroupWithHttpInfo()
GroupsApi$ShareGroupWithHttpInfo( group.namespace, group.name, group.sharing.request, ... )
UpdateGroup()
GroupsApi$UpdateGroup(group.namespace, group.name, group.update = NULL, ...)
UpdateGroupWithHttpInfo()
GroupsApi$UpdateGroupWithHttpInfo( group.namespace, group.name, group.update = NULL, ... )
clone()
The objects of this class are cloneable with this method.
GroupsApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run: #################### ChangeGroupContents #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group var.group.changes <- GroupChanges$new() # GroupChanges | api.instance <- GroupsApi$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$ChangeGroupContents(var.group.namespace, var.group.name, group.changes=var.group.changes) #################### CreateGroup #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the group var.group.create <- GroupCreate$new() # GroupCreate | api.instance <- GroupsApi$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$CreateGroup(var.namespace, group.create=var.group.create) #################### DeleteGroup #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group api.instance <- GroupsApi$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$DeleteGroup(var.group.namespace, var.group.name) #################### GetGroup #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group api.instance <- GroupsApi$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$GetGroup(var.group.namespace, var.group.name) #################### GetGroupContents #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group var.page <- 56 # integer | pagination offset for assets var.per.page <- 56 # integer | pagination limit for assets var.namespace <- 'namespace_example' # character | namespace to search for 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 last_accessed, size, name var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.member.type <- ['member.type_example'] # array[character] | member type to search for, more than one can be included var.exclude.member.type <- ['exclude.member.type_example'] # array[character] | member type to exclude matching groups in results, more than one can be included api.instance <- GroupsApi$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$GetGroupContents(var.group.namespace, var.group.name, page=var.page, per.page=var.per.page, namespace=var.namespace, search=var.search, orderby=var.orderby, tag=var.tag, exclude.tag=var.exclude.tag, member.type=var.member.type, exclude.member.type=var.exclude.member.type) #################### GetGroupSharingPolicies #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group api.instance <- GroupsApi$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$GetGroupSharingPolicies(var.group.namespace, var.group.name) #################### GroupsBrowserOwnedFiltersGet #################### library(tiledbcloud) api.instance <- GroupsApi$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$GroupsBrowserOwnedFiltersGet() #################### GroupsBrowserPublicFiltersGet #################### library(tiledbcloud) api.instance <- GroupsApi$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$GroupsBrowserPublicFiltersGet() #################### GroupsBrowserSharedFiltersGet #################### library(tiledbcloud) api.instance <- GroupsApi$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$GroupsBrowserSharedFiltersGet() #################### GroupsGroupNamespaceGroupNameContentsFiltersGet #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group api.instance <- GroupsApi$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$GroupsGroupNamespaceGroupNameContentsFiltersGet(var.group.namespace, var.group.name) #################### ListOwnedGroups #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit var.search <- 'search_example' # character | search string that will look at name, namespace or description fields var.namespace <- 'namespace_example' # character | namespace var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.flat <- 'flat_example' # character | if true, ignores the nesting of groups and searches all of them var.parent <- 'parent_example' # character | search only the children of the groups with this uuid api.instance <- GroupsApi$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$ListOwnedGroups(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, flat=var.flat, parent=var.parent) #################### ListPublicGroups #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit var.search <- 'search_example' # character | search string that will look at name, namespace or description fields var.namespace <- 'namespace_example' # character | namespace var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.flat <- 'flat_example' # character | if true, ignores the nesting of groups and searches all of them var.parent <- 'parent_example' # character | search only the children of the groups with this uuid api.instance <- GroupsApi$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$ListPublicGroups(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, flat=var.flat, parent=var.parent) #################### ListSharedGroups #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit var.search <- 'search_example' # character | search string that will look at name, namespace or description fields var.namespace <- 'namespace_example' # character | namespace var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.flat <- 'flat_example' # character | if true, ignores the nesting of groups and searches all of them var.parent <- 'parent_example' # character | search only the children of the groups with this uuid var.shared.to <- ['shared.to_example'] # array[character] | namespaces to filter results of where there groups were shared to api.instance <- GroupsApi$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$ListSharedGroups(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, flat=var.flat, parent=var.parent, shared.to=var.shared.to) #################### RegisterGroup #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the group var.array <- 'array_example' # character | The unique name or id of the group var.group.register <- GroupRegister$new() # GroupRegister | api.instance <- GroupsApi$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$RegisterGroup(var.namespace, var.array, group.register=var.group.register) #################### ShareGroup #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group var.group.sharing.request <- GroupSharingRequest$new() # GroupSharingRequest | Namespace and list of permissions to share with. Sharing is recursive, it is applied to all reachable subgroups and arrays of the group. An empty list of permissions will remove the namespace; if permissions already exist they will be deleted then new ones added. In the event of a failure, the new policies will be rolled back to prevent partial policies, and it's likely the group will not be shared with the namespace at all. api.instance <- GroupsApi$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$ShareGroup(var.group.namespace, var.group.name, var.group.sharing.request) #################### UpdateGroup #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group var.group.update <- GroupUpdate$new() # GroupUpdate | api.instance <- GroupsApi$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$UpdateGroup(var.group.namespace, var.group.name, group.update=var.group.update) ## End(Not run)
## Not run: #################### ChangeGroupContents #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group var.group.changes <- GroupChanges$new() # GroupChanges | api.instance <- GroupsApi$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$ChangeGroupContents(var.group.namespace, var.group.name, group.changes=var.group.changes) #################### CreateGroup #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the group var.group.create <- GroupCreate$new() # GroupCreate | api.instance <- GroupsApi$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$CreateGroup(var.namespace, group.create=var.group.create) #################### DeleteGroup #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group api.instance <- GroupsApi$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$DeleteGroup(var.group.namespace, var.group.name) #################### GetGroup #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group api.instance <- GroupsApi$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$GetGroup(var.group.namespace, var.group.name) #################### GetGroupContents #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group var.page <- 56 # integer | pagination offset for assets var.per.page <- 56 # integer | pagination limit for assets var.namespace <- 'namespace_example' # character | namespace to search for 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 last_accessed, size, name var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.member.type <- ['member.type_example'] # array[character] | member type to search for, more than one can be included var.exclude.member.type <- ['exclude.member.type_example'] # array[character] | member type to exclude matching groups in results, more than one can be included api.instance <- GroupsApi$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$GetGroupContents(var.group.namespace, var.group.name, page=var.page, per.page=var.per.page, namespace=var.namespace, search=var.search, orderby=var.orderby, tag=var.tag, exclude.tag=var.exclude.tag, member.type=var.member.type, exclude.member.type=var.exclude.member.type) #################### GetGroupSharingPolicies #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group api.instance <- GroupsApi$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$GetGroupSharingPolicies(var.group.namespace, var.group.name) #################### GroupsBrowserOwnedFiltersGet #################### library(tiledbcloud) api.instance <- GroupsApi$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$GroupsBrowserOwnedFiltersGet() #################### GroupsBrowserPublicFiltersGet #################### library(tiledbcloud) api.instance <- GroupsApi$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$GroupsBrowserPublicFiltersGet() #################### GroupsBrowserSharedFiltersGet #################### library(tiledbcloud) api.instance <- GroupsApi$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$GroupsBrowserSharedFiltersGet() #################### GroupsGroupNamespaceGroupNameContentsFiltersGet #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group api.instance <- GroupsApi$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$GroupsGroupNamespaceGroupNameContentsFiltersGet(var.group.namespace, var.group.name) #################### ListOwnedGroups #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit var.search <- 'search_example' # character | search string that will look at name, namespace or description fields var.namespace <- 'namespace_example' # character | namespace var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.flat <- 'flat_example' # character | if true, ignores the nesting of groups and searches all of them var.parent <- 'parent_example' # character | search only the children of the groups with this uuid api.instance <- GroupsApi$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$ListOwnedGroups(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, flat=var.flat, parent=var.parent) #################### ListPublicGroups #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit var.search <- 'search_example' # character | search string that will look at name, namespace or description fields var.namespace <- 'namespace_example' # character | namespace var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.flat <- 'flat_example' # character | if true, ignores the nesting of groups and searches all of them var.parent <- 'parent_example' # character | search only the children of the groups with this uuid api.instance <- GroupsApi$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$ListPublicGroups(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, flat=var.flat, parent=var.parent) #################### ListSharedGroups #################### library(tiledbcloud) var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit var.search <- 'search_example' # character | search string that will look at name, namespace or description fields var.namespace <- 'namespace_example' # character | namespace var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included var.flat <- 'flat_example' # character | if true, ignores the nesting of groups and searches all of them var.parent <- 'parent_example' # character | search only the children of the groups with this uuid var.shared.to <- ['shared.to_example'] # array[character] | namespaces to filter results of where there groups were shared to api.instance <- GroupsApi$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$ListSharedGroups(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, flat=var.flat, parent=var.parent, shared.to=var.shared.to) #################### RegisterGroup #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace of the group var.array <- 'array_example' # character | The unique name or id of the group var.group.register <- GroupRegister$new() # GroupRegister | api.instance <- GroupsApi$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$RegisterGroup(var.namespace, var.array, group.register=var.group.register) #################### ShareGroup #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group var.group.sharing.request <- GroupSharingRequest$new() # GroupSharingRequest | Namespace and list of permissions to share with. Sharing is recursive, it is applied to all reachable subgroups and arrays of the group. An empty list of permissions will remove the namespace; if permissions already exist they will be deleted then new ones added. In the event of a failure, the new policies will be rolled back to prevent partial policies, and it's likely the group will not be shared with the namespace at all. api.instance <- GroupsApi$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$ShareGroup(var.group.namespace, var.group.name, var.group.sharing.request) #################### UpdateGroup #################### library(tiledbcloud) var.group.namespace <- 'group.namespace_example' # character | The namespace of the group var.group.name <- 'group.name_example' # character | The unique name or id of the group var.group.update <- GroupUpdate$new() # GroupUpdate | api.instance <- GroupsApi$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$UpdateGroup(var.group.namespace, var.group.name, group.update=var.group.update) ## End(Not run)
GroupSharing Class
An R6Class
generator object
group_actions
list( GroupActions ) [optional]
array_actions
list( ArrayActions ) [optional]
namespace
character [optional]
namespace_type
character [optional]
new()
GroupSharing$new( group_actions = NULL, array_actions = NULL, namespace = NULL, namespace_type = NULL, ... )
toJSON()
GroupSharing$toJSON()
fromJSON()
GroupSharing$fromJSON(GroupSharingJson)
toJSONString()
GroupSharing$toJSONString()
fromJSONString()
GroupSharing$fromJSONString(GroupSharingJson)
clone()
The objects of this class are cloneable with this method.
GroupSharing$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupSharingRequest Class
An R6Class
generator object
group_actions
list( GroupActions ) [optional]
array_actions
list( ArrayActions ) [optional]
namespace
character [optional]
new()
GroupSharingRequest$new( group_actions = NULL, array_actions = NULL, namespace = NULL, ... )
toJSON()
GroupSharingRequest$toJSON()
fromJSON()
GroupSharingRequest$fromJSON(GroupSharingRequestJson)
toJSONString()
GroupSharingRequest$toJSONString()
fromJSONString()
GroupSharingRequest$fromJSONString(GroupSharingRequestJson)
clone()
The objects of this class are cloneable with this method.
GroupSharingRequest$clone(deep = FALSE)
deep
Whether to make a deep clone.
GroupUpdate Class
An R6Class
generator object
description
character [optional]
name
character [optional]
logo
character [optional]
access_credentials_name
character [optional]
tags
list( character ) [optional]
license_id
character [optional]
license_text
character [optional]
new()
GroupUpdate$new( description = NULL, name = NULL, logo = NULL, access_credentials_name = NULL, tags = NULL, license_id = NULL, license_text = NULL, ... )
toJSON()
GroupUpdate$toJSON()
fromJSON()
GroupUpdate$fromJSON(GroupUpdateJson)
toJSONString()
GroupUpdate$toJSONString()
fromJSONString()
GroupUpdate$fromJSONString(GroupUpdateJson)
clone()
The objects of this class are cloneable with this method.
GroupUpdate$clone(deep = FALSE)
deep
Whether to make a deep clone.
InlineObject Class
An R6Class
generator object
password
character [optional]
new()
InlineObject$new(password = NULL, ...)
toJSON()
InlineObject$toJSON()
fromJSON()
InlineObject$fromJSON(InlineObjectJson)
toJSONString()
InlineObject$toJSONString()
fromJSONString()
InlineObject$fromJSONString(InlineObjectJson)
clone()
The objects of this class are cloneable with this method.
InlineObject$clone(deep = FALSE)
deep
Whether to make a deep clone.
InlineResponse200 Class
An R6Class
generator object
stats
character [optional]
new()
InlineResponse200$new(stats = NULL, ...)
toJSON()
InlineResponse200$toJSON()
fromJSON()
InlineResponse200$fromJSON(InlineResponse200Json)
toJSONString()
InlineResponse200$toJSONString()
fromJSONString()
InlineResponse200$fromJSONString(InlineResponse200Json)
clone()
The objects of this class are cloneable with this method.
InlineResponse200$clone(deep = FALSE)
deep
Whether to make a deep clone.
Invitation Class
An R6Class
generator object
id
character [optional]
invitation_type
InvitationType [optional]
owner_namespace_uuid
character [optional]
user_namespace_uuid
character [optional]
organization_user_uuid
character [optional]
organization_name
character [optional]
organization_role
OrganizationRoles [optional]
array_uuid
character [optional]
array_name
character [optional]
email
character [optional]
actions
character [optional]
status
InvitationStatus [optional]
created_at
character [optional]
expires_at
character [optional]
accepted_at
character [optional]
new()
Invitation$new( id = NULL, invitation_type = NULL, owner_namespace_uuid = NULL, user_namespace_uuid = NULL, organization_user_uuid = NULL, organization_name = NULL, organization_role = NULL, array_uuid = NULL, array_name = NULL, email = NULL, actions = NULL, status = NULL, created_at = NULL, expires_at = NULL, accepted_at = NULL, ... )
toJSON()
Invitation$toJSON()
fromJSON()
Invitation$fromJSON(InvitationJson)
toJSONString()
Invitation$toJSONString()
fromJSONString()
Invitation$fromJSONString(InvitationJson)
clone()
The objects of this class are cloneable with this method.
Invitation$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.Invitation
An R6Class
generator object
AcceptInvitation Accepts invitation
@param invitation character
status code : 204 | Invitation was accepted successfully
response headers :
status code : 404 | Could not find invitation identifier
response headers :
status code : 0 | error response
return type : Error
response headers :
CancelJoinOrganization Cancels join organization invitation
@param invitation character
@param organization character
status code : 204 | Invitation cancelled successfully
response headers :
status code : 404 | No invitation was found to cancel
response headers :
status code : 0 | error response
return type : Error
response headers :
CancelShareArrayByInvite Cancels array sharing invitation
@param namespace character
@param invitation character
@param array character
status code : 204 | Invitation cancelled successfully
response headers :
status code : 404 | No invitation was found to cancel
response headers :
status code : 0 | error response
return type : Error
response headers :
FetchInvitations Fetch a list of invitations
@param organization character
@param array character
@param start integer
@param end integer
@param page integer
@param per.page integer
@param type character
@param status character
@param orderby character
@returnType InvitationData
status code : 200 | List of invitations and pagination metadata
return type : InvitationData
response headers :
status code : 0 | error response
return type : Error
response headers :
JoinOrganization Sends email to multiple recipients with joining information regarding an organization
@param organization character
@param email.invite InvitationOrganizationJoinEmail
status code : 204 | Email sent successfully to user for email confirmation link
response headers :
status code : 404 | Could not reach one or more recipients
return type : InvitationOrganizationJoinEmail
response headers :
status code : 0 | error response
return type : Error
response headers :
ShareArrayByInvite Sends email to multiple recipients with sharing information regarding an array
@param namespace character
@param array character
@param email.invite InvitationArrayShareEmail
status code : 204 | Email sent successfully to user for email confirmation link
response headers :
status code : 404 | Could not reach one or more recipients
return type : InvitationArrayShareEmail
response headers :
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
InvitationApi$new(apiClient)
AcceptInvitation()
InvitationApi$AcceptInvitation(invitation, ...)
AcceptInvitationWithHttpInfo()
InvitationApi$AcceptInvitationWithHttpInfo(invitation, ...)
CancelJoinOrganization()
InvitationApi$CancelJoinOrganization(invitation, organization, ...)
CancelJoinOrganizationWithHttpInfo()
InvitationApi$CancelJoinOrganizationWithHttpInfo(invitation, organization, ...)
CancelShareArrayByInvite()
InvitationApi$CancelShareArrayByInvite(namespace, invitation, array, ...)
CancelShareArrayByInviteWithHttpInfo()
InvitationApi$CancelShareArrayByInviteWithHttpInfo( namespace, invitation, array, ... )
FetchInvitations()
InvitationApi$FetchInvitations( organization = NULL, array = NULL, start = NULL, end = NULL, page = NULL, per.page = NULL, type = NULL, status = NULL, orderby = NULL, ... )
FetchInvitationsWithHttpInfo()
InvitationApi$FetchInvitationsWithHttpInfo( organization = NULL, array = NULL, start = NULL, end = NULL, page = NULL, per.page = NULL, type = NULL, status = NULL, orderby = NULL, ... )
JoinOrganization()
InvitationApi$JoinOrganization(organization, email.invite, ...)
JoinOrganizationWithHttpInfo()
InvitationApi$JoinOrganizationWithHttpInfo(organization, email.invite, ...)
ShareArrayByInvite()
InvitationApi$ShareArrayByInvite(namespace, array, email.invite, ...)
ShareArrayByInviteWithHttpInfo()
InvitationApi$ShareArrayByInviteWithHttpInfo( namespace, array, email.invite, ... )
clone()
The objects of this class are cloneable with this method.
InvitationApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run: #################### AcceptInvitation #################### library(tiledbcloud) var.invitation <- 'invitation_example' # character | the ID of invitation about to be accepted api.instance <- InvitationApi$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$AcceptInvitation(var.invitation) #################### CancelJoinOrganization #################### library(tiledbcloud) var.invitation <- 'invitation_example' # character | the ID of invitation about to be cancelled var.organization <- 'organization_example' # character | name or UUID of organization api.instance <- InvitationApi$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$CancelJoinOrganization(var.invitation, var.organization) #################### CancelShareArrayByInvite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.invitation <- 'invitation_example' # character | the ID of invitation about to be cancelled var.array <- 'array_example' # character | name/uri of array that is url-encoded api.instance <- InvitationApi$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$CancelShareArrayByInvite(var.namespace, var.invitation, var.array) #################### FetchInvitations #################### library(tiledbcloud) var.organization <- 'organization_example' # character | name or ID of organization 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 | invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" var.status <- 'status_example' # character | Filter to only return \"PENDING\", \"ACCEPTED\" var.orderby <- 'orderby_example' # character | sort by which field valid values include timestamp, array_name, organization_name api.instance <- InvitationApi$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$FetchInvitations(organization=var.organization, array=var.array, start=var.start, end=var.end, page=var.page, per.page=var.per.page, type=var.type, status=var.status, orderby=var.orderby) #################### JoinOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | name or UUID of organization var.email.invite <- InvitationOrganizationJoinEmail$new() # InvitationOrganizationJoinEmail | list of email recipients api.instance <- InvitationApi$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$JoinOrganization(var.organization, var.email.invite) #################### ShareArrayByInvite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.email.invite <- InvitationArrayShareEmail$new() # InvitationArrayShareEmail | list of email recipients api.instance <- InvitationApi$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$ShareArrayByInvite(var.namespace, var.array, var.email.invite) ## End(Not run)
## Not run: #################### AcceptInvitation #################### library(tiledbcloud) var.invitation <- 'invitation_example' # character | the ID of invitation about to be accepted api.instance <- InvitationApi$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$AcceptInvitation(var.invitation) #################### CancelJoinOrganization #################### library(tiledbcloud) var.invitation <- 'invitation_example' # character | the ID of invitation about to be cancelled var.organization <- 'organization_example' # character | name or UUID of organization api.instance <- InvitationApi$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$CancelJoinOrganization(var.invitation, var.organization) #################### CancelShareArrayByInvite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.invitation <- 'invitation_example' # character | the ID of invitation about to be cancelled var.array <- 'array_example' # character | name/uri of array that is url-encoded api.instance <- InvitationApi$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$CancelShareArrayByInvite(var.namespace, var.invitation, var.array) #################### FetchInvitations #################### library(tiledbcloud) var.organization <- 'organization_example' # character | name or ID of organization 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 | invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" var.status <- 'status_example' # character | Filter to only return \"PENDING\", \"ACCEPTED\" var.orderby <- 'orderby_example' # character | sort by which field valid values include timestamp, array_name, organization_name api.instance <- InvitationApi$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$FetchInvitations(organization=var.organization, array=var.array, start=var.start, end=var.end, page=var.page, per.page=var.per.page, type=var.type, status=var.status, orderby=var.orderby) #################### JoinOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | name or UUID of organization var.email.invite <- InvitationOrganizationJoinEmail$new() # InvitationOrganizationJoinEmail | list of email recipients api.instance <- InvitationApi$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$JoinOrganization(var.organization, var.email.invite) #################### ShareArrayByInvite #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.email.invite <- InvitationArrayShareEmail$new() # InvitationArrayShareEmail | list of email recipients api.instance <- InvitationApi$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$ShareArrayByInvite(var.namespace, var.array, var.email.invite) ## End(Not run)
InvitationData Class
An R6Class
generator object
invitations
list( Invitation ) [optional]
pagination_metadata
PaginationMetadata [optional]
new()
InvitationData$new(invitations = NULL, pagination_metadata = NULL, ...)
toJSON()
InvitationData$toJSON()
fromJSON()
InvitationData$fromJSON(InvitationDataJson)
toJSONString()
InvitationData$toJSONString()
fromJSONString()
InvitationData$fromJSONString(InvitationDataJson)
clone()
The objects of this class are cloneable with this method.
InvitationData$clone(deep = FALSE)
deep
Whether to make a deep clone.
InvitationOrganizationJoinEmail Class
An R6Class
generator object
actions
list( NamespaceActions ) [optional]
organization_role
invitee_email
list( character )
new()
InvitationOrganizationJoinEmail$new( organization_role, invitee_email, actions = NULL, ... )
toJSON()
InvitationOrganizationJoinEmail$toJSON()
fromJSON()
InvitationOrganizationJoinEmail$fromJSON(InvitationOrganizationJoinEmailJson)
toJSONString()
InvitationOrganizationJoinEmail$toJSONString()
fromJSONString()
InvitationOrganizationJoinEmail$fromJSONString( InvitationOrganizationJoinEmailJson )
clone()
The objects of this class are cloneable with this method.
InvitationOrganizationJoinEmail$clone(deep = FALSE)
deep
Whether to make a deep clone.
InvitationStatus Class
An R6Class
generator object
new()
InvitationStatus$new(...)
toJSON()
InvitationStatus$toJSON()
fromJSON()
InvitationStatus$fromJSON(InvitationStatusJson)
toJSONString()
InvitationStatus$toJSONString()
fromJSONString()
InvitationStatus$fromJSONString(InvitationStatusJson)
clone()
The objects of this class are cloneable with this method.
InvitationStatus$clone(deep = FALSE)
deep
Whether to make a deep clone.
InvitationType Class
An R6Class
generator object
new()
InvitationType$new(...)
toJSON()
InvitationType$toJSON()
fromJSON()
InvitationType$fromJSON(InvitationTypeJson)
toJSONString()
InvitationType$toJSONString()
fromJSONString()
InvitationType$fromJSONString(InvitationTypeJson)
clone()
The objects of this class are cloneable with this method.
InvitationType$clone(deep = FALSE)
deep
Whether to make a deep clone.
LastAccessedArray Class
An R6Class
generator object
array_id
character [optional]
array_name
character [optional]
namespace
character [optional]
accessed_time
numeric [optional]
access_type
ActivityEventType [optional]
new()
LastAccessedArray$new( array_id = NULL, array_name = NULL, namespace = NULL, accessed_time = NULL, access_type = NULL, ... )
toJSON()
LastAccessedArray$toJSON()
fromJSON()
LastAccessedArray$fromJSON(LastAccessedArrayJson)
toJSONString()
LastAccessedArray$toJSONString()
fromJSONString()
LastAccessedArray$fromJSONString(LastAccessedArrayJson)
clone()
The objects of this class are cloneable with this method.
LastAccessedArray$clone(deep = FALSE)
deep
Whether to make a deep clone.
Layout Class
An R6Class
generator object
new()
Layout$new(...)
toJSON()
Layout$toJSON()
fromJSON()
Layout$fromJSON(LayoutJson)
toJSONString()
Layout$toJSONString()
fromJSONString()
Layout$fromJSONString(LayoutJson)
clone()
The objects of this class are cloneable with this method.
Layout$clone(deep = FALSE)
deep
Whether to make a deep clone.
Returns a dataframe of metadata for all arrays that meet the filter applied.
list_arrays( public = FALSE, shared = FALSE, page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, file.type = NULL, exclude.file.type = NULL, file.property = NULL, ... )
list_arrays( public = FALSE, shared = FALSE, page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, file.type = NULL, exclude.file.type = NULL, file.property = NULL, ... )
public |
logical TRUE means list public arrays |
shared |
logical TRUE means list shared arrays. If |
page |
integer |
per.page |
integer |
search |
character |
namespace |
character |
orderby |
character |
permissions |
character |
tag |
list( character ) |
exclude.tag |
list( character ) |
file.type |
list( character ) |
exclude.file.type |
list( character ) |
file.property |
list( character ) |
Note that this is a paginable API but default params return all results on
one call, even hundreds of them. The public
and
shared
arguments may not both be true.
Pagination information is set as an attribute of the returned data frame.
Dataframe of metadata for all arrays in your account that meet the filter applied.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_groups()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
Returns a dataframe of metadata for all groups that meet the filter applied.
list_groups( public = FALSE, shared = FALSE, page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = FALSE, parent = NULL )
list_groups( public = FALSE, shared = FALSE, page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = FALSE, parent = NULL )
public |
logical TRUE means list public arrays |
shared |
logical TRUE means list shared arrays. If |
page |
integer |
per.page |
integer |
search |
character |
namespace |
character |
orderby |
character |
permissions |
character |
tag |
list( character ) |
exclude.tag |
list( character ) |
flat |
logical, if 'TRUE', ignores the nesting of groups and searches all of them |
parent |
character, search only the children of the groups with this uuid |
Note that this is a paginable API but default params return all results on one call, even hundreds of them.
Pagination information is set as an attribute of the returned data frame.
A 'data.frame' of metadata for all groups in your account that meet the filter applied.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
login()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
This function can be used to override the default setup made at package load.
login( username, password, api_key, host, remember_me = TRUE, write_config = FALSE )
login( username, password, api_key, host, remember_me = TRUE, write_config = FALSE )
username |
A character value with the username, if present password is also needed. |
password |
A character value with the password, if present username is also needed. |
api_key |
A character value with the access token, it can be used instead of username and password. |
host |
A character value with remote host to connect to. |
remember_me |
A boolean to select a session with for 24 hours instead of 8 hours, used only when a new session is requested. |
write_config |
A boolean to write the login information
to |
It can operate in two modes. Either a username and a password are
supplied as environment variable TILEDB_REST_USERNAME
and
TILEDB_REST_PASSWORD
. As an alternative, an access token
can be supplied via TILEDB_REST_TOKEN
. The values are used
to instantiate a new API client object. If no token was supplied, a
new session is requested and the token assigned to that session is
used.
Function arguments are optional, and can be used to override the
default configuration values obtained by configure
from
either the environment variables or the configuration file.
Nothing is returned; the function is called for a side effect of storing the values in the package environment.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
register_array()
,
register_udf()
,
update_udf_info()
,
user_profile()
MaxBufferSizes Class
An R6Class
generator object
maxBufferSizes
list( AttributeBufferSize ) [optional]
new()
MaxBufferSizes$new(maxBufferSizes = NULL, ...)
toJSON()
MaxBufferSizes$toJSON()
fromJSON()
MaxBufferSizes$fromJSON(MaxBufferSizesJson)
toJSONString()
MaxBufferSizes$toJSONString()
fromJSONString()
MaxBufferSizes$fromJSONString(MaxBufferSizesJson)
clone()
The objects of this class are cloneable with this method.
MaxBufferSizes$clone(deep = FALSE)
deep
Whether to make a deep clone.
MLModelFavorite Class
An R6Class
generator object
mlmodel_uuid
character [optional]
namespace
character [optional]
name
character [optional]
new()
MLModelFavorite$new(mlmodel_uuid = NULL, namespace = NULL, name = NULL, ...)
toJSON()
MLModelFavorite$toJSON()
fromJSON()
MLModelFavorite$fromJSON(MLModelFavoriteJson)
toJSONString()
MLModelFavorite$toJSONString()
fromJSONString()
MLModelFavorite$fromJSONString(MLModelFavoriteJson)
clone()
The objects of this class are cloneable with this method.
MLModelFavorite$clone(deep = FALSE)
deep
Whether to make a deep clone.
MLModelFavoritesData Class
An R6Class
generator object
mlmodels
list( ArrayInfo ) [optional]
pagination_metadata
PaginationMetadata [optional]
new()
MLModelFavoritesData$new(mlmodels = NULL, pagination_metadata = NULL, ...)
toJSON()
MLModelFavoritesData$toJSON()
fromJSON()
MLModelFavoritesData$fromJSON(MLModelFavoritesDataJson)
toJSONString()
MLModelFavoritesData$toJSONString()
fromJSONString()
MLModelFavoritesData$fromJSONString(MLModelFavoritesDataJson)
clone()
The objects of this class are cloneable with this method.
MLModelFavoritesData$clone(deep = FALSE)
deep
Whether to make a deep clone.
MultiArrayUDF Class
An R6Class
generator object
udf_info_name
character [optional]
language
UDFLanguage [optional]
version
character [optional]
image_name
character [optional]
resource_class
character [optional]
exec
character [optional]
exec_raw
character [optional]
result_format
ResultFormat [optional]
task_name
character [optional]
argument
character [optional]
arguments_json
list( TGUDFArgument ) [optional]
stored_param_uuids
list( character ) [optional]
store_results
character [optional]
dont_download_results
character [optional]
ranges
QueryRanges [optional]
subarray
UDFSubarray [optional]
buffers
list( character ) [optional]
arrays
list( UDFArrayDetails ) [optional]
timeout
integer [optional]
task_graph_uuid
character [optional]
client_node_uuid
character [optional]
new()
MultiArrayUDF$new( udf_info_name = NULL, language = NULL, version = NULL, image_name = NULL, resource_class = NULL, exec = NULL, exec_raw = NULL, result_format = NULL, task_name = NULL, argument = NULL, arguments_json = NULL, stored_param_uuids = NULL, store_results = NULL, dont_download_results = NULL, ranges = NULL, subarray = NULL, buffers = NULL, arrays = NULL, timeout = NULL, task_graph_uuid = NULL, client_node_uuid = NULL, ... )
toJSON()
MultiArrayUDF$toJSON()
fromJSON()
MultiArrayUDF$fromJSON(MultiArrayUDFJson)
toJSONString()
MultiArrayUDF$toJSONString()
fromJSONString()
MultiArrayUDF$fromJSONString(MultiArrayUDFJson)
clone()
The objects of this class are cloneable with this method.
MultiArrayUDF$clone(deep = FALSE)
deep
Whether to make a deep clone.
NamespaceActions Class
An R6Class
generator object
new()
NamespaceActions$new(...)
toJSON()
NamespaceActions$toJSON()
fromJSON()
NamespaceActions$fromJSON(NamespaceActionsJson)
toJSONString()
NamespaceActions$toJSONString()
fromJSONString()
NamespaceActions$fromJSONString(NamespaceActionsJson)
clone()
The objects of this class are cloneable with this method.
NamespaceActions$clone(deep = FALSE)
deep
Whether to make a deep clone.
NonEmptyDomain Class
An R6Class
generator object
nonEmptyDomain
isEmpty
character
new()
NonEmptyDomain$new(nonEmptyDomain, isEmpty, ...)
toJSON()
NonEmptyDomain$toJSON()
fromJSON()
NonEmptyDomain$fromJSON(NonEmptyDomainJson)
toJSONString()
NonEmptyDomain$toJSONString()
fromJSONString()
NonEmptyDomain$fromJSONString(NonEmptyDomainJson)
clone()
The objects of this class are cloneable with this method.
NonEmptyDomain$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.Notebook
An R6Class
generator object
GetNotebookServerStatus Get status of the notebook server
@param namespace character
@returnType NotebookStatus
status code : 200 | status of running notebook
return type : NotebookStatus
response headers :
status code : 202 | Notebook server is pending
response headers :
status code : 402 | Payment required
return type : Error
response headers :
status code : 404 | Notebook is not running
response headers :
status code : 0 | error response
return type : Error
response headers :
ShutdownNotebookServer Shutdown a notebook server
@param namespace character
status code : 204 | Notebook shutdown successfully
response headers :
status code : 404 | Notebook is not running
response headers :
status code : 0 | error response
return type : Error
response headers :
UpdateNotebookName update name on a notebok, moving related S3 object to new location
@param namespace character
@param array character
@param notebook.metadata ArrayInfoUpdate
status code : 204 | notebook name updated successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
NotebookApi$new(apiClient)
GetNotebookServerStatus()
NotebookApi$GetNotebookServerStatus(namespace, ...)
GetNotebookServerStatusWithHttpInfo()
NotebookApi$GetNotebookServerStatusWithHttpInfo(namespace, ...)
ShutdownNotebookServer()
NotebookApi$ShutdownNotebookServer(namespace, ...)
ShutdownNotebookServerWithHttpInfo()
NotebookApi$ShutdownNotebookServerWithHttpInfo(namespace, ...)
UpdateNotebookName()
NotebookApi$UpdateNotebookName(namespace, array, notebook.metadata, ...)
UpdateNotebookNameWithHttpInfo()
NotebookApi$UpdateNotebookNameWithHttpInfo( namespace, array, notebook.metadata, ... )
clone()
The objects of this class are cloneable with this method.
NotebookApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run: #################### GetNotebookServerStatus #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace notebook is in (an organization name or user's username) api.instance <- NotebookApi$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$GetNotebookServerStatus(var.namespace) #################### ShutdownNotebookServer #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace notebook is in (an organization name or user's username) api.instance <- NotebookApi$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$ShutdownNotebookServer(var.namespace) #################### UpdateNotebookName #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of notebook (array) that is url-encoded var.notebook.metadata <- ArrayInfoUpdate$new() # ArrayInfoUpdate | notebook (array) metadata to update api.instance <- NotebookApi$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$UpdateNotebookName(var.namespace, var.array, var.notebook.metadata) ## End(Not run)
## Not run: #################### GetNotebookServerStatus #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace notebook is in (an organization name or user's username) api.instance <- NotebookApi$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$GetNotebookServerStatus(var.namespace) #################### ShutdownNotebookServer #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace notebook is in (an organization name or user's username) api.instance <- NotebookApi$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$ShutdownNotebookServer(var.namespace) #################### UpdateNotebookName #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of notebook (array) that is url-encoded var.notebook.metadata <- ArrayInfoUpdate$new() # ArrayInfoUpdate | notebook (array) metadata to update api.instance <- NotebookApi$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$UpdateNotebookName(var.namespace, var.array, var.notebook.metadata) ## End(Not run)
NotebookFavorite Class
An R6Class
generator object
notebook_uuid
character [optional]
namespace
character [optional]
name
character [optional]
new()
NotebookFavorite$new(notebook_uuid = NULL, namespace = NULL, name = NULL, ...)
toJSON()
NotebookFavorite$toJSON()
fromJSON()
NotebookFavorite$fromJSON(NotebookFavoriteJson)
toJSONString()
NotebookFavorite$toJSONString()
fromJSONString()
NotebookFavorite$fromJSONString(NotebookFavoriteJson)
clone()
The objects of this class are cloneable with this method.
NotebookFavorite$clone(deep = FALSE)
deep
Whether to make a deep clone.
NotebookFavoritesData Class
An R6Class
generator object
notebooks
list( ArrayInfo ) [optional]
pagination_metadata
PaginationMetadata [optional]
new()
NotebookFavoritesData$new(notebooks = NULL, pagination_metadata = NULL, ...)
toJSON()
NotebookFavoritesData$toJSON()
fromJSON()
NotebookFavoritesData$fromJSON(NotebookFavoritesDataJson)
toJSONString()
NotebookFavoritesData$toJSONString()
fromJSONString()
NotebookFavoritesData$fromJSONString(NotebookFavoritesDataJson)
clone()
The objects of this class are cloneable with this method.
NotebookFavoritesData$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.Notebooks
An R6Class
generator object
NotebooksNamespaceArrayEndTimestampsGet retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated
@param namespace character
@param array character
@param page integer
@param per.page integer
@returnType ArrayEndTimestampData
status code : 200 | list of timestamps in milliseconds, paginated
return type : ArrayEndTimestampData
response headers :
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
NotebooksApi$new(apiClient)
NotebooksNamespaceArrayEndTimestampsGet()
NotebooksApi$NotebooksNamespaceArrayEndTimestampsGet( namespace, array, page = NULL, per.page = NULL, ... )
NotebooksNamespaceArrayEndTimestampsGetWithHttpInfo()
NotebooksApi$NotebooksNamespaceArrayEndTimestampsGetWithHttpInfo( namespace, array, page = NULL, per.page = NULL, ... )
clone()
The objects of this class are cloneable with this method.
NotebooksApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run: #################### NotebooksNamespaceArrayEndTimestampsGet #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- NotebooksApi$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$NotebooksNamespaceArrayEndTimestampsGet(var.namespace, var.array, page=var.page, per.page=var.per.page) ## End(Not run)
## Not run: #################### NotebooksNamespaceArrayEndTimestampsGet #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- NotebooksApi$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$NotebooksNamespaceArrayEndTimestampsGet(var.namespace, var.array, page=var.page, per.page=var.per.page) ## End(Not run)
NotebookStatus Class
An R6Class
generator object
namespace
character [optional]
uptime
integer [optional]
cpu_usage
integer [optional]
memory_usage
integer [optional]
memory_limit
integer [optional]
cpu_count
integer [optional]
new()
NotebookStatus$new( namespace = NULL, uptime = NULL, cpu_usage = NULL, memory_usage = NULL, memory_limit = NULL, cpu_count = NULL, ... )
toJSON()
NotebookStatus$toJSON()
fromJSON()
NotebookStatus$fromJSON(NotebookStatusJson)
toJSONString()
NotebookStatus$toJSONString()
fromJSONString()
NotebookStatus$fromJSONString(NotebookStatusJson)
clone()
The objects of this class are cloneable with this method.
NotebookStatus$clone(deep = FALSE)
deep
Whether to make a deep clone.
Organization Class
An R6Class
generator object
id
character [optional]
role
OrganizationRoles [optional]
name
character
created_at
character [optional]
updated_at
character [optional]
logo
character [optional]
description
character [optional]
users
list( OrganizationUser ) [optional]
allowed_actions
list( NamespaceActions ) [optional]
num_of_arrays
numeric [optional]
enabled_features
list( character ) [optional]
unpaid_subscription
character [optional]
default_s3_path
character [optional]
default_s3_path_credentials_name
character [optional]
stripe_connect
character [optional]
new()
Organization$new( name, id = NULL, role = NULL, created_at = NULL, updated_at = NULL, logo = NULL, description = NULL, users = NULL, allowed_actions = NULL, num_of_arrays = NULL, enabled_features = NULL, unpaid_subscription = NULL, default_s3_path = NULL, default_s3_path_credentials_name = NULL, stripe_connect = NULL, ... )
toJSON()
Organization$toJSON()
fromJSON()
Organization$fromJSON(OrganizationJson)
toJSONString()
Organization$toJSONString()
fromJSONString()
Organization$fromJSONString(OrganizationJson)
clone()
The objects of this class are cloneable with this method.
Organization$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.Organization
An R6Class
generator object
AddAWSAccessCredentials Add aws keys
@param namespace character
@param aws.access.credentials AWSAccessCredentials
status code : 204 | AWS keys added successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
AddUserToOrganization add a user to an organization
@param organization character
@param user OrganizationUser
status code : 204 | user added to organization successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
CheckAWSAccessCredentials Check if aws keys are set
@param namespace character
@returnType list( AWSAccessCredentials )
status code : 200 | AWS keys are set
return type : array[AWSAccessCredentials]
response headers :
status code : 0 | error response
return type : Error
response headers :
CheckAWSAccessCredentialsByName Check if aws keys are set by name
@param namespace character
@param name character
@returnType AWSAccessCredentials
status code : 200 | AWS keys are set
return type : AWSAccessCredentials
response headers :
status code : 0 | error response
return type : Error
response headers :
CreateOrganization create a organization, the user creating will be listed as owner
@param organization Organization
status code : 204 | organization created successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteAWSAccessCredentials delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable
@param namespace character
@param name character
status code : 204 | AWS credentials deleted
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteOrganization delete a organization
@param organization character
status code : 204 | organization deleted
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteUserFromOrganization delete a user from an organization
@param organization character
@param username character
status code : 204 | user delete from organization successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
GetAllOrganizations get all organizations that the user is member of
@returnType list( Organization )
status code : 200 | array of organizations the user is member of
return type : array[Organization]
response headers :
status code : 400 | Error finding organizations
response headers :
status code : 500 | Request user not found, or has empty context
response headers :
status code : 0 | error response
return type : Error
response headers :
GetOrganization get a organization
@param organization character
@returnType Organization
status code : 200 | organization details
return type : Organization
response headers :
status code : 404 | Organization does not exist
response headers :
status code : 0 | error response
return type : Error
response headers :
GetOrganizationUser get a user from an organization
@param organization character
@param username character
@returnType OrganizationUser
status code : 200 | user from organization
return type : OrganizationUser
response headers :
status code : 404 | User is not in organization
response headers :
status code : 0 | error response
return type : Error
response headers :
UpdateAWSAccessCredentials Update aws keys or associated buckets. This will update the key associations for each array in the namespace
@param namespace character
@param name character
@param aws.access.credentials AWSAccessCredentials
status code : 204 | AWS keys updated successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
UpdateOrganization update a organization
@param organization character
@param organization.details Organization
status code : 204 | organization updated successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
UpdateUserInOrganization update a user in an organization
@param organization character
@param username character
@param user OrganizationUser
status code : 204 | user update in organization successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
OrganizationApi$new(apiClient)
AddAWSAccessCredentials()
OrganizationApi$AddAWSAccessCredentials(namespace, aws.access.credentials, ...)
AddAWSAccessCredentialsWithHttpInfo()
OrganizationApi$AddAWSAccessCredentialsWithHttpInfo( namespace, aws.access.credentials, ... )
AddUserToOrganization()
OrganizationApi$AddUserToOrganization(organization, user, ...)
AddUserToOrganizationWithHttpInfo()
OrganizationApi$AddUserToOrganizationWithHttpInfo(organization, user, ...)
CheckAWSAccessCredentials()
OrganizationApi$CheckAWSAccessCredentials(namespace, ...)
CheckAWSAccessCredentialsWithHttpInfo()
OrganizationApi$CheckAWSAccessCredentialsWithHttpInfo(namespace, ...)
CheckAWSAccessCredentialsByName()
OrganizationApi$CheckAWSAccessCredentialsByName(namespace, name, ...)
CheckAWSAccessCredentialsByNameWithHttpInfo()
OrganizationApi$CheckAWSAccessCredentialsByNameWithHttpInfo( namespace, name, ... )
CreateOrganization()
OrganizationApi$CreateOrganization(organization, ...)
CreateOrganizationWithHttpInfo()
OrganizationApi$CreateOrganizationWithHttpInfo(organization, ...)
DeleteAWSAccessCredentials()
OrganizationApi$DeleteAWSAccessCredentials(namespace, name, ...)
DeleteAWSAccessCredentialsWithHttpInfo()
OrganizationApi$DeleteAWSAccessCredentialsWithHttpInfo(namespace, name, ...)
DeleteOrganization()
OrganizationApi$DeleteOrganization(organization, ...)
DeleteOrganizationWithHttpInfo()
OrganizationApi$DeleteOrganizationWithHttpInfo(organization, ...)
DeleteUserFromOrganization()
OrganizationApi$DeleteUserFromOrganization(organization, username, ...)
DeleteUserFromOrganizationWithHttpInfo()
OrganizationApi$DeleteUserFromOrganizationWithHttpInfo( organization, username, ... )
GetAllOrganizations()
OrganizationApi$GetAllOrganizations(...)
GetAllOrganizationsWithHttpInfo()
OrganizationApi$GetAllOrganizationsWithHttpInfo(...)
GetOrganization()
OrganizationApi$GetOrganization(organization, ...)
GetOrganizationWithHttpInfo()
OrganizationApi$GetOrganizationWithHttpInfo(organization, ...)
GetOrganizationUser()
OrganizationApi$GetOrganizationUser(organization, username, ...)
GetOrganizationUserWithHttpInfo()
OrganizationApi$GetOrganizationUserWithHttpInfo(organization, username, ...)
UpdateAWSAccessCredentials()
OrganizationApi$UpdateAWSAccessCredentials( namespace, name, aws.access.credentials, ... )
UpdateAWSAccessCredentialsWithHttpInfo()
OrganizationApi$UpdateAWSAccessCredentialsWithHttpInfo( namespace, name, aws.access.credentials, ... )
UpdateOrganization()
OrganizationApi$UpdateOrganization(organization, organization.details, ...)
UpdateOrganizationWithHttpInfo()
OrganizationApi$UpdateOrganizationWithHttpInfo( organization, organization.details, ... )
UpdateUserInOrganization()
OrganizationApi$UpdateUserInOrganization(organization, username, user, ...)
UpdateUserInOrganizationWithHttpInfo()
OrganizationApi$UpdateUserInOrganizationWithHttpInfo( organization, username, user, ... )
clone()
The objects of this class are cloneable with this method.
OrganizationApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run: #################### AddAWSAccessCredentials #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace var.aws.access.credentials <- AWSAccessCredentials$new() # AWSAccessCredentials | aws access credentials to store for a namespace api.instance <- OrganizationApi$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$AddAWSAccessCredentials(var.namespace, var.aws.access.credentials) #################### AddUserToOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name var.user <- OrganizationUser$new() # OrganizationUser | user to add api.instance <- OrganizationApi$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$AddUserToOrganization(var.organization, var.user) #################### CheckAWSAccessCredentials #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace api.instance <- OrganizationApi$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$CheckAWSAccessCredentials(var.namespace) #################### CheckAWSAccessCredentialsByName #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace var.name <- 'name_example' # character | name api.instance <- OrganizationApi$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$CheckAWSAccessCredentialsByName(var.namespace, var.name) #################### CreateOrganization #################### library(tiledbcloud) var.organization <- Organization$new() # Organization | organization to create api.instance <- OrganizationApi$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$CreateOrganization(var.organization) #################### DeleteAWSAccessCredentials #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace var.name <- 'name_example' # character | name api.instance <- OrganizationApi$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$DeleteAWSAccessCredentials(var.namespace, var.name) #################### DeleteOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name or ID api.instance <- OrganizationApi$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$DeleteOrganization(var.organization) #################### DeleteUserFromOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name var.username <- 'username_example' # character | username to manipulate api.instance <- OrganizationApi$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$DeleteUserFromOrganization(var.organization, var.username) #################### GetAllOrganizations #################### library(tiledbcloud) api.instance <- OrganizationApi$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$GetAllOrganizations() #################### GetOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name or ID api.instance <- OrganizationApi$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$GetOrganization(var.organization) #################### GetOrganizationUser #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name var.username <- 'username_example' # character | username to manipulate api.instance <- OrganizationApi$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$GetOrganizationUser(var.organization, var.username) #################### UpdateAWSAccessCredentials #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace var.name <- 'name_example' # character | name var.aws.access.credentials <- AWSAccessCredentials$new() # AWSAccessCredentials | aws credentials to update api.instance <- OrganizationApi$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$UpdateAWSAccessCredentials(var.namespace, var.name, var.aws.access.credentials) #################### UpdateOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name or ID var.organization.details <- Organization$new() # Organization | organization details to update api.instance <- OrganizationApi$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$UpdateOrganization(var.organization, var.organization.details) #################### UpdateUserInOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name var.username <- 'username_example' # character | username to manipulate var.user <- OrganizationUser$new() # OrganizationUser | user details to update api.instance <- OrganizationApi$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$UpdateUserInOrganization(var.organization, var.username, var.user) ## End(Not run)
## Not run: #################### AddAWSAccessCredentials #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace var.aws.access.credentials <- AWSAccessCredentials$new() # AWSAccessCredentials | aws access credentials to store for a namespace api.instance <- OrganizationApi$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$AddAWSAccessCredentials(var.namespace, var.aws.access.credentials) #################### AddUserToOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name var.user <- OrganizationUser$new() # OrganizationUser | user to add api.instance <- OrganizationApi$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$AddUserToOrganization(var.organization, var.user) #################### CheckAWSAccessCredentials #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace api.instance <- OrganizationApi$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$CheckAWSAccessCredentials(var.namespace) #################### CheckAWSAccessCredentialsByName #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace var.name <- 'name_example' # character | name api.instance <- OrganizationApi$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$CheckAWSAccessCredentialsByName(var.namespace, var.name) #################### CreateOrganization #################### library(tiledbcloud) var.organization <- Organization$new() # Organization | organization to create api.instance <- OrganizationApi$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$CreateOrganization(var.organization) #################### DeleteAWSAccessCredentials #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace var.name <- 'name_example' # character | name api.instance <- OrganizationApi$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$DeleteAWSAccessCredentials(var.namespace, var.name) #################### DeleteOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name or ID api.instance <- OrganizationApi$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$DeleteOrganization(var.organization) #################### DeleteUserFromOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name var.username <- 'username_example' # character | username to manipulate api.instance <- OrganizationApi$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$DeleteUserFromOrganization(var.organization, var.username) #################### GetAllOrganizations #################### library(tiledbcloud) api.instance <- OrganizationApi$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$GetAllOrganizations() #################### GetOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name or ID api.instance <- OrganizationApi$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$GetOrganization(var.organization) #################### GetOrganizationUser #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name var.username <- 'username_example' # character | username to manipulate api.instance <- OrganizationApi$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$GetOrganizationUser(var.organization, var.username) #################### UpdateAWSAccessCredentials #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace var.name <- 'name_example' # character | name var.aws.access.credentials <- AWSAccessCredentials$new() # AWSAccessCredentials | aws credentials to update api.instance <- OrganizationApi$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$UpdateAWSAccessCredentials(var.namespace, var.name, var.aws.access.credentials) #################### UpdateOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name or ID var.organization.details <- Organization$new() # Organization | organization details to update api.instance <- OrganizationApi$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$UpdateOrganization(var.organization, var.organization.details) #################### UpdateUserInOrganization #################### library(tiledbcloud) var.organization <- 'organization_example' # character | organization name var.username <- 'username_example' # character | username to manipulate var.user <- OrganizationUser$new() # OrganizationUser | user details to update api.instance <- OrganizationApi$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$UpdateUserInOrganization(var.organization, var.username, var.user) ## End(Not run)
OrganizationRoles Class
An R6Class
generator object
new()
OrganizationRoles$new(...)
toJSON()
OrganizationRoles$toJSON()
fromJSON()
OrganizationRoles$fromJSON(OrganizationRolesJson)
toJSONString()
OrganizationRoles$toJSONString()
fromJSONString()
OrganizationRoles$fromJSONString(OrganizationRolesJson)
clone()
The objects of this class are cloneable with this method.
OrganizationRoles$clone(deep = FALSE)
deep
Whether to make a deep clone.
OrganizationUser Class
An R6Class
generator object
user_id
character [optional]
organization_id
character [optional]
username
character [optional]
organization_name
character [optional]
role
OrganizationRoles [optional]
allowed_actions
list( NamespaceActions ) [optional]
new()
OrganizationUser$new( user_id = NULL, organization_id = NULL, username = NULL, organization_name = NULL, role = NULL, allowed_actions = NULL, ... )
toJSON()
OrganizationUser$toJSON()
fromJSON()
OrganizationUser$fromJSON(OrganizationUserJson)
toJSONString()
OrganizationUser$toJSONString()
fromJSONString()
OrganizationUser$fromJSONString(OrganizationUserJson)
clone()
The objects of this class are cloneable with this method.
OrganizationUser$clone(deep = FALSE)
deep
Whether to make a deep clone.
PaginationMetadata Class
An R6Class
generator object
page
numeric [optional]
per_page
numeric [optional]
total_pages
numeric [optional]
total_items
numeric [optional]
new()
PaginationMetadata$new( page = NULL, per_page = NULL, total_pages = NULL, total_items = NULL, ... )
toJSON()
PaginationMetadata$toJSON()
fromJSON()
PaginationMetadata$fromJSON(PaginationMetadataJson)
toJSONString()
PaginationMetadata$toJSONString()
fromJSONString()
PaginationMetadata$fromJSONString(PaginationMetadataJson)
clone()
The objects of this class are cloneable with this method.
PaginationMetadata$clone(deep = FALSE)
deep
Whether to make a deep clone.
Pricing Class
An R6Class
generator object
id
character [optional]
array_uuid
character [optional]
pricing_name
character [optional]
pricing_type
PricingType [optional]
product_name
character [optional]
product_statement_descriptor
character [optional]
product_unit_label
PricingUnitLabel [optional]
currency
PricingCurrency [optional]
aggregate_usage
PricingAggregateUsage [optional]
interval
PricingInterval [optional]
divided_by
integer [optional]
charge
numeric [optional]
activated
character [optional]
new()
Pricing$new( id = NULL, array_uuid = NULL, pricing_name = NULL, pricing_type = NULL, product_name = NULL, product_statement_descriptor = NULL, product_unit_label = NULL, currency = NULL, aggregate_usage = NULL, interval = NULL, divided_by = NULL, charge = NULL, activated = NULL, ... )
toJSON()
Pricing$toJSON()
fromJSON()
Pricing$fromJSON(PricingJson)
toJSONString()
Pricing$toJSONString()
fromJSONString()
Pricing$fromJSONString(PricingJson)
clone()
The objects of this class are cloneable with this method.
Pricing$clone(deep = FALSE)
deep
Whether to make a deep clone.
PricingAggregateUsage Class
An R6Class
generator object
new()
PricingAggregateUsage$new(...)
toJSON()
PricingAggregateUsage$toJSON()
fromJSON()
PricingAggregateUsage$fromJSON(PricingAggregateUsageJson)
toJSONString()
PricingAggregateUsage$toJSONString()
fromJSONString()
PricingAggregateUsage$fromJSONString(PricingAggregateUsageJson)
clone()
The objects of this class are cloneable with this method.
PricingAggregateUsage$clone(deep = FALSE)
deep
Whether to make a deep clone.
PricingCurrency Class
An R6Class
generator object
new()
PricingCurrency$new(...)
toJSON()
PricingCurrency$toJSON()
fromJSON()
PricingCurrency$fromJSON(PricingCurrencyJson)
toJSONString()
PricingCurrency$toJSONString()
fromJSONString()
PricingCurrency$fromJSONString(PricingCurrencyJson)
clone()
The objects of this class are cloneable with this method.
PricingCurrency$clone(deep = FALSE)
deep
Whether to make a deep clone.
PricingInterval Class
An R6Class
generator object
new()
PricingInterval$new(...)
toJSON()
PricingInterval$toJSON()
fromJSON()
PricingInterval$fromJSON(PricingIntervalJson)
toJSONString()
PricingInterval$toJSONString()
fromJSONString()
PricingInterval$fromJSONString(PricingIntervalJson)
clone()
The objects of this class are cloneable with this method.
PricingInterval$clone(deep = FALSE)
deep
Whether to make a deep clone.
PricingType Class
An R6Class
generator object
new()
PricingType$new(...)
toJSON()
PricingType$toJSON()
fromJSON()
PricingType$fromJSON(PricingTypeJson)
toJSONString()
PricingType$toJSONString()
fromJSONString()
PricingType$fromJSONString(PricingTypeJson)
clone()
The objects of this class are cloneable with this method.
PricingType$clone(deep = FALSE)
deep
Whether to make a deep clone.
PricingUnitLabel Class
An R6Class
generator object
new()
PricingUnitLabel$new(...)
toJSON()
PricingUnitLabel$toJSON()
fromJSON()
PricingUnitLabel$fromJSON(PricingUnitLabelJson)
toJSONString()
PricingUnitLabel$toJSONString()
fromJSONString()
PricingUnitLabel$fromJSONString(PricingUnitLabelJson)
clone()
The objects of this class are cloneable with this method.
PricingUnitLabel$clone(deep = FALSE)
deep
Whether to make a deep clone.
Query Class
An R6Class
generator object
type
layout
status
attributeBufferHeaders
list( AttributeBufferHeader )
writer
Writer [optional]
reader
QueryReader [optional]
array
totalFixedLengthBufferBytes
integer
totalVarLenBufferBytes
integer
new()
Query$new( type, layout, status, attributeBufferHeaders, array, totalFixedLengthBufferBytes, totalVarLenBufferBytes, writer = NULL, reader = NULL, ... )
toJSON()
Query$toJSON()
fromJSON()
Query$fromJSON(QueryJson)
toJSONString()
Query$toJSONString()
fromJSONString()
Query$fromJSONString(QueryJson)
clone()
The objects of this class are cloneable with this method.
Query$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.Query
An R6Class
generator object
FinalizeQuery send a query to run against a specified array/URI registered to a group/project
@param namespace character
@param array character
@param type character
@param content.type character
@param query Query
@param x.payer character
@param open.at integer
@returnType Query
status code : 200 | query completed and results are returned in query object
return type : Query
response headers :
X-TILEDB-CLOUD-TASK-ID | Task ID for just completed request |
status code : 204 | query completed successfully with no return
response headers :
status code : 0 | error response
return type : Error
response headers :
GetEstResultSizes send a query to run against a specified array/URI registered to a group/project
@param namespace character
@param array character
@param type character
@param content.type character
@param query Query
@param x.payer character
@param open.at integer
@returnType Query
status code : 200 | query est result size computed and results are returned in query object
return type : Query
response headers :
X-TILEDB-CLOUD-TASK-ID | Task ID for just completed request |
status code : 204 | query completed successfully with no return
response headers :
status code : 0 | error response
return type : Error
response headers :
GetFile send a query to run against a specified array/URI registered to a group/project, returns file bytes
@param namespace character
@param array character
@param content.type character
@param x.payer character
status code : 200 | query completed and result bytes are returned
return type : data.frame
response headers :
X-TILEDB-CLOUD-TASK-ID | Task ID for just completed request |
status code : 0 | error response
return type : Error
response headers :
SubmitQuery send a query to run against a specified array/URI registered to a group/project
@param namespace character
@param array character
@param type character
@param content.type character
@param query Query
@param x.payer character
@param open.at integer
@returnType Query
status code : 200 | query completed and results are returned in query object
return type : Query
response headers :
X-TILEDB-CLOUD-TASK-ID | Task ID for just completed request |
status code : 204 | query completed successfully with no return
response headers :
status code : 0 | error response
return type : Error
response headers :
SubmitQueryJson send a query to run against a specified array/URI registered to a group/project, returns JSON results
@param namespace character
@param array character
@param content.type character
@param query.json QueryJson
@param x.payer character
status code : 200 | query completed and results are returned in JSON format
return type : object
response headers :
X-TILEDB-CLOUD-TASK-ID | Task ID for just completed request |
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
QueryApi$new(apiClient)
FinalizeQuery()
QueryApi$FinalizeQuery( namespace, array, type, content.type, query, x.payer = NULL, open.at = NULL, ... )
FinalizeQueryWithHttpInfo()
QueryApi$FinalizeQueryWithHttpInfo( namespace, array, type, content.type, query, x.payer = NULL, open.at = NULL, ... )
GetEstResultSizes()
QueryApi$GetEstResultSizes( namespace, array, type, content.type, query, x.payer = NULL, open.at = NULL, ... )
GetEstResultSizesWithHttpInfo()
QueryApi$GetEstResultSizesWithHttpInfo( namespace, array, type, content.type, query, x.payer = NULL, open.at = NULL, ... )
GetFile()
QueryApi$GetFile(namespace, array, content.type, x.payer = NULL, ...)
GetFileWithHttpInfo()
QueryApi$GetFileWithHttpInfo( namespace, array, content.type, x.payer = NULL, ... )
SubmitQuery()
QueryApi$SubmitQuery( namespace, array, type, content.type, query, x.payer = NULL, open.at = NULL, ... )
SubmitQueryWithHttpInfo()
QueryApi$SubmitQueryWithHttpInfo( namespace, array, type, content.type, query, x.payer = NULL, open.at = NULL, ... )
SubmitQueryJson()
QueryApi$SubmitQueryJson( namespace, array, content.type, query.json, x.payer = NULL, ... )
SubmitQueryJsonWithHttpInfo()
QueryApi$SubmitQueryJsonWithHttpInfo( namespace, array, content.type, query.json, x.payer = NULL, ... )
clone()
The objects of this class are cloneable with this method.
QueryApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run: #################### FinalizeQuery #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.type <- 'type_example' # character | type of query var.content.type <- 'application/json' # character | Content Type of input and return mime var.query <- Query$new() # Query | query to run var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request var.open.at <- 56 # integer | open_at for array in unix epoch api.instance <- QueryApi$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$FinalizeQuery(var.namespace, var.array, var.type, var.content.type, var.query, x.payer=var.x.payer, open.at=var.open.at) #################### GetEstResultSizes #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.type <- 'type_example' # character | type of query var.content.type <- 'application/json' # character | Content Type of input and return mime var.query <- Query$new() # Query | query to run var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request var.open.at <- 56 # integer | open_at for array in unix epoch api.instance <- QueryApi$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$GetEstResultSizes(var.namespace, var.array, var.type, var.content.type, var.query, x.payer=var.x.payer, open.at=var.open.at) #################### GetFile #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.content.type <- 'application/json' # character | Content Type of input and return mime var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request api.instance <- QueryApi$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$GetFile(var.namespace, var.array, var.content.type, x.payer=var.x.payer) #################### SubmitQuery #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.type <- 'type_example' # character | type of query var.content.type <- 'application/json' # character | Content Type of input and return mime var.query <- Query$new() # Query | query to run var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request var.open.at <- 56 # integer | open_at for array in unix epoch api.instance <- QueryApi$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$SubmitQuery(var.namespace, var.array, var.type, var.content.type, var.query, x.payer=var.x.payer, open.at=var.open.at) #################### SubmitQueryJson #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.content.type <- 'application/json' # character | Content Type of input and return mime var.query.json <- QueryJson$new() # QueryJson | query to run var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request api.instance <- QueryApi$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$SubmitQueryJson(var.namespace, var.array, var.content.type, var.query.json, x.payer=var.x.payer) ## End(Not run)
## Not run: #################### FinalizeQuery #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.type <- 'type_example' # character | type of query var.content.type <- 'application/json' # character | Content Type of input and return mime var.query <- Query$new() # Query | query to run var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request var.open.at <- 56 # integer | open_at for array in unix epoch api.instance <- QueryApi$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$FinalizeQuery(var.namespace, var.array, var.type, var.content.type, var.query, x.payer=var.x.payer, open.at=var.open.at) #################### GetEstResultSizes #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.type <- 'type_example' # character | type of query var.content.type <- 'application/json' # character | Content Type of input and return mime var.query <- Query$new() # Query | query to run var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request var.open.at <- 56 # integer | open_at for array in unix epoch api.instance <- QueryApi$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$GetEstResultSizes(var.namespace, var.array, var.type, var.content.type, var.query, x.payer=var.x.payer, open.at=var.open.at) #################### GetFile #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.content.type <- 'application/json' # character | Content Type of input and return mime var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request api.instance <- QueryApi$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$GetFile(var.namespace, var.array, var.content.type, x.payer=var.x.payer) #################### SubmitQuery #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.type <- 'type_example' # character | type of query var.content.type <- 'application/json' # character | Content Type of input and return mime var.query <- Query$new() # Query | query to run var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request var.open.at <- 56 # integer | open_at for array in unix epoch api.instance <- QueryApi$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$SubmitQuery(var.namespace, var.array, var.type, var.content.type, var.query, x.payer=var.x.payer, open.at=var.open.at) #################### SubmitQueryJson #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username) var.array <- 'array_example' # character | name/uri of array that is url-encoded var.content.type <- 'application/json' # character | Content Type of input and return mime var.query.json <- QueryJson$new() # QueryJson | query to run var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request api.instance <- QueryApi$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$SubmitQueryJson(var.namespace, var.array, var.content.type, var.query.json, x.payer=var.x.payer) ## End(Not run)
QueryJson Class
An R6Class
generator object
query_ranges
QueryRanges [optional]
fields
list( character ) [optional]
new()
QueryJson$new(query_ranges = NULL, fields = NULL, ...)
toJSON()
QueryJson$toJSON()
fromJSON()
QueryJson$fromJSON(QueryJsonJson)
toJSONString()
QueryJson$toJSONString()
fromJSONString()
QueryJson$fromJSONString(QueryJsonJson)
clone()
The objects of this class are cloneable with this method.
QueryJson$clone(deep = FALSE)
deep
Whether to make a deep clone.
QueryRanges Class
An R6Class
generator object
layout
Layout [optional]
ranges
list( array[numeric] ) [optional]
new()
QueryRanges$new(layout = NULL, ranges = NULL, ...)
toJSON()
QueryRanges$toJSON()
fromJSON()
QueryRanges$fromJSON(QueryRangesJson)
toJSONString()
QueryRanges$toJSONString()
fromJSONString()
QueryRanges$fromJSONString(QueryRangesJson)
clone()
The objects of this class are cloneable with this method.
QueryRanges$clone(deep = FALSE)
deep
Whether to make a deep clone.
QueryReader Class
An R6Class
generator object
new()
QueryReader$new( layout = NULL, subarray = NULL, readState = NULL, varOffsetsMode = NULL, varOffsetsAddExtraElement = NULL, varOffsetsBitsize = NULL, ... )
toJSON()
QueryReader$toJSON()
fromJSON()
QueryReader$fromJSON(QueryReaderJson)
toJSONString()
QueryReader$toJSONString()
fromJSONString()
QueryReader$fromJSONString(QueryReaderJson)
clone()
The objects of this class are cloneable with this method.
QueryReader$clone(deep = FALSE)
deep
Whether to make a deep clone.
Querystatus Class
An R6Class
generator object
new()
Querystatus$new(...)
toJSON()
Querystatus$toJSON()
fromJSON()
Querystatus$fromJSON(QuerystatusJson)
toJSONString()
Querystatus$toJSONString()
fromJSONString()
Querystatus$fromJSONString(QuerystatusJson)
clone()
The objects of this class are cloneable with this method.
Querystatus$clone(deep = FALSE)
deep
Whether to make a deep clone.
Querytype Class
An R6Class
generator object
new()
Querytype$new(...)
toJSON()
Querytype$toJSON()
fromJSON()
Querytype$fromJSON(QuerytypeJson)
toJSONString()
Querytype$toJSONString()
fromJSONString()
Querytype$fromJSONString(QuerytypeJson)
clone()
The objects of this class are cloneable with this method.
Querytype$clone(deep = FALSE)
deep
Whether to make a deep clone.
ReadState Class
An R6Class
generator object
initialized
character [optional]
overflowed
character [optional]
unsplittable
character [optional]
subarrayPartitioner
SubarrayPartitioner [optional]
new()
ReadState$new( initialized = NULL, overflowed = NULL, unsplittable = NULL, subarrayPartitioner = NULL, ... )
toJSON()
ReadState$toJSON()
fromJSON()
ReadState$fromJSON(ReadStateJson)
toJSONString()
ReadState$toJSONString()
fromJSONString()
ReadState$fromJSONString(ReadStateJson)
clone()
The objects of this class are cloneable with this method.
ReadState$clone(deep = FALSE)
deep
Whether to make a deep clone.
The underlying storage must already exist.
register_array( namespace = NULL, array_name, uri, description = NULL, access_credentials_name = NULL )
register_array( namespace = NULL, array_name, uri, description = NULL, access_credentials_name = NULL )
namespace |
Namespace within TileDB cloud to charge. If this is null, the logged-in user's username will be used for the namespace. |
array_name |
The name to call the array in TileDB Cloud. |
uri |
The URI of where the array is stored. |
description |
Optional description field for the array. |
access_credentials_name |
Credentials to access the array storage. If omitted, the logged-in user's default credentials will be used. |
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_udf()
,
update_udf_info()
,
user_profile()
Registers a user-defined function on TileDB Cloud, so that it may be invoked by name later.
register_udf( namespace = NULL, name, type, func, func_text = NULL, version = NULL, image_name = NULL, readme = NULL, license_id = NULL, license_text = NULL, tags = NULL )
register_udf( namespace = NULL, name, type, func, func_text = NULL, version = NULL, image_name = NULL, readme = NULL, license_id = NULL, license_text = NULL, tags = NULL )
namespace |
Namespace for the UDF to be stored in, e.g. |
name |
character Name for the function to be stored under in TileDB Cloud, e.g. |
type |
character One of |
func |
An R function which takes a dataframe as first argument. |
version |
character Optional version string. |
image_name |
character |
readme |
README text to be displayed in the TileDB Cloud UI. |
license_id |
character See the TileDB Cloud UI for options. |
license_text |
character See the TileDB Cloud UI for options. |
tags |
list(character) Tags to apply to the UDF. |
exec_raw |
character Text to display in the TileDB Cloud UI's Preview tab. If omitted, a full deparse of |
No return value.
Other manual-layer functions:
array_info()
,
compute_sequentially()
,
compute()
,
delayed_args<-()
,
delayed_args()
,
delayed_array_udf()
,
delayed_generic_udf()
,
delayed_sql()
,
delayed()
,
deregister_array()
,
deregister_group()
,
deregister_udf()
,
execute_array_udf()
,
execute_generic_udf()
,
execute_multi_array_udf()
,
execute_sql_query()
,
get_udf_info()
,
group_info()
,
list_arrays()
,
list_groups()
,
login()
,
register_array()
,
update_udf_info()
,
user_profile()
ResultFormat Class
An R6Class
generator object
new()
ResultFormat$new(...)
toJSON()
ResultFormat$toJSON()
fromJSON()
ResultFormat$fromJSON(ResultFormatJson)
toJSONString()
ResultFormat$toJSONString()
fromJSONString()
ResultFormat$fromJSONString(ResultFormatJson)
clone()
The objects of this class are cloneable with this method.
ResultFormat$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.Sql
An R6Class
generator object
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 :
apiClient
Handles the client-server communication.
new()
SqlApi$new(apiClient)
RunSQL()
SqlApi$RunSQL(namespace, sql, accept.encoding = NULL, ...)
RunSQLWithHttpInfo()
SqlApi$RunSQLWithHttpInfo(namespace, sql, accept.encoding = NULL, ...)
clone()
The objects of this class are cloneable with this method.
SqlApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## 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 <- SqlApi$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) ## End(Not run)
## 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 <- SqlApi$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) ## End(Not run)
SQLParameters Class
An R6Class
generator object
name
character [optional]
query
character [optional]
output_uri
character [optional]
store_results
character [optional]
dont_download_results
character [optional]
resource_class
character [optional]
result_format
ResultFormat [optional]
init_commands
list( character ) [optional]
parameters
list( object ) [optional]
task_graph_uuid
character [optional]
client_node_uuid
character [optional]
new()
SQLParameters$new( name = NULL, query = NULL, output_uri = NULL, store_results = NULL, dont_download_results = NULL, resource_class = NULL, result_format = NULL, init_commands = NULL, parameters = NULL, task_graph_uuid = NULL, client_node_uuid = NULL, ... )
toJSON()
SQLParameters$toJSON()
fromJSON()
SQLParameters$fromJSON(SQLParametersJson)
toJSONString()
SQLParameters$toJSONString()
fromJSONString()
SQLParameters$fromJSONString(SQLParametersJson)
clone()
The objects of this class are cloneable with this method.
SQLParameters$clone(deep = FALSE)
deep
Whether to make a deep clone.
SSOProvider Class
An R6Class
generator object
new()
SSOProvider$new(...)
toJSON()
SSOProvider$toJSON()
fromJSON()
SSOProvider$fromJSON(SSOProviderJson)
toJSONString()
SSOProvider$toJSONString()
fromJSONString()
SSOProvider$fromJSONString(SSOProviderJson)
clone()
The objects of this class are cloneable with this method.
SSOProvider$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.Stats
An R6Class
generator object
GetTiledbStats Fetch libtiledb stat
@returnType InlineResponse200
status code : 200 | stats
return type : InlineResponse200
response headers :
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
StatsApi$new(apiClient)
GetTiledbStats()
StatsApi$GetTiledbStats(...)
GetTiledbStatsWithHttpInfo()
StatsApi$GetTiledbStatsWithHttpInfo(...)
clone()
The objects of this class are cloneable with this method.
StatsApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run: #################### GetTiledbStats #################### library(tiledbcloud) api.instance <- StatsApi$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$GetTiledbStats() ## End(Not run)
## Not run: #################### GetTiledbStats #################### library(tiledbcloud) api.instance <- StatsApi$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$GetTiledbStats() ## End(Not run)
Subarray Class
An R6Class
generator object
layout
Layout [optional]
ranges
list( SubarrayRanges ) [optional]
new()
Subarray$new(layout = NULL, ranges = NULL, ...)
toJSON()
Subarray$toJSON()
fromJSON()
Subarray$fromJSON(SubarrayJson)
toJSONString()
Subarray$toJSONString()
fromJSONString()
Subarray$fromJSONString(SubarrayJson)
clone()
The objects of this class are cloneable with this method.
Subarray$clone(deep = FALSE)
deep
Whether to make a deep clone.
SubarrayPartitioner Class
An R6Class
generator object
subarray
Subarray [optional]
budget
list( AttributeBufferSize ) [optional]
current
SubarrayPartitionerCurrent [optional]
state
SubarrayPartitionerState [optional]
memoryBudget
integer [optional]
memoryBudgetVar
integer [optional]
new()
SubarrayPartitioner$new( subarray = NULL, budget = NULL, current = NULL, state = NULL, memoryBudget = NULL, memoryBudgetVar = NULL, ... )
toJSON()
SubarrayPartitioner$toJSON()
fromJSON()
SubarrayPartitioner$fromJSON(SubarrayPartitionerJson)
toJSONString()
SubarrayPartitioner$toJSONString()
fromJSONString()
SubarrayPartitioner$fromJSONString(SubarrayPartitionerJson)
clone()
The objects of this class are cloneable with this method.
SubarrayPartitioner$clone(deep = FALSE)
deep
Whether to make a deep clone.
SubarrayPartitionerCurrent Class
An R6Class
generator object
subarray
Subarray [optional]
start
integer [optional]
end
integer [optional]
splitMultiRange
character [optional]
new()
SubarrayPartitionerCurrent$new( subarray = NULL, start = NULL, end = NULL, splitMultiRange = NULL, ... )
toJSON()
SubarrayPartitionerCurrent$toJSON()
fromJSON()
SubarrayPartitionerCurrent$fromJSON(SubarrayPartitionerCurrentJson)
toJSONString()
SubarrayPartitionerCurrent$toJSONString()
fromJSONString()
SubarrayPartitionerCurrent$fromJSONString(SubarrayPartitionerCurrentJson)
clone()
The objects of this class are cloneable with this method.
SubarrayPartitionerCurrent$clone(deep = FALSE)
deep
Whether to make a deep clone.
SubarrayPartitionerState Class
An R6Class
generator object
new()
SubarrayPartitionerState$new( start = NULL, end = NULL, singleRange = NULL, multiRange = NULL, ... )
toJSON()
SubarrayPartitionerState$toJSON()
fromJSON()
SubarrayPartitionerState$fromJSON(SubarrayPartitionerStateJson)
toJSONString()
SubarrayPartitionerState$toJSONString()
fromJSONString()
SubarrayPartitionerState$fromJSONString(SubarrayPartitionerStateJson)
clone()
The objects of this class are cloneable with this method.
SubarrayPartitionerState$clone(deep = FALSE)
deep
Whether to make a deep clone.
SubarrayRanges Class
An R6Class
generator object
type
Datatype [optional]
hasDefaultRange
character [optional]
buffer
list( integer ) [optional]
new()
SubarrayRanges$new(type = NULL, hasDefaultRange = NULL, buffer = NULL, ...)
toJSON()
SubarrayRanges$toJSON()
fromJSON()
SubarrayRanges$fromJSON(SubarrayRangesJson)
toJSONString()
SubarrayRanges$toJSONString()
fromJSONString()
SubarrayRanges$fromJSONString(SubarrayRangesJson)
clone()
The objects of this class are cloneable with this method.
SubarrayRanges$clone(deep = FALSE)
deep
Whether to make a deep clone.
Subscription Class
An R6Class
generator object
id
character [optional]
owner_namespace_uuid
character [optional]
customer_namespace_uuid
character [optional]
pricing
list( Pricing ) [optional]
new()
Subscription$new( id = NULL, owner_namespace_uuid = NULL, customer_namespace_uuid = NULL, pricing = NULL, ... )
toJSON()
Subscription$toJSON()
fromJSON()
Subscription$fromJSON(SubscriptionJson)
toJSONString()
Subscription$toJSONString()
fromJSONString()
Subscription$fromJSONString(SubscriptionJson)
clone()
The objects of this class are cloneable with this method.
Subscription$clone(deep = FALSE)
deep
Whether to make a deep clone.
TaskGraphLog Class
An R6Class
generator object
uuid
character [optional]
namespace
character [optional]
created_by
character [optional]
name
character [optional]
created_at
character [optional]
start_time
character [optional]
end_time
character [optional]
status
TaskGraphLogStatus [optional]
nodes
list( TaskGraphNodeMetadata ) [optional]
new()
TaskGraphLog$new( uuid = NULL, namespace = NULL, created_by = NULL, name = NULL, created_at = NULL, start_time = NULL, end_time = NULL, status = NULL, nodes = NULL, ... )
toJSON()
TaskGraphLog$toJSON()
fromJSON()
TaskGraphLog$fromJSON(TaskGraphLogJson)
toJSONString()
TaskGraphLog$toJSONString()
fromJSONString()
TaskGraphLog$fromJSONString(TaskGraphLogJson)
clone()
The objects of this class are cloneable with this method.
TaskGraphLog$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.TaskGraphLogs
An R6Class
generator object
CreateTaskGraphLog Create a task graph log.
@param namespace character
@param log TaskGraphLog
@returnType TaskGraphLog
status code : 201 | The task graph was created. The returned TaskGraphLog will include the data the client sent, with the server-defined fields added in.
return type : TaskGraphLog
response headers :
status code : 0 | error response
return type : Error
response headers :
GetTaskGraphLog Fetch information about a single task graph execution.
@param namespace character
@param id character
@returnType TaskGraphLog
status code : 200 | Information about the execution of a single task graph.
return type : TaskGraphLog
response headers :
status code : 0 | error response
return type : Error
response headers :
ListTaskGraphLogs Fetch the task graph logs of a namespace the user has access to. The returned entries will include only summary data, and will not include information about the individual tasks that were executed. (This information is available when requesting an individual task graph log.) Entries in the response are ordered from newest to oldest. Pagination parameters work as in other API methods; see PaginationMetadata.
@param namespace character
@param created.by character
@param search character
@param start.time character
@param end.time character
@param page integer
@param per.page integer
@returnType TaskGraphLogsData
status code : 200 | The task graph logs that matched the user's query.
return type : TaskGraphLogsData
response headers :
status code : 0 | error response
return type : Error
response headers :
UpdateTaskGraphLog Update information about a single task graph execution.
@param namespace character
@param id character
@param log TaskGraphLog
status code : 204 | Log entry updated successfully.
response headers :
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
TaskGraphLogsApi$new(apiClient)
CreateTaskGraphLog()
TaskGraphLogsApi$CreateTaskGraphLog(namespace, log, ...)
CreateTaskGraphLogWithHttpInfo()
TaskGraphLogsApi$CreateTaskGraphLogWithHttpInfo(namespace, log, ...)
GetTaskGraphLog()
TaskGraphLogsApi$GetTaskGraphLog(namespace, id, ...)
GetTaskGraphLogWithHttpInfo()
TaskGraphLogsApi$GetTaskGraphLogWithHttpInfo(namespace, id, ...)
ListTaskGraphLogs()
TaskGraphLogsApi$ListTaskGraphLogs( namespace = NULL, created.by = NULL, search = NULL, start.time = NULL, end.time = NULL, page = NULL, per.page = NULL, ... )
ListTaskGraphLogsWithHttpInfo()
TaskGraphLogsApi$ListTaskGraphLogsWithHttpInfo( namespace = NULL, created.by = NULL, search = NULL, start.time = NULL, end.time = NULL, page = NULL, per.page = NULL, ... )
UpdateTaskGraphLog()
TaskGraphLogsApi$UpdateTaskGraphLog(namespace, id, log, ...)
UpdateTaskGraphLogWithHttpInfo()
TaskGraphLogsApi$UpdateTaskGraphLogWithHttpInfo(namespace, id, log, ...)
clone()
The objects of this class are cloneable with this method.
TaskGraphLogsApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run: #################### CreateTaskGraphLog #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace that will own this task graph log. var.log <- TaskGraphLog$new() # TaskGraphLog | api.instance <- TaskGraphLogsApi$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$CreateTaskGraphLog(var.namespace, var.log) #################### GetTaskGraphLog #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace that owns this task graph log. var.id <- 'id_example' # character | The UUID of the task graph log entry. api.instance <- TaskGraphLogsApi$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$GetTaskGraphLog(var.namespace, var.id) #################### ListTaskGraphLogs #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | Include logs for this namespace. var.created.by <- 'created.by_example' # character | Include logs from only this user. var.search <- 'search_example' # character | search string that will look at name. var.start.time <- 'start.time_example' # character | Include logs created after this time. var.end.time <- 'end.time_example' # character | Include logs created before this time. var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- TaskGraphLogsApi$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$ListTaskGraphLogs(namespace=var.namespace, created.by=var.created.by, search=var.search, start.time=var.start.time, end.time=var.end.time, page=var.page, per.page=var.per.page) #################### UpdateTaskGraphLog #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace that owns this task graph log. var.id <- 'id_example' # character | The UUID of the task graph log entry. var.log <- TaskGraphLog$new() # TaskGraphLog | Updates to make to the task graph log. The only manual update that a client should need to make to a task graph log is to update its completion status to `succeeded`, `failed`, or `cancelled`. api.instance <- TaskGraphLogsApi$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$UpdateTaskGraphLog(var.namespace, var.id, var.log) ## End(Not run)
## Not run: #################### CreateTaskGraphLog #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace that will own this task graph log. var.log <- TaskGraphLog$new() # TaskGraphLog | api.instance <- TaskGraphLogsApi$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$CreateTaskGraphLog(var.namespace, var.log) #################### GetTaskGraphLog #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace that owns this task graph log. var.id <- 'id_example' # character | The UUID of the task graph log entry. api.instance <- TaskGraphLogsApi$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$GetTaskGraphLog(var.namespace, var.id) #################### ListTaskGraphLogs #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | Include logs for this namespace. var.created.by <- 'created.by_example' # character | Include logs from only this user. var.search <- 'search_example' # character | search string that will look at name. var.start.time <- 'start.time_example' # character | Include logs created after this time. var.end.time <- 'end.time_example' # character | Include logs created before this time. var.page <- 56 # integer | pagination offset var.per.page <- 56 # integer | pagination limit api.instance <- TaskGraphLogsApi$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$ListTaskGraphLogs(namespace=var.namespace, created.by=var.created.by, search=var.search, start.time=var.start.time, end.time=var.end.time, page=var.page, per.page=var.per.page) #################### UpdateTaskGraphLog #################### library(tiledbcloud) var.namespace <- 'namespace_example' # character | The namespace that owns this task graph log. var.id <- 'id_example' # character | The UUID of the task graph log entry. var.log <- TaskGraphLog$new() # TaskGraphLog | Updates to make to the task graph log. The only manual update that a client should need to make to a task graph log is to update its completion status to `succeeded`, `failed`, or `cancelled`. api.instance <- TaskGraphLogsApi$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$UpdateTaskGraphLog(var.namespace, var.id, var.log) ## End(Not run)
TaskGraphLogsData Class
An R6Class
generator object
task_graph_logs
list( TaskGraphLog ) [optional]
pagination_metadata
PaginationMetadata [optional]
new()
TaskGraphLogsData$new(task_graph_logs = NULL, pagination_metadata = NULL, ...)
toJSON()
TaskGraphLogsData$toJSON()
fromJSON()
TaskGraphLogsData$fromJSON(TaskGraphLogsDataJson)
toJSONString()
TaskGraphLogsData$toJSONString()
fromJSONString()
TaskGraphLogsData$fromJSONString(TaskGraphLogsDataJson)
clone()
The objects of this class are cloneable with this method.
TaskGraphLogsData$clone(deep = FALSE)
deep
Whether to make a deep clone.
TaskGraphLogStatus Class
An R6Class
generator object
new()
TaskGraphLogStatus$new(...)
toJSON()
TaskGraphLogStatus$toJSON()
fromJSON()
TaskGraphLogStatus$fromJSON(TaskGraphLogStatusJson)
toJSONString()
TaskGraphLogStatus$toJSONString()
fromJSONString()
TaskGraphLogStatus$fromJSONString(TaskGraphLogStatusJson)
clone()
The objects of this class are cloneable with this method.
TaskGraphLogStatus$clone(deep = FALSE)
deep
Whether to make a deep clone.
TaskGraphNodeMetadata Class
An R6Class
generator object
client_node_uuid
character [optional]
name
character [optional]
depends_on
list( character ) [optional]
executions
list( ArrayTask ) [optional]
new()
TaskGraphNodeMetadata$new( client_node_uuid = NULL, name = NULL, depends_on = NULL, executions = NULL, ... )
toJSON()
TaskGraphNodeMetadata$toJSON()
fromJSON()
TaskGraphNodeMetadata$fromJSON(TaskGraphNodeMetadataJson)
toJSONString()
TaskGraphNodeMetadata$toJSONString()
fromJSONString()
TaskGraphNodeMetadata$fromJSONString(TaskGraphNodeMetadataJson)
clone()
The objects of this class are cloneable with this method.
TaskGraphNodeMetadata$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.Tasks
An R6Class
generator object
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 :
apiClient
Handles the client-server communication.
new()
TasksApi$new(apiClient)
RunSQL()
TasksApi$RunSQL(namespace, sql, accept.encoding = NULL, ...)
RunSQLWithHttpInfo()
TasksApi$RunSQLWithHttpInfo(namespace, sql, accept.encoding = NULL, ...)
TaskIdGet()
TasksApi$TaskIdGet(id, ...)
TaskIdGetWithHttpInfo()
TasksApi$TaskIdGetWithHttpInfo(id, ...)
TaskIdResultGet()
TasksApi$TaskIdResultGet(id, accept.encoding = NULL, ...)
TaskIdResultGetWithHttpInfo()
TasksApi$TaskIdResultGetWithHttpInfo(id, accept.encoding = NULL, ...)
TasksGet()
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, ... )
TasksGetWithHttpInfo()
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, ... )
clone()
The objects of this class are cloneable with this method.
TasksApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## 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)
## 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)
TileDBConfig Class
An R6Class
generator object
configs
named list( character ) [optional]
new()
TileDBConfig$new(configs = NULL, ...)
toJSON()
TileDBConfig$toJSON()
fromJSON()
TileDBConfig$fromJSON(TileDBConfigJson)
toJSONString()
TileDBConfig$toJSONString()
fromJSONString()
TileDBConfig$fromJSONString(TileDBConfigJson)
clone()
The objects of this class are cloneable with this method.
TileDBConfig$clone(deep = FALSE)
deep
Whether to make a deep clone.
Token Class
An R6Class
generator object
token
character [optional]
name
character [optional]
issued_at
character [optional]
expires_at
character [optional]
scope
character [optional]
new()
Token$new( token = NULL, name = NULL, issued_at = NULL, expires_at = NULL, scope = "*", ... )
toJSON()
Token$toJSON()
fromJSON()
Token$fromJSON(TokenJson)
toJSONString()
Token$toJSONString()
fromJSONString()
Token$fromJSONString(TokenJson)
clone()
The objects of this class are cloneable with this method.
Token$clone(deep = FALSE)
deep
Whether to make a deep clone.
TokenRequest Class
An R6Class
generator object
expires
character [optional]
name
character [optional]
scope
character [optional]
new()
TokenRequest$new(expires = NULL, name = NULL, scope = "*", ...)
toJSON()
TokenRequest$toJSON()
fromJSON()
TokenRequest$fromJSON(TokenRequestJson)
toJSONString()
TokenRequest$toJSONString()
fromJSONString()
TokenRequest$fromJSONString(TokenRequestJson)
clone()
The objects of this class are cloneable with this method.
TokenRequest$clone(deep = FALSE)
deep
Whether to make a deep clone.
TokenScope Class
An R6Class
generator object
new()
TokenScope$new(...)
toJSON()
TokenScope$toJSON()
fromJSON()
TokenScope$fromJSON(TokenScopeJson)
toJSONString()
TokenScope$toJSONString()
fromJSONString()
TokenScope$fromJSONString(TokenScopeJson)
clone()
The objects of this class are cloneable with this method.
TokenScope$clone(deep = FALSE)
deep
Whether to make a deep clone.
UDFActions Class
An R6Class
generator object
new()
UDFActions$new(...)
toJSON()
UDFActions$toJSON()
fromJSON()
UDFActions$fromJSON(UDFActionsJson)
toJSONString()
UDFActions$toJSONString()
fromJSONString()
UDFActions$fromJSONString(UDFActionsJson)
clone()
The objects of this class are cloneable with this method.
UDFActions$clone(deep = FALSE)
deep
Whether to make a deep clone.
tiledbcloud.Udf
An R6Class
generator object
DeleteUDFInfo delete a registered UDF – this will remove all sharing and can not be undone
@param namespace character
@param name character
status code : 202 | UDF delete successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
GetUDFInfo get a specific UDF in the given namespace
@param namespace character
@param name character
@returnType UDFInfo
status code : 200 | UDFInfo was retrieved successfully
return type : UDFInfo
response headers :
status code : 404 | UDF not found
response headers :
status code : 0 | error response
return type : Error
response headers :
GetUDFInfoSharingPolicies Get all sharing details of the UDF
@param namespace character
@param name character
@returnType list( UDFSharing )
status code : 200 | List of all specific sharing policies
return type : array[UDFSharing]
response headers :
status code : 404 | UDF does not exist or user does not have permissions to view array-sharing policies
response headers :
status code : 0 | error response
return type : Error
response headers :
RegisterUDFInfo register a UDF in the given namespace
@param namespace character
@param name character
@param udf UDFInfoUpdate
status code : 204 | UDF registered successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
ShareUDFInfo Share a UDF with a user
@param namespace character
@param name character
@param udf.sharing UDFSharing
status code : 204 | UDF shared successfully
response headers :
status code : 404 | UDF does not exist or user does not have permissions to share UDF
response headers :
status code : 0 | error response
return type : Error
response headers :
SubmitGenericUDF submit a generic UDF in the given namespace
@param namespace character
@param udf GenericUDF
@param accept.encoding character
status code : 200 | UDF completed and the UDF-type specific result is returned
return type : data.frame
response headers :
X-TILEDB-CLOUD-TASK-ID | Task ID for just completed request |
status code : 0 | error response
return type : Error
response headers :
X-TILEDB-CLOUD-TASK-ID | Task ID for just completed request |
SubmitMultiArrayUDF submit a multi-array UDF in the given namespace
@param namespace character
@param udf MultiArrayUDF
@param accept.encoding character
status code : 200 | UDF completed and the UDF-type specific result is returned
return type : data.frame
response headers :
X-TILEDB-CLOUD-TASK-ID | Task ID for just completed request |
status code : 0 | error response
return type : Error
response headers :
X-TILEDB-CLOUD-TASK-ID | Task ID for just completed request |
SubmitUDF send a UDF to run against a specified array/URI registered to a group/project
@param namespace character
@param array character
@param udf MultiArrayUDF
@param x.payer character
@param accept.encoding character
@param v2 character
status code : 200 | UDF completed and the UDF-type specific result is returned
return type : data.frame
response headers :
X-TILEDB-CLOUD-TASK-ID | Task ID for just completed request |
status code : 0 | error response
return type : Error
response headers :
X-TILEDB-CLOUD-TASK-ID | Task ID for just completed request |
UdfNamespaceArrayEndTimestampsGet retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated
@param namespace character
@param array character
@param page integer
@param per.page integer
@returnType ArrayEndTimestampData
status code : 200 | list of timestamps in milliseconds, paginated
return type : ArrayEndTimestampData
response headers :
status code : 0 | error response
return type : Error
response headers :
UpdateUDFInfo update an existing registered UDF in the given namespace
@param namespace character
@param name character
@param udf UDFInfoUpdate
status code : 204 | UDF updated successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
UdfApi$new(apiClient)
DeleteUDFInfo()
UdfApi$DeleteUDFInfo(namespace, name, ...)
DeleteUDFInfoWithHttpInfo()
UdfApi$DeleteUDFInfoWithHttpInfo(namespace, name, ...)
GetUDFInfo()
UdfApi$GetUDFInfo(namespace, name, ...)
GetUDFInfoWithHttpInfo()
UdfApi$GetUDFInfoWithHttpInfo(namespace, name, ...)
GetUDFInfoSharingPolicies()
UdfApi$GetUDFInfoSharingPolicies(namespace, name, ...)
GetUDFInfoSharingPoliciesWithHttpInfo()
UdfApi$GetUDFInfoSharingPoliciesWithHttpInfo(namespace, name, ...)
RegisterUDFInfo()
UdfApi$RegisterUDFInfo(namespace, name, udf, ...)
RegisterUDFInfoWithHttpInfo()
UdfApi$RegisterUDFInfoWithHttpInfo(namespace, name, udf, ...)
ShareUDFInfo()
UdfApi$ShareUDFInfo(namespace, name, udf.sharing, ...)
ShareUDFInfoWithHttpInfo()
UdfApi$ShareUDFInfoWithHttpInfo(namespace, name, udf.sharing, ...)
SubmitGenericUDF()
UdfApi$SubmitGenericUDF(namespace, udf, accept.encoding = NULL, ...)
SubmitGenericUDFWithHttpInfo()
UdfApi$SubmitGenericUDFWithHttpInfo( namespace, udf, accept.encoding = NULL, ... )
SubmitMultiArrayUDF()
UdfApi$SubmitMultiArrayUDF(namespace, udf, accept.encoding = NULL, ...)
SubmitMultiArrayUDFWithHttpInfo()
UdfApi$SubmitMultiArrayUDFWithHttpInfo( namespace, udf, accept.encoding = NULL, ... )
SubmitUDF()
UdfApi$SubmitUDF( namespace, array, udf, x.payer = NULL, accept.encoding = NULL, v2 = NULL, ... )
SubmitUDFWithHttpInfo()
UdfApi$SubmitUDFWithHttpInfo( namespace, array, udf, x.payer = NULL, accept.encoding = NULL, v2 = NULL, ... )
UdfNamespaceArrayEndTimestampsGet()
UdfApi$UdfNamespaceArrayEndTimestampsGet( namespace, array, page = NULL, per.page = NULL, ... )
UdfNamespaceArrayEndTimestampsGetWithHttpInfo()
UdfApi$UdfNamespaceArrayEndTimestampsGetWithHttpInfo( namespace, array, page = NULL, per.page = NULL, ... )
UpdateUDFInfo()
UdfApi$UpdateUDFInfo(namespace, name, udf, ...)
UpdateUDFInfoWithHttpInfo()
UdfApi$UpdateUDFInfoWithHttpInfo(namespace, name, udf, ...)
clone()
The objects of this class are cloneable with this method.
UdfApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run:
#################### DeleteUDFInfo ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.name <- 'name_example' # character | name to register UDF under
api.instance <- UdfApi$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$DeleteUDFInfo(var.namespace, var.name)
#################### GetUDFInfo ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.name <- 'name_example' # character | name to register UDF under
api.instance <- UdfApi$