Package io.tiledb.cloud.rest_api.api

Class FilesApi

java.lang.Object

io.tiledb.cloud.rest_api.api.FilesApi

public class FilesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
FilesApi()
FilesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
FileCreated	handleCreateFile(java.lang.String namespace, FileCreate fileCreate, java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME)	Create a tiledb file at the specified location
okhttp3.Call	handleCreateFileAsync(java.lang.String namespace, FileCreate fileCreate, java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME, ApiCallback<FileCreated> _callback)	(asynchronously) Create a tiledb file at the specified location
okhttp3.Call	handleCreateFileCall(java.lang.String namespace, FileCreate fileCreate, java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME, ApiCallback _callback)	Build call for handleCreateFile
ApiResponse<FileCreated>	handleCreateFileWithHttpInfo(java.lang.String namespace, FileCreate fileCreate, java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME)	Create a tiledb file at the specified location
FileExported	handleExportFile(java.lang.String namespace, java.lang.String _file, FileExport fileExport)	Export a TileDB File back to its original file format
okhttp3.Call	handleExportFileAsync(java.lang.String namespace, java.lang.String _file, FileExport fileExport, ApiCallback<FileExported> _callback)	(asynchronously) Export a TileDB File back to its original file format
okhttp3.Call	handleExportFileCall(java.lang.String namespace, java.lang.String _file, FileExport fileExport, ApiCallback _callback)	Build call for handleExportFile
ApiResponse<FileExported>	handleExportFileWithHttpInfo(java.lang.String namespace, java.lang.String _file, FileExport fileExport)	Export a TileDB File back to its original file format
FileUploaded	handleUploadFile(java.lang.String namespace, java.io.File inputFile, java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME, java.lang.String outputUri, java.lang.String name)	Upload a tiledb file at the specified location
okhttp3.Call	handleUploadFileAsync(java.lang.String namespace, java.io.File inputFile, java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME, java.lang.String outputUri, java.lang.String name, ApiCallback<FileUploaded> _callback)	(asynchronously) Upload a tiledb file at the specified location
okhttp3.Call	handleUploadFileCall(java.lang.String namespace, java.io.File inputFile, java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME, java.lang.String outputUri, java.lang.String name, ApiCallback _callback)	Build call for handleUploadFile
ApiResponse<FileUploaded>	handleUploadFileWithHttpInfo(java.lang.String namespace, java.io.File inputFile, java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME, java.lang.String outputUri, java.lang.String name)	Upload a tiledb file at the specified location
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilesApi

public FilesApi()

FilesApi

public FilesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

handleCreateFileCall

public okhttp3.Call handleCreateFileCall(java.lang.String namespace,
                                         FileCreate fileCreate,
                                         java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for handleCreateFile

Parameters:

namespace - The namespace of the file (required)

fileCreate - Input/Output information to create a new TileDB file (required)

X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

handleCreateFile

public FileCreated handleCreateFile(java.lang.String namespace,
                                    FileCreate fileCreate,
                                    java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME)
                             throws ApiException

Create a tiledb file at the specified location

Parameters:

namespace - The namespace of the file (required)

fileCreate - Input/Output information to create a new TileDB file (required)

X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)

Returns:

FileCreated

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

handleCreateFileWithHttpInfo

public ApiResponse<FileCreated> handleCreateFileWithHttpInfo(java.lang.String namespace,
                                                             FileCreate fileCreate,
                                                             java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME)
                                                      throws ApiException

Create a tiledb file at the specified location

Parameters:

namespace - The namespace of the file (required)

fileCreate - Input/Output information to create a new TileDB file (required)

X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)

Returns:

ApiResponse<FileCreated>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

handleCreateFileAsync

public okhttp3.Call handleCreateFileAsync(java.lang.String namespace,
                                          FileCreate fileCreate,
                                          java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                          ApiCallback<FileCreated> _callback)
                                   throws ApiException

(asynchronously) Create a tiledb file at the specified location

Parameters:

namespace - The namespace of the file (required)

fileCreate - Input/Output information to create a new TileDB file (required)

X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

handleExportFileCall

public okhttp3.Call handleExportFileCall(java.lang.String namespace,
                                         java.lang.String _file,
                                         FileExport fileExport,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for handleExportFile

Parameters:

namespace - The namespace of the file (required)

_file - The file identifier (required)

fileExport - Export configuration information (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

handleExportFile

public FileExported handleExportFile(java.lang.String namespace,
                                     java.lang.String _file,
                                     FileExport fileExport)
                              throws ApiException

Export a TileDB File back to its original file format

Parameters:

namespace - The namespace of the file (required)

_file - The file identifier (required)

fileExport - Export configuration information (required)

Returns:

FileExported

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

handleExportFileWithHttpInfo

public ApiResponse<FileExported> handleExportFileWithHttpInfo(java.lang.String namespace,
                                                              java.lang.String _file,
                                                              FileExport fileExport)
                                                       throws ApiException

Export a TileDB File back to its original file format

Parameters:

namespace - The namespace of the file (required)

_file - The file identifier (required)

fileExport - Export configuration information (required)

Returns:

ApiResponse<FileExported>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

handleExportFileAsync

public okhttp3.Call handleExportFileAsync(java.lang.String namespace,
                                          java.lang.String _file,
                                          FileExport fileExport,
                                          ApiCallback<FileExported> _callback)
                                   throws ApiException

(asynchronously) Export a TileDB File back to its original file format

Parameters:

namespace - The namespace of the file (required)

_file - The file identifier (required)

fileExport - Export configuration information (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

handleUploadFileCall

public okhttp3.Call handleUploadFileCall(java.lang.String namespace,
                                         java.io.File inputFile,
                                         java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                         java.lang.String outputUri,
                                         java.lang.String name,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for handleUploadFile

Parameters:

namespace - The namespace of the file (required)

inputFile - the file to upload (required)

X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)

outputUri - output location of the TileDB File (optional)

name - name to set for registered file (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

handleUploadFile

public FileUploaded handleUploadFile(java.lang.String namespace,
                                     java.io.File inputFile,
                                     java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                     java.lang.String outputUri,
                                     java.lang.String name)
                              throws ApiException

Upload a tiledb file at the specified location

Parameters:

namespace - The namespace of the file (required)

inputFile - the file to upload (required)

X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)

outputUri - output location of the TileDB File (optional)

name - name to set for registered file (optional)

Returns:

FileUploaded

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

handleUploadFileWithHttpInfo

public ApiResponse<FileUploaded> handleUploadFileWithHttpInfo(java.lang.String namespace,
                                                              java.io.File inputFile,
                                                              java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                                              java.lang.String outputUri,
                                                              java.lang.String name)
                                                       throws ApiException

Upload a tiledb file at the specified location

Parameters:

namespace - The namespace of the file (required)

inputFile - the file to upload (required)

X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)

outputUri - output location of the TileDB File (optional)

name - name to set for registered file (optional)

Returns:

ApiResponse<FileUploaded>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

handleUploadFileAsync

public okhttp3.Call handleUploadFileAsync(java.lang.String namespace,
                                          java.io.File inputFile,
                                          java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                          java.lang.String outputUri,
                                          java.lang.String name,
                                          ApiCallback<FileUploaded> _callback)
                                   throws ApiException

(asynchronously) Upload a tiledb file at the specified location

Parameters:

namespace - The namespace of the file (required)

inputFile - the file to upload (required)

X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)

outputUri - output location of the TileDB File (optional)

name - name to set for registered file (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object