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

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

Inheritance diagram for Amazon.S3.Model.CopyObjectRequest:
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...
 
string SourceBucket [get, set]
 The name of the bucket containing the object to copy. More...
 
string SourceKey [get, set]
 The key of the object to copy. More...
 
string SourceVersionId [get, set]
 Specifies a particular version of the source object to copy. By default the latest version is copied. More...
 
string DestinationBucket [get, set]
 The name of the bucket to contain the copy of the source object. More...
 
string DestinationKey [get, set]
 The key to be given to the copy of the source object. 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...
 
string ETagToMatch [get, set]
 ETag to be matched as a pre-condition for copying the source object otherwise returns a PreconditionFailed. More...
 
string ETagToNotMatch [get, set]
 ETag that must not be matched as a pre-condition for copying the source object, otherwise returns a PreconditionFailed. More...
 
DateTime ModifiedSinceDate [get, set]
 Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. More...
 
DateTime UnmodifiedSinceDate [get, set]
 Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. More...
 
S3MetadataDirective MetadataDirective [get, set]
 Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. More...
 
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 bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. Amazon S3 stores the value of this header in the object metadata. More...
 
HeadersCollection Headers [get]
 The collection of headers for the request. More...
 
MetadataCollection Metadata [get]
 The collection of meta data for the request. More...
 
string ContentType [get, set]
 This is a convenience property for Headers.ContentType. 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 CopyObject operation.

Creates a copy of an object that is already stored in Amazon S3.

Property Documentation

S3CannedACL Amazon.S3.Model.CopyObjectRequest.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.CopyObjectRequest.ContentType
getset

This is a convenience property for Headers.ContentType.

string Amazon.S3.Model.CopyObjectRequest.DestinationBucket
getset

The name of the bucket to contain the copy of the source object.

string Amazon.S3.Model.CopyObjectRequest.DestinationKey
getset

The key to be given to the copy of the source object.

string Amazon.S3.Model.CopyObjectRequest.ETagToMatch
getset

ETag to be matched as a pre-condition for copying the source object otherwise returns a PreconditionFailed.

Copies the object if its entity tag (ETag) matches the specified tag; otherwise return a 412 (precondition failed). Constraints: This property can be used with IfUnmodifiedSince, but cannot be used with other conditional copy properties.

string Amazon.S3.Model.CopyObjectRequest.ETagToNotMatch
getset

ETag that must not be matched as a pre-condition for copying the source object, otherwise returns a PreconditionFailed.

HeadersCollection Amazon.S3.Model.CopyObjectRequest.Headers
get

The collection of headers for the request.

MetadataCollection Amazon.S3.Model.CopyObjectRequest.Metadata
get

The collection of meta data for the request.

S3MetadataDirective Amazon.S3.Model.CopyObjectRequest.MetadataDirective
getset

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

DateTime Amazon.S3.Model.CopyObjectRequest.ModifiedSinceDate
getset

Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed.

Copies the object if it has been modified since the specified time; otherwise returns a 412 (failed condition). Constraints: This property can be used with ETagToNotMatch, but cannot be used with other conditional copy properties.

TimeSpan Amazon.S3.Model.CopyObjectRequest.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.CopyObjectRequest.ServerSideEncryptionMethod
getset

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

string Amazon.S3.Model.CopyObjectRequest.SourceBucket
getset

The name of the bucket containing the object to copy.

string Amazon.S3.Model.CopyObjectRequest.SourceKey
getset

The key of the object to copy.

string Amazon.S3.Model.CopyObjectRequest.SourceVersionId
getset

Specifies a particular version of the source object to copy. By default the latest version is copied.

S3StorageClass Amazon.S3.Model.CopyObjectRequest.StorageClass
getset

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

TimeSpan Amazon.S3.Model.CopyObjectRequest.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
DateTime Amazon.S3.Model.CopyObjectRequest.UnmodifiedSinceDate
getset

Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed.

Copies the object if it hasn't been modified since the specified time; otherwise returns a 412 (precondition failed). Constraints: This property can be used with ETagToMatch, but cannot be used with other conditional copy properties.

string Amazon.S3.Model.CopyObjectRequest.WebsiteRedirectLocation
getset

If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName 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: