Package 'tiledbcloud'

Description

This is a package-internal function for code-deduplication within various manual-layer functions.

Usage

.get_decoded_response_body_or_stop(
  resultObject,
  result_format,
  entire_json_is_result = FALSE
)

Arguments

Details

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.

Value

The argument, decoded according to the specified result format.

Description

This is a package-internal function for code-deduplication within various manual-layer functions.

Usage

.get_empty_response_body_or_stop(resultObject)

Arguments

Details

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.

Value

Invisible on success, or stop() on failure.

Description

This is a package-internal function for code-deduplication within various manual-layer functions.

Usage

.get_raw_response_body_or_stop(resultObject)

Arguments

Details

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().

Value

The argument, as long as it's of type raw. Else, stops. The caller can then decode the raw body.

Description

Used for overriding the OpenAPI-autogenerated HTTP-response handling.

Usage

.wrap_as_api_response(resp)

Arguments

Details

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.

Value

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.

Description

ActivityEventType Class

Format

An R6Class generator object

Methods

Public methods

• ActivityEventType$new()

• ActivityEventType$toJSON()

• ActivityEventType$fromJSON()

• ActivityEventType$toJSONString()

• ActivityEventType$fromJSONString()

• ActivityEventType$clone()

Method new()

Usage

ActivityEventType$new(...)

Method toJSON()

Usage

ActivityEventType$toJSON()

Method fromJSON()

Usage

ActivityEventType$fromJSON(ActivityEventTypeJson)

Method toJSONString()

Usage

ActivityEventType$toJSONString()

Method fromJSONString()

Usage

ActivityEventType$fromJSONString(ActivityEventTypeJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ActivityEventType$clone(deep = FALSE)

Arguments

Description

ApiClient Class

Format

An R6Class generator object

Details

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.

Public fields

Methods

Public methods

• ApiClient$new()

• ApiClient$CallApi()

• ApiClient$ExecuteWrapped()

• ApiClient$Execute()

• ApiClient$deserialize()

• ApiClient$deserializeObj()

• ApiClient$clone()

Method new()

Usage

ApiClient$new(
  basePath = NULL,
  userAgent = NULL,
  defaultHeaders = NULL,
  username = NULL,
  password = NULL,
  apiKeys = NULL,
  accessToken = NULL,
  timeout = NULL,
  retryStatusCodes = NULL,
  maxRetryAttempts = NULL
)

Method CallApi()

Usage

ApiClient$CallApi(url, method, queryParams, headerParams, body, ...)

Method ExecuteWrapped()

Usage

ApiClient$ExecuteWrapped(url, method, queryParams, headerParams, body, ...)

Method Execute()

Usage

ApiClient$Execute(url, method, queryParams, headerParams, body, ...)

Method deserialize()

Usage

ApiClient$deserialize(resp, returnType, pkgEnv)

Method deserializeObj()

Usage

ApiClient$deserializeObj(obj, returnType, pkgEnv)

Method clone()

The objects of this class are cloneable with this method.

Usage

ApiClient$clone(deep = FALSE)

Arguments

Description

ApiResponse Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ApiResponse$new()

• ApiResponse$clone()

Method new()

Usage

ApiResponse$new(content, response)

Method clone()

The objects of this class are cloneable with this method.

Usage

ApiResponse$clone(deep = FALSE)

Arguments

Description

Array Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• Array$new()

• Array$toJSON()

• Array$fromJSON()

• Array$toJSONString()

• Array$fromJSONString()

• Array$clone()

Method new()

Usage

Array$new(timestamp, queryType, uri, ...)

Method toJSON()

Usage

Array$toJSON()

Method fromJSON()

Usage

Array$fromJSON(ArrayJson)

Method toJSONString()

Usage

Array$toJSONString()

Method fromJSONString()

Usage

Array$fromJSONString(ArrayJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

Array$clone(deep = FALSE)

Arguments

Description

This function shows array information on TileDB Cloud.

Usage

array_info(namespace, arrayname)

Arguments

Details

Nominally you will first call login; if not, the results of the last login at ~/.tiledb/cloud.json will be used.

Value

A list of array properties

See Also

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()

Description

ArrayActions Class

Format

An R6Class generator object

Methods

Public methods

• ArrayActions$new()

• ArrayActions$toJSON()

• ArrayActions$fromJSON()

• ArrayActions$toJSONString()

• ArrayActions$fromJSONString()

• ArrayActions$clone()

Method new()

Usage

ArrayActions$new(...)

Method toJSON()

Usage

ArrayActions$toJSON()

Method fromJSON()

Usage

ArrayActions$fromJSON(ArrayActionsJson)

Method toJSONString()

Usage

ArrayActions$toJSONString()

Method fromJSONString()

Usage

ArrayActions$fromJSONString(ArrayActionsJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayActions$clone(deep = FALSE)

Arguments

Description

ArrayActivityLog Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayActivityLog$new()

• ArrayActivityLog$toJSON()

• ArrayActivityLog$fromJSON()

• ArrayActivityLog$toJSONString()

• ArrayActivityLog$fromJSONString()

• ArrayActivityLog$clone()

Method new()

Usage

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,
  ...
)

Method toJSON()

Usage

ArrayActivityLog$toJSON()

Method fromJSON()

Usage

ArrayActivityLog$fromJSON(ArrayActivityLogJson)

Method toJSONString()

Usage

ArrayActivityLog$toJSONString()

Method fromJSONString()

Usage

ArrayActivityLog$fromJSONString(ArrayActivityLogJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayActivityLog$clone(deep = FALSE)

Arguments

Description

tiledbcloud.Array

Format

An R6Class generator object

Methods

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 :

Public fields

Methods

Public methods

• ArrayApi$new()

• ArrayApi$ArrayActivityLog()

• ArrayApi$ArrayActivityLogWithHttpInfo()

• ArrayApi$ArraysBrowserOwnedGet()

• ArrayApi$ArraysBrowserOwnedGetWithHttpInfo()

• ArrayApi$ArraysBrowserOwnedSidebarGet()

• ArrayApi$ArraysBrowserOwnedSidebarGetWithHttpInfo()

• ArrayApi$ArraysBrowserPublicGet()

• ArrayApi$ArraysBrowserPublicGetWithHttpInfo()

• ArrayApi$ArraysBrowserPublicSidebarGet()

• ArrayApi$ArraysBrowserPublicSidebarGetWithHttpInfo()

• ArrayApi$ArraysBrowserSharedGet()

• ArrayApi$ArraysBrowserSharedGetWithHttpInfo()

• ArrayApi$ArraysBrowserSharedSidebarGet()

• ArrayApi$ArraysBrowserSharedSidebarGetWithHttpInfo()

• ArrayApi$ArraysNamespaceArrayEndTimestampsGet()

• ArrayApi$ArraysNamespaceArrayEndTimestampsGetWithHttpInfo()

• ArrayApi$ConsolidateArray()

• ArrayApi$ConsolidateArrayWithHttpInfo()

• ArrayApi$CreateArray()

• ArrayApi$CreateArrayWithHttpInfo()

• ArrayApi$DeleteArray()

• ArrayApi$DeleteArrayWithHttpInfo()

• ArrayApi$DeregisterArray()

• ArrayApi$DeregisterArrayWithHttpInfo()

• ArrayApi$GetActivityLogById()

• ArrayApi$GetActivityLogByIdWithHttpInfo()

• ArrayApi$GetAllArrayMetadata()

• ArrayApi$GetAllArrayMetadataWithHttpInfo()

• ArrayApi$GetArray()

• ArrayApi$GetArrayWithHttpInfo()

• ArrayApi$GetArrayMaxBufferSizes()

• ArrayApi$GetArrayMaxBufferSizesWithHttpInfo()

• ArrayApi$GetArrayMetaDataJson()

• ArrayApi$GetArrayMetaDataJsonWithHttpInfo()

• ArrayApi$GetArrayMetadata()

• ArrayApi$GetArrayMetadataWithHttpInfo()

• ArrayApi$GetArrayMetadataCapnp()

• ArrayApi$GetArrayMetadataCapnpWithHttpInfo()

• ArrayApi$GetArrayNonEmptyDomain()

• ArrayApi$GetArrayNonEmptyDomainWithHttpInfo()

• ArrayApi$GetArrayNonEmptyDomainJson()

• ArrayApi$GetArrayNonEmptyDomainJsonWithHttpInfo()

• ArrayApi$GetArraySampleData()

• ArrayApi$GetArraySampleDataWithHttpInfo()

• ArrayApi$GetArraySharingPolicies()

• ArrayApi$GetArraySharingPoliciesWithHttpInfo()

• ArrayApi$GetArraysInNamespace()

• ArrayApi$GetArraysInNamespaceWithHttpInfo()

• ArrayApi$GetFragmentEndTimestamp()

• ArrayApi$GetFragmentEndTimestampWithHttpInfo()

• ArrayApi$GetLastAccessedArrays()

• ArrayApi$GetLastAccessedArraysWithHttpInfo()

• ArrayApi$RegisterArray()

• ArrayApi$RegisterArrayWithHttpInfo()

• ArrayApi$ShareArray()

• ArrayApi$ShareArrayWithHttpInfo()

• ArrayApi$UpdateArrayMetadata()

• ArrayApi$UpdateArrayMetadataWithHttpInfo()

• ArrayApi$UpdateArrayMetadataCapnp()

• ArrayApi$UpdateArrayMetadataCapnpWithHttpInfo()

• ArrayApi$VacuumArray()

• ArrayApi$VacuumArrayWithHttpInfo()

• ArrayApi$clone()

Method new()

Usage

ArrayApi$new(apiClient)

Method ArrayActivityLog()

Usage

ArrayApi$ArrayActivityLog(
  namespace,
  array,
  start = NULL,
  end = NULL,
  event.types = NULL,
  task.id = NULL,
  has.task.id = NULL,
  ...
)

Method ArrayActivityLogWithHttpInfo()

Usage

ArrayApi$ArrayActivityLogWithHttpInfo(
  namespace,
  array,
  start = NULL,
  end = NULL,
  event.types = NULL,
  task.id = NULL,
  has.task.id = NULL,
  ...
)

Method ArraysBrowserOwnedGet()

Usage

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,
  ...
)

Method ArraysBrowserOwnedGetWithHttpInfo()

Usage

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,
  ...
)

Method ArraysBrowserOwnedSidebarGet()

Usage

ArrayApi$ArraysBrowserOwnedSidebarGet(...)

Method ArraysBrowserOwnedSidebarGetWithHttpInfo()

Usage

ArrayApi$ArraysBrowserOwnedSidebarGetWithHttpInfo(...)

Method ArraysBrowserPublicGet()

Usage

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,
  ...
)

Method ArraysBrowserPublicGetWithHttpInfo()

Usage

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,
  ...
)

Method ArraysBrowserPublicSidebarGet()

Usage

ArrayApi$ArraysBrowserPublicSidebarGet(...)

Method ArraysBrowserPublicSidebarGetWithHttpInfo()

Usage

ArrayApi$ArraysBrowserPublicSidebarGetWithHttpInfo(...)

Method ArraysBrowserSharedGet()

Usage

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,
  ...
)

Method ArraysBrowserSharedGetWithHttpInfo()

Usage

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,
  ...
)

Method ArraysBrowserSharedSidebarGet()

Usage

ArrayApi$ArraysBrowserSharedSidebarGet(...)

Method ArraysBrowserSharedSidebarGetWithHttpInfo()

Usage

ArrayApi$ArraysBrowserSharedSidebarGetWithHttpInfo(...)

Method ArraysNamespaceArrayEndTimestampsGet()

Usage

ArrayApi$ArraysNamespaceArrayEndTimestampsGet(
  namespace,
  array,
  page = NULL,
  per.page = NULL,
  ...
)

Method ArraysNamespaceArrayEndTimestampsGetWithHttpInfo()

Usage

ArrayApi$ArraysNamespaceArrayEndTimestampsGetWithHttpInfo(
  namespace,
  array,
  page = NULL,
  per.page = NULL,
  ...
)

Method ConsolidateArray()

Usage

ArrayApi$ConsolidateArray(namespace, array, tiledb.config, ...)

Method ConsolidateArrayWithHttpInfo()

Usage

ArrayApi$ConsolidateArrayWithHttpInfo(namespace, array, tiledb.config, ...)

Method CreateArray()

Usage

ArrayApi$CreateArray(
  namespace,
  array,
  content.type,
  array.schema,
  X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = NULL,
  ...
)

Method CreateArrayWithHttpInfo()

Usage

ArrayApi$CreateArrayWithHttpInfo(
  namespace,
  array,
  content.type,
  array.schema,
  X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = NULL,
  ...
)

Method DeleteArray()

Usage

ArrayApi$DeleteArray(namespace, array, content.type, ...)

Method DeleteArrayWithHttpInfo()

Usage

ArrayApi$DeleteArrayWithHttpInfo(namespace, array, content.type, ...)

Method DeregisterArray()

Usage

ArrayApi$DeregisterArray(namespace, array, ...)

Method DeregisterArrayWithHttpInfo()

Usage

ArrayApi$DeregisterArrayWithHttpInfo(namespace, array, ...)

Method GetActivityLogById()

Usage

ArrayApi$GetActivityLogById(namespace, array, id, ...)

Method GetActivityLogByIdWithHttpInfo()

Usage

ArrayApi$GetActivityLogByIdWithHttpInfo(namespace, array, id, ...)

Method GetAllArrayMetadata()

Usage

ArrayApi$GetAllArrayMetadata(public.share = NULL, ...)

Method GetAllArrayMetadataWithHttpInfo()

Usage

ArrayApi$GetAllArrayMetadataWithHttpInfo(public.share = NULL, ...)

Method GetArray()

Usage

ArrayApi$GetArray(namespace, array, content.type, ...)

Method GetArrayWithHttpInfo()

Usage

ArrayApi$GetArrayWithHttpInfo(namespace, array, content.type, ...)

Method GetArrayMaxBufferSizes()

Usage

ArrayApi$GetArrayMaxBufferSizes(
  namespace,
  array,
  subarray,
  content.type,
  x.payer = NULL,
  ...
)

Method GetArrayMaxBufferSizesWithHttpInfo()

Usage

ArrayApi$GetArrayMaxBufferSizesWithHttpInfo(
  namespace,
  array,
  subarray,
  content.type,
  x.payer = NULL,
  ...
)

Method GetArrayMetaDataJson()

Usage

ArrayApi$GetArrayMetaDataJson(
  namespace,
  array,
  length = NULL,
  end.timestamp = NULL,
  ...
)

Method GetArrayMetaDataJsonWithHttpInfo()

Usage

ArrayApi$GetArrayMetaDataJsonWithHttpInfo(
  namespace,
  array,
  length = NULL,
  end.timestamp = NULL,
  ...
)

Method GetArrayMetadata()

Usage

ArrayApi$GetArrayMetadata(namespace, array, ...)

Method GetArrayMetadataWithHttpInfo()

Usage

ArrayApi$GetArrayMetadataWithHttpInfo(namespace, array, ...)

Method GetArrayMetadataCapnp()

Usage

ArrayApi$GetArrayMetadataCapnp(namespace, array, ...)

Method GetArrayMetadataCapnpWithHttpInfo()

Usage

ArrayApi$GetArrayMetadataCapnpWithHttpInfo(namespace, array, ...)

Method GetArrayNonEmptyDomain()

Usage

ArrayApi$GetArrayNonEmptyDomain(
  namespace,
  array,
  content.type,
  x.payer = NULL,
  ...
)

Method GetArrayNonEmptyDomainWithHttpInfo()

Usage

ArrayApi$GetArrayNonEmptyDomainWithHttpInfo(
  namespace,
  array,
  content.type,
  x.payer = NULL,
  ...
)

Method GetArrayNonEmptyDomainJson()

Usage

ArrayApi$GetArrayNonEmptyDomainJson(namespace, array, ...)

Method GetArrayNonEmptyDomainJsonWithHttpInfo()

Usage

ArrayApi$GetArrayNonEmptyDomainJsonWithHttpInfo(namespace, array, ...)

Method GetArraySampleData()

Usage

ArrayApi$GetArraySampleData(namespace, array, samples = 5, ...)

Method GetArraySampleDataWithHttpInfo()

Usage

ArrayApi$GetArraySampleDataWithHttpInfo(namespace, array, samples = 5, ...)

Method GetArraySharingPolicies()

Usage

ArrayApi$GetArraySharingPolicies(namespace, array, ...)

Method GetArraySharingPoliciesWithHttpInfo()

Usage

ArrayApi$GetArraySharingPoliciesWithHttpInfo(namespace, array, ...)

Method GetArraysInNamespace()

Usage

ArrayApi$GetArraysInNamespace(namespace, ...)

Method GetArraysInNamespaceWithHttpInfo()

Usage

ArrayApi$GetArraysInNamespaceWithHttpInfo(namespace, ...)

Method GetFragmentEndTimestamp()

Usage

ArrayApi$GetFragmentEndTimestamp(namespace, array, end.timestamp = NULL, ...)

Method GetFragmentEndTimestampWithHttpInfo()

Usage

ArrayApi$GetFragmentEndTimestampWithHttpInfo(
  namespace,
  array,
  end.timestamp = NULL,
  ...
)

Method GetLastAccessedArrays()

Usage

ArrayApi$GetLastAccessedArrays(...)

Method GetLastAccessedArraysWithHttpInfo()

Usage

ArrayApi$GetLastAccessedArraysWithHttpInfo(...)

Method RegisterArray()

Usage

ArrayApi$RegisterArray(namespace, array, array.metadata, ...)

Method RegisterArrayWithHttpInfo()

Usage

ArrayApi$RegisterArrayWithHttpInfo(namespace, array, array.metadata, ...)

Method ShareArray()

Usage

ArrayApi$ShareArray(namespace, array, array.sharing, ...)

Method ShareArrayWithHttpInfo()

Usage

ArrayApi$ShareArrayWithHttpInfo(namespace, array, array.sharing, ...)

Method UpdateArrayMetadata()

Usage

ArrayApi$UpdateArrayMetadata(namespace, array, array.metadata, ...)

Method UpdateArrayMetadataWithHttpInfo()

Usage

ArrayApi$UpdateArrayMetadataWithHttpInfo(namespace, array, array.metadata, ...)

Method UpdateArrayMetadataCapnp()

Usage

ArrayApi$UpdateArrayMetadataCapnp(
  namespace,
  array,
  array.metadata.entries,
  ...
)

Method UpdateArrayMetadataCapnpWithHttpInfo()

Usage

ArrayApi$UpdateArrayMetadataCapnpWithHttpInfo(
  namespace,
  array,
  array.metadata.entries,
  ...
)

Method VacuumArray()

Usage

ArrayApi$VacuumArray(namespace, array, tiledb.config, ...)

Method VacuumArrayWithHttpInfo()

Usage

ArrayApi$VacuumArrayWithHttpInfo(namespace, array, tiledb.config, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayApi$clone(deep = FALSE)

Arguments

Examples

## 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)

Description

ArrayBrowserData Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayBrowserData$new()

• ArrayBrowserData$toJSON()

• ArrayBrowserData$fromJSON()

• ArrayBrowserData$toJSONString()

• ArrayBrowserData$fromJSONString()

• ArrayBrowserData$clone()

Method new()

Usage

ArrayBrowserData$new(arrays = NULL, pagination_metadata = NULL, ...)

Method toJSON()

Usage

ArrayBrowserData$toJSON()

Method fromJSON()

Usage

ArrayBrowserData$fromJSON(ArrayBrowserDataJson)

Method toJSONString()

Usage

ArrayBrowserData$toJSONString()

Method fromJSONString()

Usage

ArrayBrowserData$fromJSONString(ArrayBrowserDataJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayBrowserData$clone(deep = FALSE)

Arguments

Description

ArrayBrowserSidebar Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayBrowserSidebar$new()

• ArrayBrowserSidebar$toJSON()

• ArrayBrowserSidebar$fromJSON()

• ArrayBrowserSidebar$toJSONString()

• ArrayBrowserSidebar$fromJSONString()

• ArrayBrowserSidebar$clone()

Method new()

Usage

ArrayBrowserSidebar$new(
  namespaces = NULL,
  result_count_for_all = NULL,
  result_count_by_namespace = NULL,
  ...
)

Method toJSON()

Usage

ArrayBrowserSidebar$toJSON()

Method fromJSON()

Usage

ArrayBrowserSidebar$fromJSON(ArrayBrowserSidebarJson)

Method toJSONString()

Usage

ArrayBrowserSidebar$toJSONString()

Method fromJSONString()

Usage

ArrayBrowserSidebar$fromJSONString(ArrayBrowserSidebarJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayBrowserSidebar$clone(deep = FALSE)

Arguments

Description

ArrayEndTimestampData Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayEndTimestampData$new()

• ArrayEndTimestampData$toJSON()

• ArrayEndTimestampData$fromJSON()

• ArrayEndTimestampData$toJSONString()

• ArrayEndTimestampData$fromJSONString()

• ArrayEndTimestampData$clone()

Method new()

Usage

ArrayEndTimestampData$new(
  end_timestamps = NULL,
  pagination_metadata = NULL,
  ...
)

Method toJSON()

Usage

ArrayEndTimestampData$toJSON()

Method fromJSON()

Usage

ArrayEndTimestampData$fromJSON(ArrayEndTimestampDataJson)

Method toJSONString()

Usage

ArrayEndTimestampData$toJSONString()

Method fromJSONString()

Usage

ArrayEndTimestampData$fromJSONString(ArrayEndTimestampDataJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayEndTimestampData$clone(deep = FALSE)

Arguments

Description

ArrayFavorite Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayFavorite$new()

• ArrayFavorite$toJSON()

• ArrayFavorite$fromJSON()

• ArrayFavorite$toJSONString()

• ArrayFavorite$fromJSONString()

• ArrayFavorite$clone()

Method new()

Usage

ArrayFavorite$new(array_uuid = NULL, namespace = NULL, name = NULL, ...)

Method toJSON()

Usage

ArrayFavorite$toJSON()

Method fromJSON()

Usage

ArrayFavorite$fromJSON(ArrayFavoriteJson)

Method toJSONString()

Usage

ArrayFavorite$toJSONString()

Method fromJSONString()

Usage

ArrayFavorite$fromJSONString(ArrayFavoriteJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayFavorite$clone(deep = FALSE)

Arguments

Description

ArrayFavoritesData Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayFavoritesData$new()

• ArrayFavoritesData$toJSON()

• ArrayFavoritesData$fromJSON()

• ArrayFavoritesData$toJSONString()

• ArrayFavoritesData$fromJSONString()

• ArrayFavoritesData$clone()

Method new()

Usage

ArrayFavoritesData$new(arrays = NULL, pagination_metadata = NULL, ...)

Method toJSON()

Usage

ArrayFavoritesData$toJSON()

Method fromJSON()

Usage

ArrayFavoritesData$fromJSON(ArrayFavoritesDataJson)

Method toJSONString()

Usage

ArrayFavoritesData$toJSONString()

Method fromJSONString()

Usage

ArrayFavoritesData$fromJSONString(ArrayFavoritesDataJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayFavoritesData$clone(deep = FALSE)

Arguments

Description

ArrayInfo Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayInfo$new()

• ArrayInfo$toJSON()

• ArrayInfo$fromJSON()

• ArrayInfo$toJSONString()

• ArrayInfo$fromJSONString()

• ArrayInfo$clone()

Method new()

Usage

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,
  ...
)

Method toJSON()

Usage

ArrayInfo$toJSON()

Method fromJSON()

Usage

ArrayInfo$fromJSON(ArrayInfoJson)

Method toJSONString()

Usage

ArrayInfo$toJSONString()

Method fromJSONString()

Usage

ArrayInfo$fromJSONString(ArrayInfoJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayInfo$clone(deep = FALSE)

Arguments

Description

ArrayInfoUpdate Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayInfoUpdate$new()

• ArrayInfoUpdate$toJSON()

• ArrayInfoUpdate$fromJSON()

• ArrayInfoUpdate$toJSONString()

• ArrayInfoUpdate$fromJSONString()

• ArrayInfoUpdate$clone()

Method new()

Usage

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,
  ...
)

Method toJSON()

Usage

ArrayInfoUpdate$toJSON()

Method fromJSON()

Usage

ArrayInfoUpdate$fromJSON(ArrayInfoUpdateJson)

Method toJSONString()

Usage

ArrayInfoUpdate$toJSONString()

Method fromJSONString()

Usage

ArrayInfoUpdate$fromJSONString(ArrayInfoUpdateJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayInfoUpdate$clone(deep = FALSE)

Arguments

Description

ArrayMetadata Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayMetadata$new()

• ArrayMetadata$toJSON()

• ArrayMetadata$fromJSON()

• ArrayMetadata$toJSONString()

• ArrayMetadata$fromJSONString()

• ArrayMetadata$clone()

Method new()

Usage

ArrayMetadata$new(entries = NULL, ...)

Method toJSON()

Usage

ArrayMetadata$toJSON()

Method fromJSON()

Usage

ArrayMetadata$fromJSON(ArrayMetadataJson)

Method toJSONString()

Usage

ArrayMetadata$toJSONString()

Method fromJSONString()

Usage

ArrayMetadata$fromJSONString(ArrayMetadataJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayMetadata$clone(deep = FALSE)

Arguments

Description

ArrayMetadataEntry Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayMetadataEntry$new()

• ArrayMetadataEntry$toJSON()

• ArrayMetadataEntry$fromJSON()

• ArrayMetadataEntry$toJSONString()

• ArrayMetadataEntry$fromJSONString()

• ArrayMetadataEntry$clone()

Method new()

Usage

ArrayMetadataEntry$new(
  key = NULL,
  type = NULL,
  valueNum = NULL,
  value = NULL,
  del = NULL,
  ...
)

Method toJSON()

Usage

ArrayMetadataEntry$toJSON()

Method fromJSON()

Usage

ArrayMetadataEntry$fromJSON(ArrayMetadataEntryJson)

Method toJSONString()

Usage

ArrayMetadataEntry$toJSONString()

Method fromJSONString()

Usage

ArrayMetadataEntry$fromJSONString(ArrayMetadataEntryJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayMetadataEntry$clone(deep = FALSE)

Arguments

Description

ArraySample Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArraySample$new()

• ArraySample$toJSON()

• ArraySample$fromJSON()

• ArraySample$toJSONString()

• ArraySample$fromJSONString()

• ArraySample$clone()

Method new()

Usage

ArraySample$new(data = NULL, ...)

Method toJSON()

Usage

ArraySample$toJSON()

Method fromJSON()

Usage

ArraySample$fromJSON(ArraySampleJson)

Method toJSONString()

Usage

ArraySample$toJSONString()

Method fromJSONString()

Usage

ArraySample$fromJSONString(ArraySampleJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArraySample$clone(deep = FALSE)

Arguments

Description

ArraySchema Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArraySchema$new()

• ArraySchema$toJSON()

• ArraySchema$fromJSON()

• ArraySchema$toJSONString()

• ArraySchema$fromJSONString()

• ArraySchema$clone()

Method new()

Usage

ArraySchema$new(
  version,
  arrayType,
  tileOrder,
  cellOrder,
  capacity,
  coordsFilterPipeline,
  offsetFilterPipeline,
  domain,
  attributes,
  uri = NULL,
  allowsDuplicates = NULL,
  ...
)

Method toJSON()

Usage

ArraySchema$toJSON()

Method fromJSON()

Usage

ArraySchema$fromJSON(ArraySchemaJson)

Method toJSONString()

Usage

ArraySchema$toJSONString()

Method fromJSONString()

Usage

ArraySchema$fromJSONString(ArraySchemaJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArraySchema$clone(deep = FALSE)

Arguments

Description

ArraySharing Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArraySharing$new()

• ArraySharing$toJSON()

• ArraySharing$fromJSON()

• ArraySharing$toJSONString()

• ArraySharing$fromJSONString()

• ArraySharing$clone()

Method new()

Usage

ArraySharing$new(actions = NULL, namespace = NULL, namespace_type = NULL, ...)

Method toJSON()

Usage

ArraySharing$toJSON()

Method fromJSON()

Usage

ArraySharing$fromJSON(ArraySharingJson)

Method toJSONString()

Usage

ArraySharing$toJSONString()

Method fromJSONString()

Usage

ArraySharing$fromJSONString(ArraySharingJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArraySharing$clone(deep = FALSE)

Arguments

Description

ArrayTask Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayTask$new()

• ArrayTask$toJSON()

• ArrayTask$fromJSON()

• ArrayTask$toJSONString()

• ArrayTask$fromJSONString()

• ArrayTask$clone()

Method new()

Usage

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,
  ...
)

Method toJSON()

Usage

ArrayTask$toJSON()

Method fromJSON()

Usage

ArrayTask$fromJSON(ArrayTaskJson)

Method toJSONString()

Usage

ArrayTask$toJSONString()

Method fromJSONString()

Usage

ArrayTask$fromJSONString(ArrayTaskJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayTask$clone(deep = FALSE)

Arguments

Description

ArrayTaskBrowserSidebar Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayTaskBrowserSidebar$new()

• ArrayTaskBrowserSidebar$toJSON()

• ArrayTaskBrowserSidebar$fromJSON()

• ArrayTaskBrowserSidebar$toJSONString()

• ArrayTaskBrowserSidebar$fromJSONString()

• ArrayTaskBrowserSidebar$clone()

Method new()

Usage

ArrayTaskBrowserSidebar$new(
  organizations = NULL,
  result_count_for_all = NULL,
  result_count_by_namespace = NULL,
  ...
)

Method toJSON()

Usage

ArrayTaskBrowserSidebar$toJSON()

Method fromJSON()

Usage

ArrayTaskBrowserSidebar$fromJSON(ArrayTaskBrowserSidebarJson)

Method toJSONString()

Usage

ArrayTaskBrowserSidebar$toJSONString()

Method fromJSONString()

Usage

ArrayTaskBrowserSidebar$fromJSONString(ArrayTaskBrowserSidebarJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayTaskBrowserSidebar$clone(deep = FALSE)

Arguments

Description

ArrayTaskData Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayTaskData$new()

• ArrayTaskData$toJSON()

• ArrayTaskData$fromJSON()

• ArrayTaskData$toJSONString()

• ArrayTaskData$fromJSONString()

• ArrayTaskData$clone()

Method new()

Usage

ArrayTaskData$new(array_tasks = NULL, pagination_metadata = NULL, ...)

Method toJSON()

Usage

ArrayTaskData$toJSON()

Method fromJSON()

Usage

ArrayTaskData$fromJSON(ArrayTaskDataJson)

Method toJSONString()

Usage

ArrayTaskData$toJSONString()

Method fromJSONString()

Usage

ArrayTaskData$fromJSONString(ArrayTaskDataJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayTaskData$clone(deep = FALSE)

Arguments

Description

ArrayTaskLog Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• ArrayTaskLog$new()

• ArrayTaskLog$toJSON()

• ArrayTaskLog$fromJSON()

• ArrayTaskLog$toJSONString()

• ArrayTaskLog$fromJSONString()

• ArrayTaskLog$clone()

Method new()

Usage

ArrayTaskLog$new(array_task_id = NULL, logs = NULL, ...)

Method toJSON()

Usage

ArrayTaskLog$toJSON()

Method fromJSON()

Usage

ArrayTaskLog$fromJSON(ArrayTaskLogJson)

Method toJSONString()

Usage

ArrayTaskLog$toJSONString()

Method fromJSONString()

Usage

ArrayTaskLog$fromJSONString(ArrayTaskLogJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayTaskLog$clone(deep = FALSE)

Arguments

Description

tiledbcloud.ArrayTasks

Format

An R6Class generator object

Methods

GetArrayTasksSidebar

• @param start integer

• @param end integer

• @returnType ArrayTaskBrowserSidebar
  

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

• return type : ArrayTaskBrowserSidebar

• response headers :

• status code : 404 | array tasks not found

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

Public fields

Methods

Public methods

• ArrayTasksApi$new()

• ArrayTasksApi$GetArrayTasksSidebar()

• ArrayTasksApi$GetArrayTasksSidebarWithHttpInfo()

• ArrayTasksApi$clone()

Method new()

Usage

ArrayTasksApi$new(apiClient)

Method GetArrayTasksSidebar()

Usage

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

Method GetArrayTasksSidebarWithHttpInfo()

Usage

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

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayTasksApi$clone(deep = FALSE)

Arguments

Examples

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

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

api.instance <- ArrayTasksApi$new()

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

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

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



## End(Not run)

Description

ArrayTaskStatus Class

Format

An R6Class generator object

Methods

Public methods

• ArrayTaskStatus$new()

• ArrayTaskStatus$toJSON()

• ArrayTaskStatus$fromJSON()

• ArrayTaskStatus$toJSONString()

• ArrayTaskStatus$fromJSONString()

• ArrayTaskStatus$clone()

Method new()

Usage

ArrayTaskStatus$new(...)

Method toJSON()

Usage

ArrayTaskStatus$toJSON()

Method fromJSON()

Usage

ArrayTaskStatus$fromJSON(ArrayTaskStatusJson)

Method toJSONString()

Usage

ArrayTaskStatus$toJSONString()

Method fromJSONString()

Usage

ArrayTaskStatus$fromJSONString(ArrayTaskStatusJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayTaskStatus$clone(deep = FALSE)

Arguments

Description

ArrayTaskType Class

Format

An R6Class generator object

Methods

Public methods

• ArrayTaskType$new()

• ArrayTaskType$toJSON()

• ArrayTaskType$fromJSON()

• ArrayTaskType$toJSONString()

• ArrayTaskType$fromJSONString()

• ArrayTaskType$clone()

Method new()

Usage

ArrayTaskType$new(...)

Method toJSON()

Usage

ArrayTaskType$toJSON()

Method fromJSON()

Usage

ArrayTaskType$fromJSON(ArrayTaskTypeJson)

Method toJSONString()

Usage

ArrayTaskType$toJSONString()

Method fromJSONString()

Usage

ArrayTaskType$fromJSONString(ArrayTaskTypeJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayTaskType$clone(deep = FALSE)

Arguments

Description

ArrayType Class

Format

An R6Class generator object

Methods

Public methods

• ArrayType$new()

• ArrayType$toJSON()

• ArrayType$fromJSON()

• ArrayType$toJSONString()

• ArrayType$fromJSONString()

• ArrayType$clone()

Method new()

Usage

ArrayType$new(...)

Method toJSON()

Usage

ArrayType$toJSON()

Method fromJSON()

Usage

ArrayType$fromJSON(ArrayTypeJson)

Method toJSONString()

Usage

ArrayType$toJSONString()

Method fromJSONString()

Usage

ArrayType$fromJSONString(ArrayTypeJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayType$clone(deep = FALSE)

Arguments

Description

Attribute Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• Attribute$new()

• Attribute$toJSON()

• Attribute$fromJSON()

• Attribute$toJSONString()

• Attribute$fromJSONString()

• Attribute$clone()

Method new()

Usage

Attribute$new(
  name,
  type,
  filterPipeline,
  cellValNum,
  nullable = NULL,
  fillValue = NULL,
  ...
)

Method toJSON()

Usage

Attribute$toJSON()

Method fromJSON()

Usage

Attribute$fromJSON(AttributeJson)

Method toJSONString()

Usage

Attribute$toJSONString()

Method fromJSONString()

Usage

Attribute$fromJSONString(AttributeJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

Attribute$clone(deep = FALSE)

Arguments

Description

AttributeBufferHeader Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• AttributeBufferHeader$new()

• AttributeBufferHeader$toJSON()

• AttributeBufferHeader$fromJSON()

• AttributeBufferHeader$toJSONString()

• AttributeBufferHeader$fromJSONString()

• AttributeBufferHeader$clone()

Method new()

Usage

AttributeBufferHeader$new(
  name,
  fixedLenBufferSizeInBytes,
  varLenBufferSizeInBytes,
  ...
)

Method toJSON()

Usage

AttributeBufferHeader$toJSON()

Method fromJSON()

Usage

AttributeBufferHeader$fromJSON(AttributeBufferHeaderJson)

Method toJSONString()

Usage

AttributeBufferHeader$toJSONString()

Method fromJSONString()

Usage

AttributeBufferHeader$fromJSONString(AttributeBufferHeaderJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

AttributeBufferHeader$clone(deep = FALSE)

Arguments

Description

AttributeBufferSize Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• AttributeBufferSize$new()

• AttributeBufferSize$toJSON()

• AttributeBufferSize$fromJSON()

• AttributeBufferSize$toJSONString()

• AttributeBufferSize$fromJSONString()

• AttributeBufferSize$clone()

Method new()

Usage

AttributeBufferSize$new(attribute, offsetBytes, dataBytes, ...)

Method toJSON()

Usage

AttributeBufferSize$toJSON()

Method fromJSON()

Usage

AttributeBufferSize$fromJSON(AttributeBufferSizeJson)

Method toJSONString()

Usage

AttributeBufferSize$toJSONString()

Method fromJSONString()

Usage

AttributeBufferSize$fromJSONString(AttributeBufferSizeJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

AttributeBufferSize$clone(deep = FALSE)

Arguments

Description

AWSAccessCredentials Class

Format

An R6Class generator object

Public fields

Methods

Public methods

• AWSAccessCredentials$new()

• AWSAccessCredentials$toJSON()

• AWSAccessCredentials$fromJSON()

• AWSAccessCredentials$toJSONString()

• AWSAccessCredentials$fromJSONString()

• AWSAccessCredentials$clone()

Method new()

Usage

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,
  ...
)

Method toJSON()

Usage

AWSAccessCredentials$toJSON()

Method fromJSON()

Usage

AWSAccessCredentials$fromJSON(AWSAccessCredentialsJson)

Method toJSONString()

Usage

AWSAccessCredentials$toJSONString()

Method fromJSONString()

Usage

AWSAccessCredentials$fromJSONString(AWSAccessCredentialsJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

AWSAccessCredentials$clone(deep = FALSE)

Arguments

Description

The task graph is implicitly defined by various delayed objects having others in their argument lists.

Usage

compute(
  node,
  timeout_seconds = NULL,
  verbose = FALSE,
  namespace = NULL,
  force_all_local = FALSE
)

Arguments

Value

The value of the computation.

See Also

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()

Description

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.

Usage

compute_sequentially(node)

Arguments

Value

The value of the computation.

See Also

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()

Description

Provide the setup configuration for the TileDB Cloud package.

Usage

configure()

Details

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.

Value

A named vector with configuration values is returned.

Description

Datatype Class

Format

An R6Class generator object

Methods

Public methods

• Datatype$new()

• Datatype$toJSON()

• Datatype$fromJSON()

• Datatype$toJSONString()

• Datatype$fromJSONString()

• Datatype$clone()

Method new()

Usage

Datatype$new(...)

Method toJSON()

Usage

Datatype$toJSON()

Method fromJSON()

Usage

Datatype$fromJSON(DatatypeJson)

Method toJSONString()

Usage

Datatype$toJSONString()

Method fromJSONString()

Usage

Datatype$fromJSONString(DatatypeJson)

Method clone()

The objects of this class are cloneable with this method.

Usage

Datatype$clone(deep = FALSE)

Arguments

Description

Define a function to be executed within a task graph

Usage

delayed(func, args = NULL, name = NULL, namespace = NULL, local = FALSE)

Arguments

Value

A task-graph node object on which you can later call compute.

See Also

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()

Description

Get arguments for a delayed function, as a list.

Usage

delayed_args(node)

Arguments

See Also

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()

Description

Args can be set when delayed is called, or afterward using this function.

Usage

delayed_args(node) <- value

Arguments

See Also

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()

Description

Define a single-array UDF to be executed within a task graph

Usage

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"
)