docs/NotebookApi.md

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

NotebookApi

All URIs are relative to http://localhost/v1

Method | HTTP request | Description ------------- | ------------- | ------------- GetNotebookServerStatus | GET /notebooks/server/{namespace}/status | ShutdownNotebookServer | DELETE /notebooks/server/{namespace} | UpdateNotebookName | PATCH /notebooks/{namespace}/{array}/rename |

GetNotebookServerStatus

NotebookStatus GetNotebookServerStatus(namespace)

Get status of the notebook server

Example

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
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
result <- api.instance$GetNotebookServerStatus(var.namespace)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace notebook is in (an organization name or user's username) |

Return type

NotebookStatus

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | status of running notebook | - | | 202 | Notebook server is pending | - | | 402 | Payment required | - | | 404 | Notebook is not running | - | | 0 | error response | - |

ShutdownNotebookServer

ShutdownNotebookServer(namespace)

Shutdown a notebook server

Example

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
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$ShutdownNotebookServer(var.namespace)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace notebook is in (an organization name or user's username) |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | Notebook shutdown successfully | - | | 404 | Notebook is not running | - | | 0 | error response | - |

UpdateNotebookName

UpdateNotebookName(namespace, array, notebook.metadata)

update name on a notebok, moving related s3 object to new location

Example

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("description_example", "name_example", "uri_example", FileType$new(), TODO, "access_credentials_name_example", "logo_example", list("tags_example"), "license_id_example", "license_text_example", "read_only_example") # 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
api.instance$apiClient$username <- 'TODO_YOUR_USERNAME';
api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD';
api.instance$UpdateNotebookName(var.namespace, var.array, var.notebook.metadata)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- namespace | character| namespace array is in (an organization name or user's username) | array | character| name/uri of notebook (array) that is url-encoded | notebook.metadata | ArrayInfoUpdate| notebook (array) metadata to update |

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | notebook name updated successfully | - | | 0 | error response | - |

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