FavoritesApi | R Documentation |
tiledbcloud.Favorites
An R6Class
generator object
AddArrayFavorite Add a new array favorite
@param namespace character
@param name character
status code : 204 | Item added to favorites successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
AddMLModelFavorite Add a new ML model favorite
@param namespace character
@param name character
status code : 204 | Item added to favorites successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
AddNotebookFavorite Add a new notebook favorite
@param namespace character
@param name character
status code : 204 | Item added to favorites successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
AddUDFFavorite Add a new UDF favorite
@param namespace character
@param name character
status code : 204 | Item added to favorites successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteArrayFavorite Delete specific array favorite
@param namespace character
@param name character
status code : 204 | array favorite item deleted successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteMLModelFavorite Delete specific ML model favorite
@param namespace character
@param name character
status code : 204 | ML model favorite item deleted successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteNotebookFavorite Delete specific notebook favorite
@param namespace character
@param name character
status code : 204 | notebook favorite item deleted successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteUDFFavorite Delete specific UDF favorite
@param namespace character
@param name character
status code : 204 | UDF favorite item deleted successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
GetArrayFavorite Fetch array favorite of a specific array
@param namespace character
@param name character
@returnType ArrayFavorite
status code : 200 | OK
return type : ArrayFavorite
response headers :
status code : 0 | error response
return type : Error
response headers :
GetMLModelFavorite Fetch ML model favorite of a specific ML model
@param namespace character
@param name character
@returnType MLModelFavorite
status code : 200 | OK
return type : MLModelFavorite
response headers :
status code : 0 | error response
return type : Error
response headers :
GetNotebookFavorite Fetch notebook favorite of a specific notebook
@param namespace character
@param name character
@returnType NotebookFavorite
status code : 200 | OK
return type : NotebookFavorite
response headers :
status code : 0 | error response
return type : Error
response headers :
GetUDFFavorite Fetch UDF favorite of a specific UDF
@param namespace character
@param name character
@returnType UDFFavorite
status code : 200 | OK
return type : UDFFavorite
response headers :
status code : 0 | error response
return type : Error
response headers :
ListArrayFavorites Fetch a page of array favorites of connected user
@param page integer
@param per.page integer
@returnType ArrayFavoritesData
status code : 200 | Available array favorites are returned
return type : ArrayFavoritesData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListArrayFavoritesUUIDs Fetch all favorite array uuids of connected user
@returnType list( ArrayFavorite )
status code : 200 | Available favorites array uuids are returned
return type : array[ArrayFavorite]
response headers :
status code : 0 | error response
return type : Error
response headers :
ListMLModelFavorites Fetch a page of ML models favorites of connected user
@param page integer
@param per.page integer
@returnType MLModelFavoritesData
status code : 200 | Available ML models favorites are returned
return type : MLModelFavoritesData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListMLModelFavoritesUUIDs Fetch all favorite ML models uuids of connected user
@returnType list( MLModelFavorite )
status code : 200 | Available favorites ML model uuids are returned
return type : array[MLModelFavorite]
response headers :
status code : 0 | error response
return type : Error
response headers :
ListNotebookFavorites Fetch a page of notebook favorites of connected user
@param is.dashboard character
@param page integer
@param per.page integer
@returnType NotebookFavoritesData
status code : 200 | Available notebook favorites are returned
return type : NotebookFavoritesData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListNotebookFavoritesUUIDs Fetch all favorite notebook uuids of connected user
@returnType list( NotebookFavorite )
status code : 200 | Available favorites notebook uuids are returned
return type : array[NotebookFavorite]
response headers :
status code : 0 | error response
return type : Error
response headers :
ListUDFFavorites Fetch a page of UDF favorites of connected user
@param page integer
@param per.page integer
@returnType UDFFavoritesData
status code : 200 | Available UDF favorites are returned
return type : UDFFavoritesData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListUDFFavoritesUUIDs Fetch all favorite UDF uuids of connected user
@returnType list( UDFFavorite )
status code : 200 | Available favorites UDF uuids are returned
return type : array[UDFFavorite]
response headers :
status code : 0 | error response
return type : Error
response headers :
apiClient
Handles the client-server communication.
new()
FavoritesApi$new(apiClient)
AddArrayFavorite()
FavoritesApi$AddArrayFavorite(namespace, name, ...)
AddArrayFavoriteWithHttpInfo()
FavoritesApi$AddArrayFavoriteWithHttpInfo(namespace, name, ...)
AddMLModelFavorite()
FavoritesApi$AddMLModelFavorite(namespace, name, ...)
AddMLModelFavoriteWithHttpInfo()
FavoritesApi$AddMLModelFavoriteWithHttpInfo(namespace, name, ...)
AddNotebookFavorite()
FavoritesApi$AddNotebookFavorite(namespace, name, ...)
AddNotebookFavoriteWithHttpInfo()
FavoritesApi$AddNotebookFavoriteWithHttpInfo(namespace, name, ...)
AddUDFFavorite()
FavoritesApi$AddUDFFavorite(namespace, name, ...)
AddUDFFavoriteWithHttpInfo()
FavoritesApi$AddUDFFavoriteWithHttpInfo(namespace, name, ...)
DeleteArrayFavorite()
FavoritesApi$DeleteArrayFavorite(namespace, name, ...)
DeleteArrayFavoriteWithHttpInfo()
FavoritesApi$DeleteArrayFavoriteWithHttpInfo(namespace, name, ...)
DeleteMLModelFavorite()
FavoritesApi$DeleteMLModelFavorite(namespace, name, ...)
DeleteMLModelFavoriteWithHttpInfo()
FavoritesApi$DeleteMLModelFavoriteWithHttpInfo(namespace, name, ...)
DeleteNotebookFavorite()
FavoritesApi$DeleteNotebookFavorite(namespace, name, ...)
DeleteNotebookFavoriteWithHttpInfo()
FavoritesApi$DeleteNotebookFavoriteWithHttpInfo(namespace, name, ...)
DeleteUDFFavorite()
FavoritesApi$DeleteUDFFavorite(namespace, name, ...)
DeleteUDFFavoriteWithHttpInfo()
FavoritesApi$DeleteUDFFavoriteWithHttpInfo(namespace, name, ...)
GetArrayFavorite()
FavoritesApi$GetArrayFavorite(namespace, name, ...)
GetArrayFavoriteWithHttpInfo()
FavoritesApi$GetArrayFavoriteWithHttpInfo(namespace, name, ...)
GetMLModelFavorite()
FavoritesApi$GetMLModelFavorite(namespace, name, ...)
GetMLModelFavoriteWithHttpInfo()
FavoritesApi$GetMLModelFavoriteWithHttpInfo(namespace, name, ...)
GetNotebookFavorite()
FavoritesApi$GetNotebookFavorite(namespace, name, ...)
GetNotebookFavoriteWithHttpInfo()
FavoritesApi$GetNotebookFavoriteWithHttpInfo(namespace, name, ...)
GetUDFFavorite()
FavoritesApi$GetUDFFavorite(namespace, name, ...)
GetUDFFavoriteWithHttpInfo()
FavoritesApi$GetUDFFavoriteWithHttpInfo(namespace, name, ...)
ListArrayFavorites()
FavoritesApi$ListArrayFavorites(page = NULL, per.page = NULL, ...)
ListArrayFavoritesWithHttpInfo()
FavoritesApi$ListArrayFavoritesWithHttpInfo(page = NULL, per.page = NULL, ...)
ListArrayFavoritesUUIDs()
FavoritesApi$ListArrayFavoritesUUIDs(...)
ListArrayFavoritesUUIDsWithHttpInfo()
FavoritesApi$ListArrayFavoritesUUIDsWithHttpInfo(...)
ListMLModelFavorites()
FavoritesApi$ListMLModelFavorites(page = NULL, per.page = NULL, ...)
ListMLModelFavoritesWithHttpInfo()
FavoritesApi$ListMLModelFavoritesWithHttpInfo( page = NULL, per.page = NULL, ... )
ListMLModelFavoritesUUIDs()
FavoritesApi$ListMLModelFavoritesUUIDs(...)
ListMLModelFavoritesUUIDsWithHttpInfo()
FavoritesApi$ListMLModelFavoritesUUIDsWithHttpInfo(...)
ListNotebookFavorites()
FavoritesApi$ListNotebookFavorites( is.dashboard = NULL, page = NULL, per.page = NULL, ... )
ListNotebookFavoritesWithHttpInfo()
FavoritesApi$ListNotebookFavoritesWithHttpInfo( is.dashboard = NULL, page = NULL, per.page = NULL, ... )
ListNotebookFavoritesUUIDs()
FavoritesApi$ListNotebookFavoritesUUIDs(...)
ListNotebookFavoritesUUIDsWithHttpInfo()
FavoritesApi$ListNotebookFavoritesUUIDsWithHttpInfo(...)
ListUDFFavorites()
FavoritesApi$ListUDFFavorites(page = NULL, per.page = NULL, ...)
ListUDFFavoritesWithHttpInfo()
FavoritesApi$ListUDFFavoritesWithHttpInfo(page = NULL, per.page = NULL, ...)
ListUDFFavoritesUUIDs()
FavoritesApi$ListUDFFavoritesUUIDs(...)
ListUDFFavoritesUUIDsWithHttpInfo()
FavoritesApi$ListUDFFavoritesUUIDsWithHttpInfo(...)
clone()
The objects of this class are cloneable with this method.
FavoritesApi$clone(deep = FALSE)
deep
Whether to make a deep clone.
## Not run:
#################### 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()
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.