kinetica.UploadFilesFromurlRequest Class Reference

A set of parameters for Kinetica.uploadFilesFromurl(IList{string},IList{string},IDictionary{string, string}). More...

Inheritance diagram for kinetica.UploadFilesFromurlRequest:

Collaboration diagram for kinetica.UploadFilesFromurlRequest:

Public Member Functions
	UploadFilesFromurlRequest ()
	Constructs an UploadFilesFromurlRequest object with default parameters. More...
	UploadFilesFromurlRequest (IList< string > file_names, IList< string > urls, IDictionary< string, string > options=null)
	Constructs an UploadFilesFromurlRequest 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< string >	urls = new List<string>() [get, set]
	List of URLs to upload, for each respective file in . More...
IDictionary< string, string >	options = new List<string>() [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.uploadFilesFromurl(IList{string},IList{string},IDictionary{string, string}).

Uploads one or more files to KiFS.
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 37 of file UploadFilesFromurl.cs.

Constructor & Destructor Documentation

kinetica.UploadFilesFromurlRequest.UploadFilesFromurlRequest ( )

inline

Constructs an UploadFilesFromurlRequest object with default parameters.

Definition at line 62 of file UploadFilesFromurl.cs.

kinetica.UploadFilesFromurlRequest.UploadFilesFromurlRequest ( IList< string >  file_names, IList< string >  urls, IDictionary< string, string >  options = null  )

inline

Constructs an UploadFilesFromurlRequest object with the specified parameters.

Parameters

file_names	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.
urls	List of URLs to upload, for each respective file in .
options	Optional parameters. The default value is an empty Dictionary.

Definition at line 82 of file UploadFilesFromurl.cs.

Property Documentation

IList<string> kinetica.UploadFilesFromurlRequest.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 48 of file UploadFilesFromurl.cs.

IDictionary<string, string> kinetica.UploadFilesFromurlRequest.options = new List<string>()

getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 57 of file UploadFilesFromurl.cs.

IList<string> kinetica.UploadFilesFromurlRequest.urls = new List<string>()

getset

List of URLs to upload, for each respective file in .

Definition at line 53 of file UploadFilesFromurl.cs.

---

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

• Kinetica/Protocol/UploadFilesFromurl.cs