Class BaseDownloadRequest

Namespace

Amazon.S3.Transfer

Assembly

AWSSDK.S3.dll

The base class for requests that return Amazon S3 objects.

public abstract class BaseDownloadRequest

Inheritance

object

BaseDownloadRequest

Derived

TransferUtilityDownloadRequest

TransferUtilityOpenStreamRequest

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

BaseDownloadRequest()

protected BaseDownloadRequest()

Properties

BucketName

Gets or sets the name of the bucket.

public string BucketName { get; set; }

Property Value

string

The name of the bucket.

Key

Gets or sets the key under which the Amazon S3 object is stored.

public string Key { get; set; }

Property Value

string

The key under which the Amazon S3 object is stored.

ModifiedSinceDate

This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.

Gets or sets the ModifiedSinceDate property.

[Obsolete("Setting this property results in non-UTC DateTimes not being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.", false)]
public DateTime ModifiedSinceDate { get; set; }

Property Value

DateTime

The ModifiedSinceDate property.

ModifiedSinceDateUtc

Gets or sets the ModifiedSinceDate property.

public DateTime ModifiedSinceDateUtc { get; set; }

Property Value

DateTime

The ModifiedSinceDate property.

ServerSideEncryptionCustomerMethod

The Server-side encryption algorithm to be used with the customer provided key.

public ServerSideEncryptionCustomerMethod ServerSideEncryptionCustomerMethod { get; set; }

Property Value

ServerSideEncryptionCustomerMethod

ServerSideEncryptionCustomerProvidedKey

The base64-encoded encryption key for Amazon S3 to use to decrypt the object

Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only thing you do is manage the encryption keys you provide.

When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies the encryption key you provided matches, and then decrypts the object before returning the object data to you.

Important: Amazon S3 does not store the encryption key you provide.

public string ServerSideEncryptionCustomerProvidedKey { get; set; }

Property Value

string

ServerSideEncryptionCustomerProvidedKeyMD5

The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set.

public string ServerSideEncryptionCustomerProvidedKeyMD5 { get; set; }

Property Value

string

UnmodifiedSinceDate

This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.

Gets or sets the UnmodifiedSinceDate property.

[Obsolete("Setting this property results in non-UTC DateTimes not being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.", false)]
public DateTime UnmodifiedSinceDate { get; set; }

Property Value

DateTime

The UnmodifiedSinceDate property.

UnmodifiedSinceDateUtc

Gets or sets the UnmodifiedSinceDate property.

public DateTime UnmodifiedSinceDateUtc { get; set; }

Property Value

DateTime

The UnmodifiedSinceDate property.

VersionId

Gets or sets the version ID of the Amazon S3 object.

public string VersionId { get; set; }

Property Value

string

The version ID of the Amazon S3 object.