Kinetica   C#   API  Version 7.2.3.1
FileOperationResult Class Reference

Contains the result of a file upload or download operation. More...

Public Member Functions

override string ToString ()
 Returns a string representation of this result. More...
 

Properties

string FileName = string.Empty [get, set]
 Gets or sets the name of the file being uploaded/downloaded. More...
 
IList< string > FileNames = new List<string>() [get, set]
 Gets or sets the list of all file names for full file operations. More...
 
bool IsSuccessful [get, set]
 Gets or sets whether the operation was successful. More...
 
Exception? Exception [get, set]
 Gets or sets the exception that occurred, if any. More...
 
string? ErrorMessage [get, set]
 Gets or sets the error message, if any. More...
 
OperationMode OpMode [get, set]
 Gets or sets the operation mode (upload or download). More...
 
bool IsMultiPart [get, set]
 Gets or sets whether this is a multi-part operation. More...
 
MultiPartUploadInfoUploadInfo [get, set]
 Gets or sets information about a multi-part upload operation. More...
 
MultiPartDownloadInfoDownloadInfo [get, set]
 Gets or sets information about a multi-part download operation. More...
 

Detailed Description

Contains the result of a file upload or download operation.

This is used for callback notifications during file transfers.

Definition at line 21 of file FileOperationResult.cs.

Member Function Documentation

◆ ToString()

override string FileOperationResult.ToString ( )
inline

Returns a string representation of this result.

Definition at line 71 of file FileOperationResult.cs.

Property Documentation

◆ DownloadInfo

MultiPartDownloadInfo? FileOperationResult.DownloadInfo
getset

Gets or sets information about a multi-part download operation.

Definition at line 66 of file FileOperationResult.cs.

◆ ErrorMessage

string? FileOperationResult.ErrorMessage
getset

Gets or sets the error message, if any.

Definition at line 46 of file FileOperationResult.cs.

◆ Exception

Exception? FileOperationResult.Exception
getset

Gets or sets the exception that occurred, if any.

Definition at line 41 of file FileOperationResult.cs.

◆ FileName

string FileOperationResult.FileName = string.Empty
getset

Gets or sets the name of the file being uploaded/downloaded.

Definition at line 26 of file FileOperationResult.cs.

◆ FileNames

IList<string> FileOperationResult.FileNames = new List<string>()
getset

Gets or sets the list of all file names for full file operations.

Definition at line 31 of file FileOperationResult.cs.

◆ IsMultiPart

bool FileOperationResult.IsMultiPart
getset

Gets or sets whether this is a multi-part operation.

Definition at line 56 of file FileOperationResult.cs.

◆ IsSuccessful

bool FileOperationResult.IsSuccessful
getset

Gets or sets whether the operation was successful.

Definition at line 36 of file FileOperationResult.cs.

◆ OpMode

OperationMode FileOperationResult.OpMode
getset

Gets or sets the operation mode (upload or download).

Definition at line 51 of file FileOperationResult.cs.

◆ UploadInfo

MultiPartUploadInfo? FileOperationResult.UploadInfo
getset

Gets or sets information about a multi-part upload operation.

Definition at line 61 of file FileOperationResult.cs.


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