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

Namespace: Amazon.S3.Transfer
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public class TransferUtilityUploadRequest : S3Request
Public Class TransferUtilityUploadRequest _
	Inherits S3Request
public ref class TransferUtilityUploadRequest : public S3Request

Members

               
 All Members  Constructors   Properties   Methods   Events  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
TransferUtilityUploadRequest()()()()
Initializes a new instance of the TransferUtilityUploadRequest class
AddHeader(String, String)
Adds the header to the collection of headers for the request.
(Inherited from S3Request.)
AddHeaders(NameValueCollection)
Adds all of the key/value pairs from collection into our request header.
(Inherited from S3Request.)
AutoCloseStream
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.
BucketName
Gets or sets the name of the bucket.
CannedACL
Gets or sets the canned access control list (ACL) for the uploaded object. Please refer to S3CannedACL for information on Amazon S3 canned ACLs.
ContentType
Gets or sets the content type of the uploaded Amazon S3 object.
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
FilePath
Gets or sets the file path where the Amazon S3 object will be uploaded from.
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
InputStream
Gets and sets the InputStream property.
(Inherited from S3Request.)
Key
Gets or sets the key under which the Amazon S3 object is to be stored.
PartSize
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.
RemoveCannedACL()()()()
Removes the cannned access control list (ACL) for the uploaded object.
RemoveMetadata(String)
Removes a key from the metadata list if it was added previously.
ServerSideEncryptionMethod
Gets and sets the ServerSideEncryptionMethod property. Specifies the encryption used on the server to store the content.
StorageClass
Gets or sets the storage class for the uploaded Amazon S3 object. Please refer to S3StorageClass for information on S3 Storage Classes.
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.
ToString()()()() (Inherited from S3Request.)
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.

WithAutoCloseStream(Boolean)
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.
WithBucketName(String)
Sets the name of the bucket and returns this object instance, enabling additional method calls to be chained together.
WithCannedACL(S3CannedACL)
Gets or sets the canned access control list (ACL) for the uploaded object. Please refer to S3CannedACL for information on Amazon S3 canned ACLs.
WithContentType(String)
Sets the content type of the uploaded Amazon S3 object. and returns this object instance, enabling additional method calls to be chained together. This property defaults to binary/octet-stream.
WithFilePath(String)
Sets the file path location of where the Amazon S3 object will be uploaded from and returns this object instance, enabling additional method calls to be chained together.
WithInputStream(Stream)
Sets the InputStream property.
(Inherited from S3Request.)
WithKey(String)
Sets the key under which the Amazon S3 object is stored and returns this object instance, enabling additional method calls to be chained together.
WithMetadata(NameValueCollection)
Adds a set of key-value pairs to the request and returns this object instance, enabling additional method calls to be chained together.
WithMetadata(String, String)
Adds a set of key-value pairs to the request and returns this object instance, enabling additional method calls to be chained together.
WithPartSize(Int64)
Sets the part size of the upload in bytes and returns this object instance, enabling additional method calls to be chained together. The uploaded file will be divided into parts the size specified and uploaded to Amazon S3 individually.
WithServerSideEncryptionMethod(ServerSideEncryptionMethod)
Sets the ServerSideEncryptionMethod property for this request. Specifies the encryption used on the server to store the content. Default is None.
WithStorageClass(S3StorageClass)
Sets the storage class for the uploaded Amazon S3 object. and returns this object instance, enabling additional method calls to be chained together. Please refer to S3StorageClass for information on S3 Storage Classes.
WithSubscriber(EventHandler<(Of <<'(UploadProgressArgs>)>>))
The handler will be attached to the UploadProgressEvent which is fired as data is uploaded to S3. The handler will be passed information detailing how much data has been uploaded as well as how much will be uploaded.
WithTimeout(Int32)
Sets the sets the timeout property in milliseconds and returns this object instance, enabling additional method calls to be chained together. Set the timeout only if certain that the file will not be transferred within the default intervals for an HttpWebRequest.

Inheritance Hierarchy

System..::..Object
  Amazon.S3.Model..::..S3Request
    Amazon.S3.Transfer..::..TransferUtilityUploadRequest

See Also