Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.S3.Transfer.TransferUtilityUploadRequest 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.TransferUtilityUploadRequest:
Amazon.S3.Transfer.BaseUploadRequest

Public Member Functions

void RemoveCannedACL ()
 Removes the cannned access control list (ACL) for the uploaded object. More...
 
TransferUtilityUploadRequest WithAutoCloseStream (bool autoCloseStream)
 Sets whether or not the stream used with this request is automatically closed when all of the content is read from the stream and returns this object instance, enabling additional method calls to be chained together. More...
 

Public Attributes

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

Properties

string BucketName [get, set]
 Gets or sets the name of the bucket. More...
 
string Key [get, set]
 Gets or sets the key under which the Amazon S3 object is to be stored. More...
 
S3CannedACL CannedACL [get, set]
 Gets or sets the canned access control list (ACL) for the uploaded object. Please refer to T:Amazon.S3.Model.S3CannedACL for information on Amazon S3 canned ACLs. More...
 
string ContentType [get, set]
 Gets or sets the content type of the uploaded Amazon S3 object. More...
 
S3StorageClass StorageClass [get, set]
 Gets or sets the storage class for the uploaded Amazon S3 object. Please refer to T:Amazon.S3.Model.S3StorageClass for information on S3 Storage Classes. More...
 
ServerSideEncryptionMethod ServerSideEncryptionMethod [get, set]
 Gets and sets the ServerSideEncryptionMethod property. Specifies the encryption used on the server to store the content. More...
 
Stream InputStream [get, set]
 Input stream for the request; content for the request will be read from the stream. More...
 
string FilePath [get, set]
 Gets or sets the file path where the Amazon S3 object will be uploaded from. More...
 
long PartSize [get, set]
 Gets or sets the part size of the upload in bytes. The uploaded file will be divided into parts the size specified and uploaded to Amazon S3 individually. More...
 
HeadersCollection Headers [get, set]
 The collection of headers for the request. More...
 
MetadataCollection Metadata [get, set]
 The collection of meta data for the request. More...
 
bool AutoCloseStream [get, set]
 Gets or sets whether or not the stream used with this request is automatically closed when all of the content is read from the stream. More...
 
bool AutoResetStreamPosition [get, set]
 If this value is set to true then the stream's position will be reset to the start before being read for upload. Default: true. More...
 

Detailed Description

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

Member Function Documentation

void Amazon.S3.Transfer.TransferUtilityUploadRequest.RemoveCannedACL ( )

Removes the cannned access control list (ACL) for the uploaded object.

TransferUtilityUploadRequest Amazon.S3.Transfer.TransferUtilityUploadRequest.WithAutoCloseStream ( bool  autoCloseStream)

Sets whether or not the stream used with this request is automatically closed when all of the content is read from the stream and returns this object instance, enabling additional method calls to be chained together.

Parameters
autoCloseStreamA value of true if the if the stream is automatically closed when all of the content is read from the stream. A value of false if otherwise.
Returns
This object instance, enabling additional method calls to be chained together.

Member Data Documentation

Action<object, UploadProgressArgs> Amazon.S3.Transfer.TransferUtilityUploadRequest.UploadProgressEvent

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

The UploadProgressEvent 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 UploadProgressEvent notifications. Here is how:

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

Property Documentation

bool Amazon.S3.Transfer.TransferUtilityUploadRequest.AutoCloseStream
getset

Gets or sets whether or not the stream used with this request is automatically closed when all of the content is read from the stream.

A value of true if the if the stream is automatically closed when all of the content is read from the stream. A value of false if otherwise.

bool Amazon.S3.Transfer.TransferUtilityUploadRequest.AutoResetStreamPosition
getset

If this value is set to true then the stream's position will be reset to the start before being read for upload. Default: true.

string Amazon.S3.Transfer.TransferUtilityUploadRequest.BucketName
getset

Gets or sets the name of the bucket.

The name of the bucket.

S3CannedACL Amazon.S3.Transfer.TransferUtilityUploadRequest.CannedACL
getset

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

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

string Amazon.S3.Transfer.TransferUtilityUploadRequest.ContentType
getset

Gets or sets the content type of the uploaded Amazon S3 object.

The content type of the uploaded Amazon S3 object.

string Amazon.S3.Transfer.TransferUtilityUploadRequest.FilePath
getset

Gets or sets the file path where the Amazon S3 object will be uploaded from.

The file path where the Amazon S3 object will be uploaded from.

HeadersCollection Amazon.S3.Transfer.TransferUtilityUploadRequest.Headers
getset

The collection of headers for the request.

Stream Amazon.S3.Transfer.TransferUtilityUploadRequest.InputStream
getset

Input stream for the request; content for the request will be read from the stream.

string Amazon.S3.Transfer.TransferUtilityUploadRequest.Key
getset

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

The key under which the Amazon S3 object is to be stored.

MetadataCollection Amazon.S3.Transfer.TransferUtilityUploadRequest.Metadata
getset

The collection of meta data for the request.

long Amazon.S3.Transfer.TransferUtilityUploadRequest.PartSize
getset

Gets or sets the part size of the upload in bytes. The uploaded file will be divided into parts the size specified and uploaded to Amazon S3 individually.

The part size of the upload.

ServerSideEncryptionMethod Amazon.S3.Transfer.TransferUtilityUploadRequest.ServerSideEncryptionMethod
getset

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

S3StorageClass Amazon.S3.Transfer.TransferUtilityUploadRequest.StorageClass
getset

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

The storage class for the uploaded Amazon S3 object.


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