The PutObjectRequest contains the parameters used for the PutObject operation.
Must set only 1 of ContentBody, InputStream, or FilePath
Required Parameters: BucketName, Key
Optional Parameters: CannedACL, ACL, MD5Digest, GenerateMD5Digest, ContentType, Metadata, Timeout
Namespace: Amazon.S3.ModelMust set only 1 of ContentBody, InputStream, or FilePath
Required Parameters: BucketName, Key
Optional Parameters: CannedACL, ACL, MD5Digest, GenerateMD5Digest, ContentType, Metadata, Timeout
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)
Syntax
Members
| All Members | Constructors | Properties | Methods | Events |
| Member | Description | |
|---|---|---|
| PutObjectRequest()()()() | Initializes a new instance of the PutObjectRequest 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 and sets the AutoCloseStream property. 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. The property is defaulted to true.
| |
| BucketName |
Gets and sets the BucketName property.
| |
| CannedACL |
Gets and sets the CannedACL property.
If set, the S3 Object will have this CannedACL
permission. Please refer to
S3CannedACL for
information on S3 Canned ACLs.
| |
| ContentBody |
Gets and sets the ContentBody property.
| |
| ContentType |
Gets and sets the ContentType property.
| |
| Equals(Object) | (Inherited from Object.) | |
| FilePath |
Gets and sets the FilePath property.
| |
| GenerateMD5Digest |
Gets and Sets the property that governs whether
a md5Digest is generated for the object being
PUT into S3.
| |
| 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 and sets the Key property.
| |
| MD5Digest |
Gets and sets the MD5 Digest property.
| |
| PutObjectProgressEvent |
The event for Put Object progress notifications. All
subscribers will be notified when a new progress
event is raised.
| |
| ReadWriteTimeout |
Gets and sets of the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout property of the HTTPWebRequest object
used for S3 PUT Object requests.
| |
| RemoveCannedACL()()()() |
Resets the CannedACL
| |
| 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 and sets the StorageClass property.
Default: S3StorageClass.Standard. Set this property
only if you want reduced redundancy for this object.
Please refer to
S3StorageClass for
information on S3 Storage Classes.
| |
| Timeout |
Gets and sets of the Timeout property (in milliseconds).
The value of this property is assigned to the
Timeout property of the HTTPWebRequest object used
for S3 PUT Object requests.
| |
| ToString()()()() | (Inherited from S3Request.) | |
| WithAutoCloseStream(Boolean) |
Sets the AutoCloseStream property for this request. 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. The property is defaulted to true.
| |
| WithBucketName(String) |
Sets the BucketName property for this request.
This is the S3 Bucket where the S3 Object you are
creating gets put.
| |
| WithCannedACL(S3CannedACL) |
Sets the CannedACL property for this request.
If set, the S3 Object will have this CannedACL
permission. Please refer to
S3CannedACL for
information on S3 Canned ACLs.
| |
| WithContentBody(String) |
Sets the ContentBody property for this request.
Use this property if you want to upload plaintext to
S3. The ContentBody is the data for your S3 Object.
| |
| WithContentType(String) |
Sets the ContentType property for this request.
This property defaults to "binary/octet-stream",
but if you require something else you can set this property.
| |
| WithFilePath(String) |
Sets the FilePath property for this request.
If this is set the request will upload the
specified file to S3. Provide FilePath as an
absolute path.
| |
| WithGenerateChecksum(Boolean) |
Sets the GenerateMD5Digest property. If this property is set,
the MD5 md5Digest of the data to be uploaded is generated
prior to the data being sent to S3.
| |
| WithInputStream(Stream) |
Sets the InputStream property.
(Inherited from S3Request.) | |
| WithKey(String) |
Sets the Key property for this request.
This is the Key for the S3 Object you create.
| |
| WithMD5Digest(String) |
Sets the MD5Digest property. This is the MD5 Hash of the file.
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.
| |
| WithMetaData(NameValueCollection) |
Adds a set of key-value pairs to the request
| |
| WithMetaData(String, String) |
Adds a key/value pair to the Metadata property for this request.
The S3 Object that you create will have this metadata associated
with it.
| |
| WithReadWriteTimeout(Int32) |
Sets the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout property of the HttpWebRequest.
| |
| WithServerSideEncryptionMethod(ServerSideEncryptionMethod) |
Sets the ServerSideEncryptionMethod property for this request.
Specifies the encryption used on the server to
store the content.
| |
| WithStorageClass(S3StorageClass) |
Sets the StorageClass property for this request.
Default: S3StorageClass.Standard. Set this property
only if you want reduced redundancy for this object.
Please refer to
S3StorageClass for
information on S3 Storage Classes.
| |
| WithSubscriber(EventHandler<(Of <<'(PutObjectProgressArgs>)>>)) |
The "handler" will be notified every time a put
object progress event is raised.
| |
| WithTimeout(Int32) |
Sets the Timeout property (in milliseconds).
Please set the timeout only if you are certain that
the file will not be transferred within the default intervals
for an HttpWebRequest.
|