A set of parameters for Kinetica.downloadFiles. More…
Classes | |
| struct | Options |
| A set of string constants for the parameter DownloadFilesRequest.options. More… | |
Public Member Functions | |
| DownloadFilesRequest () | |
| Constructs a DownloadFilesRequest object with default parameters. | |
| 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. | |
| DownloadFilesRequest () | |
| Constructs a DownloadFilesRequest object with default parameters. | |
| 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. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| IList< string > | file_names = new List<string>() [get, set] |
| An array of the file names to download from KiFS. | |
| IList< long > | read_offsets = new List<long>() [get, set] |
| An array of starting byte offsets from which to read each respective file in DownloadFilesRequest.file_names. | |
| IList< long > | read_lengths = new List<long>() [get, set] |
| Array of number of bytes to read from each respective file in DownloadFilesRequest.file_names. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
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. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
Detailed Description
A set of parameters for Kinetica.downloadFiles.
Downloads one or more files from KiFS.
Definition at line 16 of file DownloadFiles.cs.
Constructor & Destructor Documentation
◆ DownloadFilesRequest() [1/4]
| inline |
Constructs a DownloadFilesRequest object with default parameters.
Definition at line 120 of file DownloadFiles.cs.
◆ DownloadFilesRequest() [2/4]
| inline |
Constructs a DownloadFilesRequest object with the specified parameters.
| file_names | An array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimiter. 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 file_names . Must either be empty or the same length as file_names . If empty, files are downloaded in their entirety. If not empty, read_lengths must also not be empty. |
| read_lengths | Array of number of bytes to read from each respective file in file_names . Must either be empty or the same length as file_names . If empty, files are downloaded in their entirety. If not empty, read_offsets must also not be empty. |
| options | Optional parameters.
|
Definition at line 174 of file DownloadFiles.cs.
◆ DownloadFilesRequest() [3/4]
| inline |
Constructs a DownloadFilesRequest object with default parameters.
Definition at line 120 of file DownloadFiles.cs.
◆ DownloadFilesRequest() [4/4]
| inline |
Constructs a DownloadFilesRequest object with the specified parameters.
| file_names | An array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimiter. 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 file_names . Must either be empty or the same length as file_names . If empty, files are downloaded in their entirety. If not empty, read_lengths must also not be empty. |
| read_lengths | Array of number of bytes to read from each respective file in file_names . Must either be empty or the same length as file_names . If empty, files are downloaded in their entirety. If not empty, read_offsets must also not be empty. |
| options | Optional parameters.
|
Definition at line 174 of file DownloadFiles.cs.
Property Documentation
◆ file_names
| getset |
An array of the file names to download from KiFS.
File paths may contain wildcard characters after the KiFS directory delimiter.
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 62 of file DownloadFiles.cs.
◆ options
| 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 an empty Dictionary.
Definition at line 116 of file DownloadFiles.cs.
◆ read_lengths
| getset |
Array of number of bytes to read from each respective file in DownloadFilesRequest.file_names.
Must either be empty or the same length as DownloadFilesRequest.file_names. If empty, files are downloaded in their entirety. If not empty, DownloadFilesRequest.read_offsets must also not be empty.
Definition at line 81 of file DownloadFiles.cs.
◆ read_offsets
| getset |
An array of starting byte offsets from which to read each respective file in DownloadFilesRequest.file_names.
Must either be empty or the same length as DownloadFilesRequest.file_names. If empty, files are downloaded in their entirety. If not empty, DownloadFilesRequest.read_lengths must also not be empty.
Definition at line 72 of file DownloadFiles.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/DownloadFiles.cs
- Kinetica/Protocol/DownloadFiles.cs