NotebooksApi: Notebooks operations

NotebooksApiR Documentation

Notebooks operations

Description

tiledbcloud.Notebooks

Format

An R6Class generator object

Methods

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 :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods


Method new()

Usage
NotebooksApi$new(apiClient)

Method NotebooksNamespaceArrayEndTimestampsGet()

Usage
NotebooksApi$NotebooksNamespaceArrayEndTimestampsGet(
  namespace,
  array,
  page = NULL,
  per.page = NULL,
  ...
)

Method NotebooksNamespaceArrayEndTimestampsGetWithHttpInfo()

Usage
NotebooksApi$NotebooksNamespaceArrayEndTimestampsGetWithHttpInfo(
  namespace,
  array,
  page = NULL,
  per.page = NULL,
  ...
)

Method clone()

The objects of this class are cloneable with this method.

Usage
NotebooksApi$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

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

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