UdfApi: Udf operations

In eddelbuettel/tldbclr: TileDB Cloud Platform R Client Package

Udf operations

Description

tiledbcloud.Udf

Format

An R6Class generator object

Methods

GetUDFInfo get a specific UDF in the given namespace

• @param namespace character

• @param name character

• @returnType UDFInfo
  

• status code : 200 | UDFInfo was retrieved successfully

• return type : UDFInfo

• response headers :

• status code : 404 | udf not found

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

GetUDFInfoList get a all UDFs accessible to the user

• @param namespace character

• @param created.by character

• @param page integer

• @param per.page integer

• @param type character

• @param search character

• @param orderby character

• @param tag list( character )

• @returnType UDFListingData
  

• status code : 200 | UDFInfo list

• return type : UDFListingData

• response headers :

• status code : 404 | udf not found

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

GetUDFInfoSharingPolicies Get all sharing details of the udf

• @param namespace character

• @param name character

• @returnType list( UDFSharing )
  

• status code : 200 | List of all specific sharing policies

• return type : array[UDFSharing]

• response headers :

• status code : 404 | UDF does not exist or user does not have permissions to view array sharing policies

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

RegisterUDFInfo register a UDF in the given namespace

• @param namespace character

• @param name character

• @param udf UDFInfoUpdate

• status code : 204 | udf registered successfully

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

ShareUDFInfo Share a UDF with a user

• @param namespace character

• @param name character

• @param udf.sharing UDFSharing

• status code : 204 | UDF shared successfully

• response headers :

• status code : 404 | UDF does not exist or user does not have permissions to share udf

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

SubmitGenericUDF submit a generic UDF in the given namespace

• @param namespace character

• @param udf GenericUDF

• @param accept.encoding character

• status code : 200 | udf completed and the udf-type specific result is returned

• return type : data.frame

• response headers :

  X-TILEDB-CLOUD-TASK-ID	Task ID for just completed request

• status code : 0 | error response

• return type : Error

• response headers :

  X-TILEDB-CLOUD-TASK-ID	Task ID for just request if task was started

SubmitUDF send a UDF to run against a specified array/URI registered to a group/project

• @param namespace character

• @param array character

• @param udf UDF

• @param x.payer character

• @param accept.encoding character

• status code : 200 | udf completed and the udf-type specific result is returned

• return type : data.frame

• response headers :

  X-TILEDB-CLOUD-TASK-ID	Task ID for just completed request

• status code : 0 | error response

• return type : Error

• response headers :

  X-TILEDB-CLOUD-TASK-ID	Task ID for just request if task was started

UpdateUDFInfo updated an existing registerd UDF in the given namespace

• @param namespace character

• @param name character

• @param udf UDFInfoUpdate

• status code : 204 | udf 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

• UdfApi$new()

• UdfApi$GetUDFInfo()

• UdfApi$GetUDFInfoWithHttpInfo()

• UdfApi$GetUDFInfoList()

• UdfApi$GetUDFInfoListWithHttpInfo()

• UdfApi$GetUDFInfoSharingPolicies()

• UdfApi$GetUDFInfoSharingPoliciesWithHttpInfo()

• UdfApi$RegisterUDFInfo()

• UdfApi$RegisterUDFInfoWithHttpInfo()

• UdfApi$ShareUDFInfo()

• UdfApi$ShareUDFInfoWithHttpInfo()

• UdfApi$SubmitGenericUDF()

• UdfApi$SubmitGenericUDFWithHttpInfo()

• UdfApi$SubmitUDF()

• UdfApi$SubmitUDFWithHttpInfo()

• UdfApi$UpdateUDFInfo()

• UdfApi$UpdateUDFInfoWithHttpInfo()

• UdfApi$clone()

---

Method new()

Usage

UdfApi$new(apiClient)

---

Method GetUDFInfo()

Usage

UdfApi$GetUDFInfo(namespace, name, ...)

---

Method GetUDFInfoWithHttpInfo()

Usage

UdfApi$GetUDFInfoWithHttpInfo(namespace, name, ...)

---

Method GetUDFInfoList()

Usage

UdfApi$GetUDFInfoList(
  namespace = NULL,
  created.by = NULL,
  page = NULL,
  per.page = NULL,
  type = NULL,
  search = NULL,
  orderby = NULL,
  tag = NULL,
  ...
)

---

Method GetUDFInfoListWithHttpInfo()

Usage

UdfApi$GetUDFInfoListWithHttpInfo(
  namespace = NULL,
  created.by = NULL,
  page = NULL,
  per.page = NULL,
  type = NULL,
  search = NULL,
  orderby = NULL,
  tag = NULL,
  ...
)

---

Method GetUDFInfoSharingPolicies()

Usage

UdfApi$GetUDFInfoSharingPolicies(namespace, name, ...)

---

Method GetUDFInfoSharingPoliciesWithHttpInfo()

Usage

UdfApi$GetUDFInfoSharingPoliciesWithHttpInfo(namespace, name, ...)

---

Method RegisterUDFInfo()

Usage

UdfApi$RegisterUDFInfo(namespace, name, udf, ...)

---

Method RegisterUDFInfoWithHttpInfo()

Usage

UdfApi$RegisterUDFInfoWithHttpInfo(namespace, name, udf, ...)

---

Method ShareUDFInfo()

Usage

UdfApi$ShareUDFInfo(namespace, name, udf.sharing, ...)

---

Method ShareUDFInfoWithHttpInfo()

Usage

UdfApi$ShareUDFInfoWithHttpInfo(namespace, name, udf.sharing, ...)

---

Method SubmitGenericUDF()

Usage

UdfApi$SubmitGenericUDF(namespace, udf, accept.encoding = NULL, ...)

---

Method SubmitGenericUDFWithHttpInfo()

Usage

UdfApi$SubmitGenericUDFWithHttpInfo(
  namespace,
  udf,
  accept.encoding = NULL,
  ...
)

---

Method SubmitUDF()

Usage

UdfApi$SubmitUDF(
  namespace,
  array,
  udf,
  x.payer = NULL,
  accept.encoding = NULL,
  ...
)

---

Method SubmitUDFWithHttpInfo()

Usage

UdfApi$SubmitUDFWithHttpInfo(
  namespace,
  array,
  udf,
  x.payer = NULL,
  accept.encoding = NULL,
  ...
)

---

Method UpdateUDFInfo()

Usage

UdfApi$UpdateUDFInfo(namespace, name, udf, ...)

---

Method UpdateUDFInfoWithHttpInfo()

Usage

UdfApi$UpdateUDFInfoWithHttpInfo(namespace, name, udf, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

UdfApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  GetUDFInfo  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.name <- 'name_example' # character | name to register udf under

api.instance <- UdfApi$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$GetUDFInfo(var.namespace, var.name)


####################  GetUDFInfoList  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace to filter
var.created.by <- 'created.by_example' # character | username to filter
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.type <- 'type_example' # character | udf type, \"generic\", \"single_array\"
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.orderby <- 'orderby_example' # character | sort by which field valid values include created_at, last_used, name
var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included

api.instance <- UdfApi$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$GetUDFInfoList(namespace=var.namespace, created.by=var.created.by, page=var.page, per.page=var.per.page, type=var.type, search=var.search, orderby=var.orderby, tag=var.tag)


####################  GetUDFInfoSharingPolicies  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.name <- 'name_example' # character | name of UDFInfo

api.instance <- UdfApi$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$GetUDFInfoSharingPolicies(var.namespace, var.name)


####################  RegisterUDFInfo  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.name <- 'name_example' # character | name to register udf under
var.udf <- UDFInfoUpdate$new() # UDFInfoUpdate | udf to register

api.instance <- UdfApi$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$RegisterUDFInfo(var.namespace, var.name, var.udf)


####################  ShareUDFInfo  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.name <- 'name_example' # character | name of UDFInfo
var.udf.sharing <- UDFSharing$new() # UDFSharing | Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the udf will not be shared with the namespace at all

api.instance <- UdfApi$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$ShareUDFInfo(var.namespace, var.name, var.udf.sharing)


####################  SubmitGenericUDF  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.udf <- GenericUDF$new() # GenericUDF | udf to run
var.accept.encoding <- 'accept.encoding_example' # character | Encoding to use

api.instance <- UdfApi$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$SubmitGenericUDF(var.namespace, var.udf, accept.encoding=var.accept.encoding)


####################  SubmitUDF  ####################

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.udf <- UDF$new() # UDF | udf to run
var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request
var.accept.encoding <- 'accept.encoding_example' # character | Encoding to use

api.instance <- UdfApi$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$SubmitUDF(var.namespace, var.array, var.udf, x.payer=var.x.payer, accept.encoding=var.accept.encoding)


####################  UpdateUDFInfo  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.name <- 'name_example' # character | name to register udf under
var.udf <- UDFInfoUpdate$new() # UDFInfoUpdate | udf to update

api.instance <- UdfApi$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$UpdateUDFInfo(var.namespace, var.name, var.udf)



## End(Not run)

eddelbuettel/tldbclr documentation built on Sept. 25, 2022, 12:46 p.m.