NotebookApi: Notebook operations

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

Notebook operations

Description

tiledbcloud.Notebook

Format

An R6Class generator object

Methods

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 :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• NotebookApi$new()

• NotebookApi$GetNotebookServerStatus()

• NotebookApi$GetNotebookServerStatusWithHttpInfo()

• NotebookApi$ShutdownNotebookServer()

• NotebookApi$ShutdownNotebookServerWithHttpInfo()

• NotebookApi$UpdateNotebookName()

• NotebookApi$UpdateNotebookNameWithHttpInfo()

• NotebookApi$clone()

---

Method new()

Usage

NotebookApi$new(apiClient)

---

Method GetNotebookServerStatus()

Usage

NotebookApi$GetNotebookServerStatus(namespace, ...)

---

Method GetNotebookServerStatusWithHttpInfo()

Usage

NotebookApi$GetNotebookServerStatusWithHttpInfo(namespace, ...)

---

Method ShutdownNotebookServer()

Usage

NotebookApi$ShutdownNotebookServer(namespace, ...)

---

Method ShutdownNotebookServerWithHttpInfo()

Usage

NotebookApi$ShutdownNotebookServerWithHttpInfo(namespace, ...)

---

Method UpdateNotebookName()

Usage

NotebookApi$UpdateNotebookName(namespace, array, notebook.metadata, ...)

---

Method UpdateNotebookNameWithHttpInfo()

Usage

NotebookApi$UpdateNotebookNameWithHttpInfo(
  namespace,
  array,
  notebook.metadata,
  ...
)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

NotebookApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

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

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