UdfApi: Udf operations
In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package

UdfApi

R Documentation

Udf operations

Description

tiledbcloud.Udf

Format

An R6Class generator object

Methods

DeleteUDFInfo delete a registered UDF – this will remove all sharing and can not be undone

@param namespace character
@param name character
status code : 202 | UDF delete successfully
response headers :
status code : 0 | error response
return type : Error
response headers :

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 :

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 completed request

SubmitMultiArrayUDF submit a multi-array UDF in the given namespace

@param namespace character
@param udf MultiArrayUDF
@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 completed request

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

@param namespace character
@param array character
@param udf MultiArrayUDF
@param x.payer character
@param accept.encoding character
@param v2 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 completed request

UdfNamespaceArrayEndTimestampsGet retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated

@param namespace character
@param array character
@param page integer
@param per.page integer
@returnType ArrayEndTimestampData
status code : 200 | list of timestamps in milliseconds, paginated
return type : ArrayEndTimestampData
response headers :
status code : 0 | error response
return type : Error
response headers :

UpdateUDFInfo update an existing registered 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$DeleteUDFInfo()
UdfApi$DeleteUDFInfoWithHttpInfo()
UdfApi$GetUDFInfo()
UdfApi$GetUDFInfoWithHttpInfo()
UdfApi$GetUDFInfoSharingPolicies()
UdfApi$GetUDFInfoSharingPoliciesWithHttpInfo()
UdfApi$RegisterUDFInfo()
UdfApi$RegisterUDFInfoWithHttpInfo()
UdfApi$ShareUDFInfo()
UdfApi$ShareUDFInfoWithHttpInfo()
UdfApi$SubmitGenericUDF()
UdfApi$SubmitGenericUDFWithHttpInfo()
UdfApi$SubmitMultiArrayUDF()
UdfApi$SubmitMultiArrayUDFWithHttpInfo()
UdfApi$SubmitUDF()
UdfApi$SubmitUDFWithHttpInfo()
UdfApi$UdfNamespaceArrayEndTimestampsGet()
UdfApi$UdfNamespaceArrayEndTimestampsGetWithHttpInfo()
UdfApi$UpdateUDFInfo()
UdfApi$UpdateUDFInfoWithHttpInfo()
UdfApi$clone()

Method `new()`

Usage

UdfApi$new(apiClient)

Method `DeleteUDFInfo()`

Usage

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

Method `DeleteUDFInfoWithHttpInfo()`

Usage

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

Method `GetUDFInfo()`

Usage

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

Method `GetUDFInfoWithHttpInfo()`

Usage

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

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 `SubmitMultiArrayUDF()`

Usage

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

Method `SubmitMultiArrayUDFWithHttpInfo()`

Usage

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

Method `SubmitUDF()`

Usage

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

Method `SubmitUDFWithHttpInfo()`

Usage

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

Method `UdfNamespaceArrayEndTimestampsGet()`

Usage

UdfApi$UdfNamespaceArrayEndTimestampsGet(
  namespace,
  array,
  page = NULL,
  per.page = NULL,
  ...
)

Method `UdfNamespaceArrayEndTimestampsGetWithHttpInfo()`

Usage

UdfApi$UdfNamespaceArrayEndTimestampsGetWithHttpInfo(
  namespace,
  array,
  page = NULL,
  per.page = 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: 
####################  DeleteUDFInfo  ####################

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$DeleteUDFInfo(var.namespace, var.name)


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


####################  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 policies will be rolled back to prevent partial policies, and it's 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)


####################  SubmitMultiArrayUDF  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.udf <- MultiArrayUDF$new() # MultiArrayUDF | 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$SubmitMultiArrayUDF(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 <- MultiArrayUDF$new() # MultiArrayUDF | 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
var.v2 <- 'v2_example' # character | flag to indicate if v2 array UDFs should be used, currently in beta testing. Setting any value will enable v2 array UDFs.

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, v2=var.v2)


####################  UdfNamespaceArrayEndTimestampsGet  ####################

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.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit

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$UdfNamespaceArrayEndTimestampsGet(var.namespace, var.array, page=var.page, per.page=var.per.page)


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

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

TileDB-Inc/TileDB-Cloud-R index

README.md

rdrr.io home R language documentation Run R code online

CRAN packages Bioconductor packages R-Forge packages GitHub packages

Note that we can't provide technical support on individual packages. You should contact the package authors for that.

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

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

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

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

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

UdfApi: Udf operations In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package

Udf operations

Description

Format

Methods

Public fields

Methods

Public methods

Method new()

Usage

Method DeleteUDFInfo()

Usage

Method DeleteUDFInfoWithHttpInfo()

Usage

Method GetUDFInfo()

Usage

Method GetUDFInfoWithHttpInfo()

Usage

Method GetUDFInfoSharingPolicies()

Usage

Method GetUDFInfoSharingPoliciesWithHttpInfo()

Usage

Method RegisterUDFInfo()

Usage

Method RegisterUDFInfoWithHttpInfo()

Usage

Method ShareUDFInfo()

Usage

Method ShareUDFInfoWithHttpInfo()

Usage

Method SubmitGenericUDF()

Usage

Method SubmitGenericUDFWithHttpInfo()

Usage

Method SubmitMultiArrayUDF()

Usage

Method SubmitMultiArrayUDFWithHttpInfo()

Usage

Method SubmitUDF()

Usage

Method SubmitUDFWithHttpInfo()

Usage

Method UdfNamespaceArrayEndTimestampsGet()

Usage

Method UdfNamespaceArrayEndTimestampsGetWithHttpInfo()

Usage

Method UpdateUDFInfo()

Usage

Method UpdateUDFInfoWithHttpInfo()

Usage

Method clone()

Usage

Arguments

Examples

Related to UdfApi in TileDB-Inc/TileDB-Cloud-R...

R Package Documentation

Browse R Packages

We want your feedback!

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

UdfApi: Udf operations
In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package

Method `new()`

Method `DeleteUDFInfo()`

Method `DeleteUDFInfoWithHttpInfo()`

Method `GetUDFInfo()`

Method `GetUDFInfoWithHttpInfo()`

Method `GetUDFInfoSharingPolicies()`

Method `GetUDFInfoSharingPoliciesWithHttpInfo()`

Method `RegisterUDFInfo()`

Method `RegisterUDFInfoWithHttpInfo()`

Method `ShareUDFInfo()`

Method `ShareUDFInfoWithHttpInfo()`

Method `SubmitGenericUDF()`

Method `SubmitGenericUDFWithHttpInfo()`

Method `SubmitMultiArrayUDF()`

Method `SubmitMultiArrayUDFWithHttpInfo()`

Method `SubmitUDF()`

Method `SubmitUDFWithHttpInfo()`

Method `UdfNamespaceArrayEndTimestampsGet()`

Method `UdfNamespaceArrayEndTimestampsGetWithHttpInfo()`

Method `UpdateUDFInfo()`

Method `UpdateUDFInfoWithHttpInfo()`

Method `clone()`