Class TransferUtilityDownloadDirectoryRequest

Namespace

Amazon.S3.Transfer

Assembly

AWSSDK.S3.dll

Request object for downloading a directory with the TransferUtility.

public class TransferUtilityDownloadDirectoryRequest

Inheritance

object

TransferUtilityDownloadDirectoryRequest

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TransferUtilityDownloadDirectoryRequest()

public TransferUtilityDownloadDirectoryRequest()

Properties

BucketName

Gets or sets the name of the bucket.

public string BucketName { get; set; }

Property Value

string

The name of the bucket.

DisableSlashCorrection

If this is set to true then the TransferUtility will not ensure the S3Directory property has a trailing / for a virtual S3 directory. The default value is false.

public bool DisableSlashCorrection { get; set; }

Property Value

bool

DownloadFilesConcurrently

Gets or sets the DownloadFilesConcurrently property. Specifies if multiple files will be downloaded concurrently. The number of concurrent web requests used is controlled by the TransferUtilityConfig.ConcurrencyLevel property.

public bool DownloadFilesConcurrently { get; set; }

Property Value

bool

LocalDirectory

Gets or sets the local directory where objects from Amazon S3 will be downloaded.
If the directory doesn't exist, it will be created.

public string LocalDirectory { get; set; }

Property Value

string

The local directory where objects from Amazon S3 will be downloaded.

ModifiedSinceDate

This property is deprecated. This property doesn't honor the DateTimeKind, please use ModifiedSinceDateUtc instead.

Gets or sets the ModifiedSinceDate property. Only objects that have been modified since this date will be downloaded.

[Obsolete("This property doesn't honor the DateTimeKind, please use ModifiedSinceDateUtc instead.", false)]
public DateTime ModifiedSinceDate { get; set; }

Property Value

DateTime

The ModifiedSinceDate property.

ModifiedSinceDateUtc

Gets or sets the ModifiedSinceDateUtc property.
Only objects that have been modified since this date will be downloaded.

public DateTime ModifiedSinceDateUtc { get; set; }

Property Value

DateTime

The ModifiedSinceDateUtc property.

S3Directory

Gets or sets the Amazon S3 directory to download from.
This is translated to a key prefix; keys that have this prefix will be downloaded.

The TransferUtility will automatically add a / to the end when listing objects for to be downloaded. This treats S3Directory field as a virtual S3 directory. In some use cases the added / slash can be undesirable. To prevent the TransferUtility from adding the / at the end set the DisableSlashCorrection property to true.

public string S3Directory { get; set; }

Property Value

string

UnmodifiedSinceDate

This property is deprecated. This property doesn't honor the DateTimeKind, please use UnmodifiedSinceDateUtc instead.

Gets or sets the UnmodifiedSinceDate property. Only objects that have not been modified since this date will be downloaded.

[Obsolete("This property doesn't honor the DateTimeKind, please use UnmodifiedSinceDateUtc instead.", false)]
public DateTime UnmodifiedSinceDate { get; set; }

Property Value

DateTime

The UnmodifiedSinceDate property.

UnmodifiedSinceDateUtc

Gets or sets the UnmodifiedSinceDateUtc property.
Only objects that have not been modified since this date will be downloaded.

public DateTime UnmodifiedSinceDateUtc { get; set; }

Property Value

DateTime

The UnmodifiedSinceDateUtc property.

Events

DownloadedDirectoryProgressEvent

The event for DownloadedDirectoryProgressEvent notifications. All subscribers will be notified when a new progress event is raised.

The DownloadedDirectoryProgressEvent is fired as data is downloaded from Amazon S3. The delegates attached to the event will be passed information detailing how much data has been downloaded as well as how much will be downloaded.

public event EventHandler<DownloadDirectoryProgressArgs> DownloadedDirectoryProgressEvent

Event Type

EventHandler<DownloadDirectoryProgressArgs>

Remarks

Subscribe to this event if you want to receive DownloadedDirectoryProgressEvent notifications. Here is how:

1. Define a method with a signature similar to this one:

private void displayProgress(object sender, DownloadDirectoryProgressArgs args)
{
    Console.WriteLine(args);
}

2. Add this method to the DownloadedDirectoryProgressEvent delegate's invocation list

TransferUtilityDownloadDirectoryRequest request = new TransferUtilityDownloadDirectoryRequest();
request.DownloadedDirectoryProgressEvent += displayProgress;