uploadFiles
Uploads one or more files to KiFS. There are two methods for uploading files: load files in their entirety, or load files in parts. The latter is recommended for files of approximately 60 MB or larger.To upload files in their entirety, populate
fileNameswith the file names to upload into on KiFS, and their respective byte content infileData.Multiple steps are involved when uploading in multiple parts. Only one file at a time can be uploaded in this manner. A user-provided UUID is utilized to tie all the upload steps together for a given file. To upload a file in multiple parts:
1. Provide the file name in
fileNames, the UUID in theMULTIPART_UPLOAD_UUIDkey inoptions, and aMULTIPART_OPERATIONvalue ofINIT.2. Upload one or more parts by providing the file name, the part data in
fileData, the UUID, aMULTIPART_OPERATIONvalue ofUPLOAD_PART, and the part number in theMULTIPART_UPLOAD_PART_NUMBER. The part numbers must start at 1 and increase incrementally. Parts may not be uploaded out of order.3. Complete the upload by providing the file name, the UUID, and a
MULTIPART_OPERATIONvalue ofCOMPLETE.Multipart uploads in progress may be canceled by providing the file name, the UUID, and a
MULTIPART_OPERATIONvalue ofCANCEL. If an new upload is initialized with a different UUID for an existing upload in progress, the pre-existing upload is automatically canceled in favor of the new upload.The multipart upload must be completed for the file to be usable in KiFS. Information about multipart uploads in progress is available in
showFiles.File data may be pre-encoded using base64 encoding. This should be indicated using the
FILE_ENCODINGoption, and is recommended when using JSON serialization.Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in
showDirectories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are delineated with the directory separator of ’/’. For example, given the file path ‘/a/b/c/d.txt’, ‘a’ must be a KiFS directory.These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of ’/’, and the characters: ’.’ ’-’ ’:’ ’[’ ’]’ ’(’ ’)’ ’#’ ’=’.
Parameters:request-Requestobject containing the parameters for the operation.Returns:Responseobject containing the results of the operation.Throws:GPUdbException- if an error occurs during the operation.uploadFiles
public UploadFilesResponse uploadFiles(List<String> fileNames, List<ByteBuffer> fileData, Map<String, String> options) throws GPUdbException Uploads one or more files to KiFS. There are two methods for uploading files: load files in their entirety, or load files in parts. The latter is recommended for files of approximately 60 MB or larger.To upload files in their entirety, populate
fileNameswith the file names to upload into on KiFS, and their respective byte content infileData.Multiple steps are involved when uploading in multiple parts. Only one file at a time can be uploaded in this manner. A user-provided UUID is utilized to tie all the upload steps together for a given file. To upload a file in multiple parts:
1. Provide the file name in
fileNames, the UUID in theMULTIPART_UPLOAD_UUIDkey inoptions, and aMULTIPART_OPERATIONvalue ofINIT.2. Upload one or more parts by providing the file name, the part data in
fileData, the UUID, aMULTIPART_OPERATIONvalue ofUPLOAD_PART, and the part number in theMULTIPART_UPLOAD_PART_NUMBER. The part numbers must start at 1 and increase incrementally. Parts may not be uploaded out of order.3. Complete the upload by providing the file name, the UUID, and a
MULTIPART_OPERATIONvalue ofCOMPLETE.Multipart uploads in progress may be canceled by providing the file name, the UUID, and a
MULTIPART_OPERATIONvalue ofCANCEL. If an new upload is initialized with a different UUID for an existing upload in progress, the pre-existing upload is automatically canceled in favor of the new upload.The multipart upload must be completed for the file to be usable in KiFS. Information about multipart uploads in progress is available in
showFiles.File data may be pre-encoded using base64 encoding. This should be indicated using the
FILE_ENCODINGoption, and is recommended when using JSON serialization.Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in
showDirectories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are delineated with the directory separator of ’/’. For example, given the file path ‘/a/b/c/d.txt’, ‘a’ must be a KiFS directory.These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of ’/’, and the characters: ’.’ ’-’ ’:’ ’[’ ’]’ ’(’ ’)’ ’#’ ’=’.
Parameters:fileNames- An array of full file name paths to be used for the files uploaded to KiFS. File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters.fileData- File data for the files being uploaded, for the respective files infileNames.options- Optional parameters.FILE_ENCODING: Encoding that has been applied to the uploaded file data. When using JSON serialization it is recommended to utilizeBASE64. The caller is responsible for encoding the data provided in this payload. Supported values:BASE64: Specifies that the file data being uploaded has been base64 encoded.NONE: The uploaded file data has not been encoded.
NONE.MULTIPART_OPERATION: Multipart upload operation to perform. Supported values:NONE: Default, indicates this is not a multipart upload.INIT: Initialize a multipart file upload.UPLOAD_PART: Uploads a part of the specified multipart file upload.COMPLETE: Complete the specified multipart file upload.CANCEL: Cancel the specified multipart file upload.
NONE.MULTIPART_UPLOAD_UUID: UUID to uniquely identify a multipart upload.MULTIPART_UPLOAD_PART_NUMBER: Incremental part number for each part in a multipart upload. Part numbers start at 1, increment by 1, and must be uploaded sequentiallyDELETE_IF_EXISTS: IfTRUE, any existing files specified infileNameswill be deleted prior to start of upload. Otherwise the file is replaced once the upload completes. Rollback of the original file is no longer possible if the upload is cancelled, aborted or fails if the file was deleted beforehand. Supported values:The default value isFALSE.
Map.Returns:Responseobject containing the results of the operation.Throws:GPUdbException- if an error occurs during the operation.