UploadOptions Class Reference

Options for uploading files to KiFS. More...

Collaboration diagram for UploadOptions:

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

Static Public Attributes
static UploadOptions	Default => new UploadOptions(true, -1)
	Returns the default upload options. More...

Properties
*.csv.*Default is true.*</summary > *bool	Recursive = true [get, set]
	Gets or sets whether file search should be recursive along a directory hierarchy. More...
int	Ttl = -1 [get, set]
	Gets or sets the time-to-live (TTL) value for uploaded files in minutes. More...
bool	DeleteIfExists = false [get, set]
	Gets or sets whether to delete existing files before uploading. More...

Detailed Description

Options for uploading files to KiFS.

Definition at line 6 of file UploadOptions.cs.

Constructor & Destructor Documentation

UploadOptions() [1/2]

UploadOptions.UploadOptions ( )

inline

Creates a new UploadOptions with default values.

Definition at line 31 of file UploadOptions.cs.

UploadOptions() [2/2]

UploadOptions.UploadOptions ( bool  recursive, int  ttl  )

inline

Creates a new UploadOptions with the specified values.

Parameters

recursive	Whether file search should be recursive.
ttl	TTL value for uploaded files in minutes.

Definition at line 40 of file UploadOptions.cs.

Member Data Documentation

Default

UploadOptions UploadOptions.Default => new UploadOptions(true, -1)

static

Returns the default upload options.

Definition at line 49 of file UploadOptions.cs.

Property Documentation

DeleteIfExists

bool 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

* .csv.* Default is true.*</summary> * bool 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 '

Definition at line 13 of file UploadOptions.cs.

Ttl

int 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 file:

• Kinetica/FileSystem/UploadOptions.cs