AWS SDK for .NET Documentation
TransferUtilityDownloadRequest Class
AmazonAmazon.S3.TransferTransferUtilityDownloadRequest Did this page help you?   Yes   No    Tell us about it...
Contains all the parameters that can be set when making a this request with the TransferUtility method.
Declaration Syntax
C#
public class TransferUtilityDownloadRequest : BaseDownloadRequest
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
TransferUtilityDownloadRequest()()()()
Initializes a new instance of the TransferUtilityDownloadRequest class

BucketName
Gets or sets the name of the bucket.
(Inherited from BaseDownloadRequest.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
FilePath
Get or sets the file path location of where the downloaded Amazon S3 object will be written to.

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Key
Gets or sets the key under which the Amazon S3 object is stored.
(Inherited from BaseDownloadRequest.)
ModifiedSinceDate
Gets or sets the ModifiedSinceDate property.
(Inherited from BaseDownloadRequest.)
Timeout
Gets or sets the timeout property in milliseconds. The value of this property is assigned to the ReadWriteTimeout and Timeout properties of the HTTPWebRequest object used for Amazon S3 GET Object requests.
(Inherited from BaseDownloadRequest.)
ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
UnmodifiedSinceDate
Gets or sets the UnmodifiedSinceDate property.
(Inherited from BaseDownloadRequest.)
VersionId
Gets or sets the version ID of the Amazon S3 object.
(Inherited from BaseDownloadRequest.)
WithBucketName(String) Obsolete.
Sets the bucket name containing the Amazon S3 object to download and returns this object instance, enabling additional method calls to be chained together.

WithFilePath(String) Obsolete.
Sets the file path location of where the downloaded Amazon S3 object will be written to and returns this object instance, enabling additional method calls to be chained together.

WithKey(String) Obsolete.
Sets the key under which the Amazon S3 object is stored and returns this object instance, enabling additional method calls to be chained together.

WithModifiedSinceDate(DateTime) Obsolete.

Sets the ModifiedSinceDate property for this request and returns this object instance, enabling additional method calls to be chained together.

When this property is set, the Amazon S3 object is returned only if it has been modified since the specified time. Otherwise, this requests returns a 304 error code.


WithSubscriber(EventHandler<(Of <<'(WriteObjectProgressArgs>)>>)) Obsolete.
The handler will be attached to the WriteObjectProgressEvent which is fired as data is downloaded from S3. The handler will be passed information detailing how much data has been downloaded as well as how much will be downloaded.

WithTimeout(Int32) Obsolete.
Sets the timeout property in milliseconds. The value of this property is assigned to the ReadWriteTimeout and Timeout properties of the HTTPWebRequest object used for Amazon S3 GET Object requests. Specify a timeout value only if certain that the file will not be retrieved within the default intervals specified for the HttpWebRequest.

WithUnmodifiedSinceDate(DateTime) Obsolete.

Sets the UnmodifiedSinceDate property for this request and returns this object instance, enabling additional method calls to be chained together.

When this property is set, the Amazon S3 object is returned only if it has not been modified since the specified time. Otherwise, this requests returns a 412 error code.


WithVersionId(String) Obsolete.
Sets the version ID of the Amazon S3 object to download and returns this object instance, enabling additional method calls to be chained together.

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

The WriteObjectProgressEvent is fired as data is downloaded from 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.


Inheritance Hierarchy
Object
BaseDownloadRequest
 TransferUtilityDownloadRequest

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)