FilesApi: Files operations

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

Files operations

Description

tiledbcloud.Files

Format

An R6Class generator object

Methods

HandleCreateFile Create a tiledb file at the specified location

• @param namespace character

• @param file.create FileCreate

• @param X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME character

• @returnType FileCreated
  

• status code : 201 | File created

• return type : FileCreated

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

HandleExportFile Export a TileDB File back to its original file format

• @param namespace character

• @param file character

• @param file.export FileExport

• @returnType FileExported
  

• status code : 201 | File exported

• return type : FileExported

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• FilesApi$new()

• FilesApi$HandleCreateFile()

• FilesApi$HandleCreateFileWithHttpInfo()

• FilesApi$HandleExportFile()

• FilesApi$HandleExportFileWithHttpInfo()

• FilesApi$clone()

---

Method new()

Usage

FilesApi$new(apiClient)

---

Method HandleCreateFile()

Usage

FilesApi$HandleCreateFile(
  namespace,
  file.create,
  X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = NULL,
  ...
)

---

Method HandleCreateFileWithHttpInfo()

Usage

FilesApi$HandleCreateFileWithHttpInfo(
  namespace,
  file.create,
  X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = NULL,
  ...
)

---

Method HandleExportFile()

Usage

FilesApi$HandleExportFile(namespace, file, file.export, ...)

---

Method HandleExportFileWithHttpInfo()

Usage

FilesApi$HandleExportFileWithHttpInfo(namespace, file, file.export, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

FilesApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  HandleCreateFile  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the file
var.file.create <- FileCreate$new() # FileCreate | Input/Output information to create a new TileDB file
var.X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME <- 'X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME_example' # character | Optional registered access credentials to use for creation

api.instance <- FilesApi$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$HandleCreateFile(var.namespace, var.file.create, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME=var.X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME)


####################  HandleExportFile  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the file
var.file <- 'file_example' # character | The file identifier
var.file.export <- FileExport$new() # FileExport | Export configuration information

api.instance <- FilesApi$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$HandleExportFile(var.namespace, var.file, var.file.export)



## End(Not run)

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