Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Classes | Public Member Functions | Properties | List of all members
kinetica.UploadFilesRequest Class Reference

A set of parameters for Kinetica.uploadFiles(IList{string},IList{byte[]},IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.UploadFilesRequest:
+ Collaboration diagram for kinetica.UploadFilesRequest:

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 UploadFilesRequest ()
 Constructs an UploadFilesRequest object with default parameters. More...
 
 UploadFilesRequest (IList< string > file_names, IList< byte[]> file_data, IDictionary< string, string > options=null)
 Constructs an UploadFilesRequest object with the specified parameters. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

IList< string > file_names [get, set]
 An array of full file name paths to be used for the files uploaded to KiFS. More...
 
IList< byte[]> file_data = new List<string>() [get, set]
 File data for the files being uploaded, for the respective files in . More...
 
IDictionary< string, string > options = new List<byte[]>() [get, set]
 Optional parameters. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

Additional Inherited Members

- Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema SchemaFromType (System.Type t, KineticaType ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType. More...
 

Detailed Description

A set of parameters for Kinetica.uploadFiles(IList{string},IList{byte[]},IDictionary{string, string}).


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 recommeded for files of approximately 60 MB or larger.
To upload files in their entirety, populate file_names with the file names to upload into on KiFS, and their respective byte content in file_data.
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 file_names, the UUID in the multipart_upload_uuid key in options, and a multipart_operation value of init.
  2. Upload one or more parts by providing the file name, the part data in file_data, the UUID, a multipart_operation value of upload_part, and the part number in the multipart_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_operation value of complete.
    Multipart uploads in progress may be canceled by providing the file name, the UUID, and a multipart_operation value of cancel. 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 Kinetica.showFiles(IList{string},IDictionary{string, string}).
    File data may be pre-encoded using base64 encoding. This should be indicated using the file_encoding option, 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 Kinetica.showDirectories(string,IDictionary{string, string}). The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated 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: '.' '-' ':' '[' ']' '(' ')' '#' '='.

Definition at line 88 of file UploadFiles.cs.

Constructor & Destructor Documentation

kinetica.UploadFilesRequest.UploadFilesRequest ( )
inline

Constructs an UploadFilesRequest object with default parameters.

Definition at line 452 of file UploadFiles.cs.

kinetica.UploadFilesRequest.UploadFilesRequest ( IList< string >  file_names,
IList< byte[]>  file_data,
IDictionary< string, string >  options = null 
)
inline

Constructs an UploadFilesRequest object with the specified parameters.

Parameters
file_namesAn 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.
file_dataFile data for the files being uploaded, for the respective files in .
optionsOptional parameters.
  • FILE_ENCODING: Encoding that has been applied to the uploaded file data. When using JSON serialization it is recommended to utilize base64. 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.
    The default value is 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
    The default value is 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 sequentially
  • DELETE_IF_EXISTS: If true, any existing files specified in will 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 is FALSE.
The default value is an empty Dictionary.

Definition at line 579 of file UploadFiles.cs.

Property Documentation

IList<byte[]> kinetica.UploadFilesRequest.file_data = new List<string>()
getset

File data for the files being uploaded, for the respective files in .

Definition at line 336 of file UploadFiles.cs.

IList<string> kinetica.UploadFilesRequest.file_names
getset

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.

Definition at line 331 of file UploadFiles.cs.

IDictionary<string, string> kinetica.UploadFilesRequest.options = new List<byte[]>()
getset

Optional parameters.

  • FILE_ENCODING: Encoding that has been applied to the uploaded file data. When using JSON serialization it is recommended to utilize base64. 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.
    The default value is 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
    The default value is 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 sequentially
  • DELETE_IF_EXISTS: If true, any existing files specified in will 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 is FALSE.

The default value is an empty Dictionary.

Definition at line 447 of file UploadFiles.cs.

The documentation for this class was generated from the following file: