tiledbcloud.Favorites
Methods
-
AddArrayFavorite
Add a new array favorite
@param namespace character
@param name character
status code : 204 | Item added to favorites successfully
response headers :
status code : 200 | OK return type : ArrayFavorite response headers :
status code : 200 | OK return type : MLModelFavorite response headers :
status code : 200 | OK return type : NotebookFavorite response headers :
status code : 200 | OK return type : UDFFavorite response headers :
status code : 200 | Available array favorites are returned return type : ArrayFavoritesData response headers :
status code : 200 | Available favorites array uuids are returned return type : array[ArrayFavorite] response headers :
status code : 200 | Available ML models favorites are returned return type : MLModelFavoritesData response headers :
status code : 200 | Available favorites ML model uuids are returned return type : array[MLModelFavorite] response headers :
status code : 200 | Available notebook favorites are returned return type : NotebookFavoritesData response headers :
status code : 200 | Available favorites notebook uuids are returned return type : array[NotebookFavorite] response headers :
status code : 200 | Available UDF favorites are returned return type : UDFFavoritesData response headers :
status code : 200 | Available favorites UDF uuids are returned return type : array[UDFFavorite] response headers :
Methods
Method new()
Usage
FavoritesApi$new(apiClient)
Examples
if (FALSE) { # \dontrun{
#################### AddArrayFavorite ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the array
var.name <- 'name_example' # character | The name of the array
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$AddArrayFavorite(var.namespace, var.name)
#################### AddMLModelFavorite ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the ML model
var.name <- 'name_example' # character | The name of the ML model
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$AddMLModelFavorite(var.namespace, var.name)
#################### AddNotebookFavorite ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the notebook
var.name <- 'name_example' # character | The name of the notebook
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$AddNotebookFavorite(var.namespace, var.name)
#################### AddUDFFavorite ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the UDF
var.name <- 'name_example' # character | The name of the UDF
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$AddUDFFavorite(var.namespace, var.name)
#################### DeleteArrayFavorite ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the array
var.name <- 'name_example' # character | The name of the array
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$DeleteArrayFavorite(var.namespace, var.name)
#################### DeleteMLModelFavorite ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the ML model
var.name <- 'name_example' # character | The name of the ML model
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$DeleteMLModelFavorite(var.namespace, var.name)
#################### DeleteNotebookFavorite ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the notebook
var.name <- 'name_example' # character | The name of the notebook
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$DeleteNotebookFavorite(var.namespace, var.name)
#################### DeleteUDFFavorite ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the UDF
var.name <- 'name_example' # character | The name of the UDF
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$DeleteUDFFavorite(var.namespace, var.name)
#################### GetArrayFavorite ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the array
var.name <- 'name_example' # character | The name of the array
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GetArrayFavorite(var.namespace, var.name)
#################### GetMLModelFavorite ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the ML model
var.name <- 'name_example' # character | The name of the ML model
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GetMLModelFavorite(var.namespace, var.name)
#################### GetNotebookFavorite ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the notebook
var.name <- 'name_example' # character | The name of the notebook
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GetNotebookFavorite(var.namespace, var.name)
#################### GetUDFFavorite ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the UDF
var.name <- 'name_example' # character | The name of the UDF
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GetUDFFavorite(var.namespace, var.name)
#################### ListArrayFavorites ####################
library(tiledbcloud)
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListArrayFavorites(page=var.page, per.page=var.per.page)
#################### ListArrayFavoritesUUIDs ####################
library(tiledbcloud)
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListArrayFavoritesUUIDs()
#################### ListMLModelFavorites ####################
library(tiledbcloud)
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListMLModelFavorites(page=var.page, per.page=var.per.page)
#################### ListMLModelFavoritesUUIDs ####################
library(tiledbcloud)
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListMLModelFavoritesUUIDs()
#################### ListNotebookFavorites ####################
library(tiledbcloud)
var.is.dashboard <- 'is.dashboard_example' # character | return only dashboards
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListNotebookFavorites(is.dashboard=var.is.dashboard, page=var.page, per.page=var.per.page)
#################### ListNotebookFavoritesUUIDs ####################
library(tiledbcloud)
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListNotebookFavoritesUUIDs()
#################### ListUDFFavorites ####################
library(tiledbcloud)
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListUDFFavorites(page=var.page, per.page=var.per.page)
#################### ListUDFFavoritesUUIDs ####################
library(tiledbcloud)
api.instance <- FavoritesApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListUDFFavoritesUUIDs()
} # }