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

Container for the parameters to the PutObject operation. More...

Inheritance diagram for Amazon.S3.Model.PutObjectRequest:
Amazon.S3.Model.PutWithACLRequest Amazon.S3.Model.PutWithACLRequest

Properties

TimeSpan Timeout [get, set]
 Overrides the default request timeout value. More...
 
TimeSpan ReadWriteTimeout [get, set]
 Overrides the default ReadWriteTimeout value. More...
 
S3CannedACL CannedACL [get, set]
 A canned access control list (CACL) to apply to the object. Please refer to T:Amazon.S3.Model.S3CannedACL for information on S3 Canned ACLs. 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]
 
string ContentBody [get, set]
 Text content to be uploaded. Use this property if you want to upload plaintext to S3. The content type will be set to 'text/plain'. More...
 
bool AutoCloseStream [get, set]
 If this value is set to true then the stream used with this request will be closed when all the content is read from the stream. Default: true. More...
 
bool AutoResetStreamPosition [get, set]
 If this value is set to true then the stream will be seeked back to the start before being read for upload. Default: true. More...
 
string BucketName [get, set]
 The name of the bucket to contain the object. 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...
 
string Key [get, set]
 
ServerSideEncryptionMethod ServerSideEncryptionMethod [get, set]
 The Server-side encryption algorithm used when storing this object in S3. More...
 
S3StorageClass StorageClass [get, set]
 The type of storage to use for the object. Defaults to 'STANDARD'. More...
 
string WebsiteRedirectLocation [get, set]
 If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. More...
 
Action< object,
Amazon.Runtime.StreamTransferProgressArgs > 
StreamTransferProgress [get, set]
 Attach a callback that will be called as data is being sent to the AWS Service. More...
 
string ContentType [get, set]
 This is a convenience property for Headers.ContentType. More...
 
string MD5Digest [get, set]
 An MD5 digest for the content. More...
 
- Properties inherited from Amazon.S3.Model.PutWithACLRequest
List< S3GrantGrants [get, set]
 Gets the access control lists (ACLs) for this request. Please refer to T:Amazon.S3.Model.Grant for information on S3 Grants. More...
 

Detailed Description

Container for the parameters to the PutObject operation.

Adds an object to a bucket.

Property Documentation

bool Amazon.S3.Model.PutObjectRequest.AutoCloseStream
getset

If this value is set to true then the stream used with this request will be closed when all the content is read from the stream. Default: true.

bool Amazon.S3.Model.PutObjectRequest.AutoResetStreamPosition
getset

If this value is set to true then the stream will be seeked back to the start before being read for upload. Default: true.

string Amazon.S3.Model.PutObjectRequest.BucketName
getset

The name of the bucket to contain the object.

S3CannedACL Amazon.S3.Model.PutObjectRequest.CannedACL
getset

A canned access control list (CACL) to apply to the object. Please refer to T:Amazon.S3.Model.S3CannedACL for information on S3 Canned ACLs.

string Amazon.S3.Model.PutObjectRequest.ContentBody
getset

Text content to be uploaded. Use this property if you want to upload plaintext to S3. The content type will be set to 'text/plain'.

string Amazon.S3.Model.PutObjectRequest.ContentType
getset

This is a convenience property for Headers.ContentType.

string Amazon.S3.Model.PutObjectRequest.FilePath
getset

The full path and name to a file to be uploaded. If this is set the request will upload the specified file to S3.

For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt".

HeadersCollection Amazon.S3.Model.PutObjectRequest.Headers
getset

The collection of headers for the request.

Stream Amazon.S3.Model.PutObjectRequest.InputStream
getset

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

string Amazon.S3.Model.PutObjectRequest.MD5Digest
getset

An MD5 digest for the content.

The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent.

If supplied, after the file has been uploaded to S3, S3 checks to ensure that the MD5 hash of the uploaded file matches the hash supplied.

Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check.

MetadataCollection Amazon.S3.Model.PutObjectRequest.Metadata
getset

The collection of meta data for the request.

TimeSpan Amazon.S3.Model.PutObjectRequest.ReadWriteTimeout
getset

Overrides the default ReadWriteTimeout value.

If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used to send requests.

Exceptions
System.ArgumentNullExceptionThe timeout specified is null.
System.ArgumentOutOfRangeExceptionThe timeout specified is less than or equal to zero and is not Infinite.
See Also
P:System.Net.HttpWebRequest.ReadWriteTimeout, P:System.Net.Http.WebRequestHandler.ReadWriteTimeout
ServerSideEncryptionMethod Amazon.S3.Model.PutObjectRequest.ServerSideEncryptionMethod
getset

The Server-side encryption algorithm used when storing this object in S3.

S3StorageClass Amazon.S3.Model.PutObjectRequest.StorageClass
getset

The type of storage to use for the object. Defaults to 'STANDARD'.

Action<object,Amazon.Runtime.StreamTransferProgressArgs> Amazon.S3.Model.PutObjectRequest.StreamTransferProgress
getset

Attach a callback that will be called as data is being sent to the AWS Service.

TimeSpan Amazon.S3.Model.PutObjectRequest.Timeout
getset

Overrides the default request timeout value.

If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used to send requests.

Please specify a timeout value only if the operation will not complete within the default intervals specified for an HttpWebRequest/HttpClient.

Exceptions
System.ArgumentNullExceptionThe timeout specified is null.
System.ArgumentOutOfRangeExceptionThe timeout specified is less than or equal to zero and is not Infinite.
See Also
P:System.Net.HttpWebRequest.Timeout, P:System.Net.Http.HttpClient.Timeout
string Amazon.S3.Model.PutObjectRequest.WebsiteRedirectLocation
getset

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.


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