DownloadOptions Class Reference

Options for downloading files from KiFS. More...

Collaboration diagram for DownloadOptions:

Public Member Functions
	DownloadOptions ()
	Creates a new DownloadOptions with default values. More...
	DownloadOptions (bool overwriteExisting)
	Creates a new DownloadOptions with the specified values. More...

Static Public Attributes
static DownloadOptions	Default => new DownloadOptions(true)
	Returns the default download options. More...

Properties
bool	OverwriteExisting = true [get, set]
	Gets or sets whether to overwrite existing files on the local file system. More...

Detailed Description

Options for downloading files from KiFS.

Definition at line 6 of file DownloadOptions.cs.

Constructor & Destructor Documentation

DownloadOptions() [1/2]

DownloadOptions.DownloadOptions ( )

inline

Creates a new DownloadOptions with default values.

Definition at line 17 of file DownloadOptions.cs.

DownloadOptions() [2/2]

DownloadOptions.DownloadOptions ( bool  overwriteExisting )

inline

Creates a new DownloadOptions with the specified values.

Parameters

overwriteExisting

Whether to overwrite existing files.

Definition at line 25 of file DownloadOptions.cs.

Member Data Documentation

Default

DownloadOptions DownloadOptions.Default => new DownloadOptions(true)

static

Returns the default download options.

Definition at line 33 of file DownloadOptions.cs.

Property Documentation

OverwriteExisting

bool DownloadOptions.OverwriteExisting = true

getset

Gets or sets whether to overwrite existing files on the local file system.

Default is true.

Definition at line 12 of file DownloadOptions.cs.

---

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

• Kinetica/FileSystem/DownloadOptions.cs