Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest Class Reference

Contains all the parameters that can be set when making a this request with the TransferUtility method. More...

Inheritance diagram for Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest:
Amazon.S3.Transfer.BaseUploadRequest

Public Attributes

Action< object,
UploadDirectoryProgressArgs
UploadDirectoryProgressEvent
 The event for UploadDirectoryProgressEvent notifications. All subscribers will be notified when a new progress event is raised. More...
 

Properties

string Directory [get, set]
 Gets or sets the directory where files are uploaded from. More...
 
string KeyPrefix [get, set]
 Gets or sets the KeyPrefix property. As object keys are generated for the files being uploaded this value will prefix the key. This is useful when a directory needs to be uploaded into sub directory in the S3 Bucket. More...
 
string SearchPattern [get, set]
 Gets and sets the search pattern used to determine which files in the directory are uploaded. More...
 
SearchOption SearchOption [get, set]
 Gets or sets the recursive options for the directory upload. More...
 
string BucketName [get, set]
 Gets or sets the name of the bucket. More...
 
S3CannedACL CannedACL [get, set]
 Gets or sets the canned access control list (ACL) for the uploaded objects. Please refer to T:Amazon.S3.Model.S3CannedACL for information on Amazon S3 canned ACLs. More...
 
S3StorageClass StorageClass [get, set]
 Gets or sets the storage class for the uploaded Amazon S3 objects. Please refer to T:Amazon.S3.Model.S3StorageClass for information on S3 Storage Classes. More...
 
MetadataCollection Metadata [get, set]
 The collection of meta data for the request. More...
 
ServerSideEncryptionMethod ServerSideEncryptionMethod [get, set]
 Gets and sets the ServerSideEncryptionMethod property. Specifies the encryption used on the server to store the content. More...
 

Detailed Description

Contains all the parameters that can be set when making a this request with the TransferUtility method.

Member Data Documentation

Action<object, UploadDirectoryProgressArgs> Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest.UploadDirectoryProgressEvent

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

The UploadDirectoryProgressEvent is fired as data is uploaded to S3. The delegates attached to the event will be passed information detailing how much data has been uploaded as well as how much will be uploaded.

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

  1. Define a method with a signature similar to this one:
    private void displayProgress(object sender, UploadDirectoryProgressArgs args)
    {
    Console.WriteLine(args);
    }
  2. Add this method to the UploadDirectoryProgressEvent delegate's invocation list
    TransferUtilityUploadDirectoryRequest request = new TransferUtilityUploadDirectoryRequest();
    request.UploadDirectoryProgressEvent += displayProgress;

Property Documentation

string Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest.BucketName
getset

Gets or sets the name of the bucket.

The name of the bucket.

S3CannedACL Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest.CannedACL
getset

Gets or sets the canned access control list (ACL) for the uploaded objects. Please refer to T:Amazon.S3.Model.S3CannedACL for information on Amazon S3 canned ACLs.

The canned access control list (ACL) for the uploaded objects.

string Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest.Directory
getset

Gets or sets the directory where files are uploaded from.

The directory where files are uploaded from.

string Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest.KeyPrefix
getset

Gets or sets the KeyPrefix property. As object keys are generated for the files being uploaded this value will prefix the key. This is useful when a directory needs to be uploaded into sub directory in the S3 Bucket.

The directory where files are uploaded from.

MetadataCollection Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest.Metadata
getset

The collection of meta data for the request.

SearchOption Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest.SearchOption
getset

Gets or sets the recursive options for the directory upload.

The recursive options for the directory upload. Set by default to TopDirectoryOnly, specifying that files will be uploaded from the root directory only.

string Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest.SearchPattern
getset

Gets and sets the search pattern used to determine which files in the directory are uploaded.

The search pattern used to deterimine which files in the directory are uploaded. The default value is "*", specifying that all files in the directory will be uploaded.

ServerSideEncryptionMethod Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest.ServerSideEncryptionMethod
getset

Gets and sets the ServerSideEncryptionMethod property. Specifies the encryption used on the server to store the content.

S3StorageClass Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest.StorageClass
getset

Gets or sets the storage class for the uploaded Amazon S3 objects. Please refer to T:Amazon.S3.Model.S3StorageClass for information on S3 Storage Classes.

The storage class for the uploaded Amazon S3 objects.


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