Class UploadDirectoryProgressArgs

Namespace

Amazon.S3.Transfer

Assembly

AWSSDK.S3.dll

Encapsulates the information needed to provide transfer progress to subscribers of the UploadDirectory event.

public class UploadDirectoryProgressArgs : EventArgs

Inheritance

object

EventArgs

UploadDirectoryProgressArgs

Inherited Members

EventArgs.Empty

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

UploadDirectoryProgressArgs(int, int, long, long, string, long, long)

Constructs a new instance of UploadDirectoryProgressArgs.

public UploadDirectoryProgressArgs(int numberOfFilesUploaded, int totalNumberOfFiles, long transferredBytes, long totalBytes, string currentFile, long transferredBytesForCurrentFile, long totalNumberOfBytesForCurrentFile)

Parameters

numberOfFilesUploaded int

The number of files uploaded.

totalNumberOfFiles int

The total number of files to upload.

transferredBytes long

The bytes transferred across all files being uploaded.

totalBytes long

The total number of bytes across all files being uploaded.

currentFile string

The current file being uploaded.

transferredBytesForCurrentFile long

The number of transferred bytes for current file.

totalNumberOfBytesForCurrentFile long

The size of the current file in bytes.

UploadDirectoryProgressArgs(int, int, string, long, long)

Constructs a new instance of UploadDirectoryProgressArgs.

public UploadDirectoryProgressArgs(int numberOfFilesUploaded, int totalNumberOfFiles, string currentFile, long transferredBytesForCurrentFile, long totalNumberOfBytesForCurrentFile)

Parameters

numberOfFilesUploaded int

The number of files uploaded.

totalNumberOfFiles int

The total number of files to upload.

currentFile string

The current file

transferredBytesForCurrentFile long

The number of transferred bytes for current file.

totalNumberOfBytesForCurrentFile long

The size of the current file in bytes.

Properties

CurrentFile

Gets or sets the current file.

public string CurrentFile { get; set; }

Property Value

string

The current file.

Remarks

This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property will return null.

NumberOfFilesUploaded

Gets or sets the number of files uploaded.

public int NumberOfFilesUploaded { get; set; }

Property Value

int

The number of files uploaded.

TotalBytes

Gets or sets the total number of bytes across all files being uploaded.

public long TotalBytes { get; set; }

Property Value

long

The total number of bytes across all files being uploaded.

TotalNumberOfBytesForCurrentFile

Gets or sets the total number of bytes for current file.

public long TotalNumberOfBytesForCurrentFile { get; set; }

Property Value

long

The total number of bytes for current file.

Remarks

This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property will return 0.

TotalNumberOfFiles

Gets or sets the total number of files.

public int TotalNumberOfFiles { get; set; }

Property Value

int

The total number of files.

TransferredBytes

Gets or sets the bytes transferred across all files being uploaded.

public long TransferredBytes { get; set; }

Property Value

long

The bytes transferred across all files being uploaded.

TransferredBytesForCurrentFile

Gets or sets the transferred bytes for current file.

public long TransferredBytesForCurrentFile { get; set; }

Property Value

long

The transferred bytes for current file.

Remarks

This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property will return 0.

Methods

ToString()

The string representation of this instance of UploadDirectoryProgressArgs.

public override string ToString()

Returns

string

The string representation of this instance of UploadDirectoryProgressArgs.