Skip to main content

Options for uploading files to KiFS. More…

Public Member Functions

 UploadOptions ()
 Creates a new UploadOptions with default values.
 
 UploadOptions (bool recursive, int ttl)
 Creates a new UploadOptions with the specified values.
 
 UploadOptions ()
 Creates a new UploadOptions with default values.
 
 UploadOptions (bool recursive, int ttl)
 Creates a new UploadOptions with the specified values.
 

Properties

bool Recursive = true [get, set]
 Gets or sets whether file search should be recursive along a directory hierarchy.
 
int Ttl = -1 [get, set]
 Gets or sets the time-to-live (TTL) value for uploaded files in minutes.
 
bool DeleteIfExists = false [get, set]
 Gets or sets whether to delete existing files before uploading.
 
static UploadOptions Default [get]
 Returns the default upload options.
 

Detailed Description

Options for uploading files to KiFS.

Definition at line 6 of file UploadOptions.cs.

Constructor & Destructor Documentation

◆ UploadOptions() [1/4]

kinetica.FileSystem.UploadOptions.UploadOptions ()
inline

Creates a new UploadOptions with default values.

Definition at line 31 of file UploadOptions.cs.

◆ UploadOptions() [2/4]

kinetica.FileSystem.UploadOptions.UploadOptions (boolrecursive,
intttl )
inline

Creates a new UploadOptions with the specified values.

Parameters
recursiveWhether file search should be recursive.
ttlTTL value for uploaded files in minutes.

Definition at line 40 of file UploadOptions.cs.

◆ UploadOptions() [3/4]

kinetica.FileSystem.UploadOptions.UploadOptions ()
inline

Creates a new UploadOptions with default values.

Definition at line 31 of file UploadOptions.cs.

◆ UploadOptions() [4/4]

kinetica.FileSystem.UploadOptions.UploadOptions (boolrecursive,
intttl )
inline

Creates a new UploadOptions with the specified values.

Parameters
recursiveWhether file search should be recursive.
ttlTTL value for uploaded files in minutes.

Definition at line 40 of file UploadOptions.cs.

Property Documentation

◆ Default

static UploadOptions kinetica.FileSystem.UploadOptions.Default
staticget

Returns the default upload options.

Definition at line 49 of file UploadOptions.cs.

◆ DeleteIfExists

bool kinetica.FileSystem.UploadOptions.DeleteIfExists = false
getset

Gets or sets whether to delete existing files before uploading.

Default is false.

Definition at line 26 of file UploadOptions.cs.

◆ Recursive

bool kinetica.FileSystem.UploadOptions.Recursive = true
getset

Gets or sets whether file search should be recursive along a directory hierarchy.

This is applicable when file names contain glob patterns like ‘.txt’ or ’**‍/.csv’. Default is true.

Definition at line 13 of file UploadOptions.cs.

◆ Ttl

int kinetica.FileSystem.UploadOptions.Ttl = -1
getset

Gets or sets the time-to-live (TTL) value for uploaded files in minutes.

A value of -1 means no expiration. Default is -1.

Definition at line 20 of file UploadOptions.cs.


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