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

Inheritance diagram for kinetica.DownloadFilesRequest:

Collaboration diagram for kinetica.DownloadFilesRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	DownloadFilesRequest ()
	Constructs a DownloadFilesRequest object with default parameters. More...

	DownloadFilesRequest (IList< string > file_names, IList< long > read_offsets, IList< long > read_lengths, IDictionary< string, string > options=null)
	Constructs a DownloadFilesRequest 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 the file names to download from KiFS. More...

IList< long >	read_offsets = new List<string>() `[get, set]`
	An array of starting byte offsets from which to read each respective file in . More...

IList< long >	read_lengths = new List<long>() `[get, set]`
	Array of number of bytes to read from each respective file in . More...

IDictionary< string, string >	options = new List<long>() `[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.downloadFiles(IList{string},IList{long},IList{long},IDictionary{string, string}).

Downloads one or more files from KiFS.

Definition at line 20 of file DownloadFiles.cs.

Constructor & Destructor Documentation

kinetica.DownloadFilesRequest.DownloadFilesRequest ( )

inline

Constructs a DownloadFilesRequest object with default parameters.

Definition at line 148 of file DownloadFiles.cs.

kinetica.DownloadFilesRequest.DownloadFilesRequest	(	IList< string >	file_names,
		IList< long >	read_offsets,
		IList< long >	read_lengths,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a DownloadFilesRequest object with the specified parameters.

Parameters

file_names	An array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.
read_offsets	An array of starting byte offsets from which to read each respective file in . Must either be empty or the same length as . If empty, files are downloaded in their entirety. If not empty, must also not be empty.
read_lengths	Array of number of bytes to read from each respective file in . Must either be empty or the same length as . If empty, files are downloaded in their entirety. If not empty, must also not be empty.
options	Optional parameters. FILE_ENCODING: Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. Supported values: BASE64: Apply base64 encoding to the output file data. NONE: Do not apply any encoding to the output file data. The default value is NONE. The default value is an empty Dictionary.

Definition at line 204 of file DownloadFiles.cs.

Property Documentation

IList<string> kinetica.DownloadFilesRequest.file_names

getset

An array of the file names to download from KiFS.

File paths may contain wildcard characters after the KiFS directory delimeter.
Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.

Definition at line 95 of file DownloadFiles.cs.

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

getset

Optional parameters.

FILE_ENCODING: Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. Supported values:
- BASE64: Apply base64 encoding to the output file data.
- NONE: Do not apply any encoding to the output file data.
The default value is NONE.

The default value is an empty Dictionary.

Definition at line 143 of file DownloadFiles.cs.

IList<long> kinetica.DownloadFilesRequest.read_lengths = new List<long>()

getset

Array of number of bytes to read from each respective file in .

Must either be empty or the same length as . If empty, files are downloaded in their entirety. If not empty, must also not be empty.

Definition at line 113 of file DownloadFiles.cs.

IList<long> kinetica.DownloadFilesRequest.read_offsets = new List<string>()

getset

An array of starting byte offsets from which to read each respective file in .

Must either be empty or the same length as . If empty, files are downloaded in their entirety. If not empty, must also not be empty.

Definition at line 104 of file DownloadFiles.cs.

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

Kinetica/Protocol/DownloadFiles.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation