The GetObjectRequest contains the parameters used for the GetObject operation.
For more information about the optional parameters,
refer: http://docs.amazonwebservices.com/AmazonS3/latest/RESTObjectGET.html
Required Parameters: BucketName, Key
Optional Parameters: VersionId, ModifiedSinceDate, UnmodifiedSinceDate, ETagToMatch, ETagToNotMatch, ByteRange
Namespace: Amazon.S3.ModelRequired Parameters: BucketName, Key
Optional Parameters: VersionId, ModifiedSinceDate, UnmodifiedSinceDate, ETagToMatch, ETagToNotMatch, ByteRange
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)
Syntax
Members
| All Members | Constructors | Properties | Methods |
| Member | Description | |
|---|---|---|
| GetObjectRequest()()()() | Initializes a new instance of the GetObjectRequest 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.) | |
| BucketName |
Gets and sets the BucketName property.
| |
| ByteRange |
Gets the ByteRange property.
| |
| ByteRangeLong |
Gets and sets the ByteRangeLong property.
| |
| Equals(Object) | (Inherited from Object.) | |
| ETagToMatch |
Gets and sets the ETagToMatch property.
| |
| ETagToNotMatch |
Gets and sets the ETagToNotMatch property.
| |
| 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.
| |
| ModifiedSinceDate |
Gets and sets the ModifiedSinceDate property.
| |
| 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 GET Object requests.
| |
| ResponseHeaderOverrides |
Gets and sets the response headers to be returned back with the response of the object.
| |
| 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 GET Object requests.
| |
| ToString()()()() | (Inherited from S3Request.) | |
| UnmodifiedSinceDate |
Gets and sets the UnmodifiedSinceDate property.
| |
| VersionId |
Gets and sets the VersionId property.
| |
| WithBucketName(String) |
Sets the BucketName property for this request.
This is the S3 Bucket that contains the S3 Object you
want to get.
| |
| WithByteRange(Int32, Int32) |
Sets the ByteRange property with the start and end index
specified.
When this is set the request downloads the specified range of an object.
| |
| WithByteRangeLong(Int64, Int64) |
Sets the ByteRangeLong property with the start and end index
specified.
When this is set the request downloads the specified range of an object.
| |
| WithETagToMatch(String) |
Sets the ETagToMatch property for this request.
When this is set the S3 object is returned only if
its entity tag (ETag) is the same as the one specified,
otherwise return a 412 (precondition failed).
| |
| WithETagToNotMatch(String) |
Sets the ETagToNotMatch property for this request.
When this is set the S3 object is returned only if
its entity tag (ETag) is different from the one
specified, otherwise return a 304 (not modified).
| |
| 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 want to Get.
| |
| WithModifiedSinceDate(DateTime) |
Sets the ModifiedSinceDate property for this request.
When this is set the S3 object is returned only if it
has been modified since the specified time, otherwise
returns a 304 (not modified).
| |
| WithReadWriteTimeout(Int32) |
Sets the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout property of the HttpWebRequest.
| |
| WithResponseHeaderOverrides(ResponseHeaderOverrides) |
Sets the ResponseHeaderOverrides property and returns back this instance for method chaining.
| |
| WithTimeout(Int32) |
Sets the Timeout property (in milliseconds).
The value of this property is assigned to the
Timeout property of the HttpWebRequest
Please specify a timeout value only if you are certain that
the file will not be retrieved within the default intervals
specified for an HttpWebRequest.
| |
| WithUnmodifiedSinceDate(DateTime) |
Sets the UnmodifiedSinceDate property for this request.
When this is set the S3 object is returned only if it
has not been modified since the specified time, otherwise
return a 412 (precondition failed).
| |
| WithVersionId(String) |
Sets the VersionId property for this request.
This is the VersionId for the S3 Object you want to Get.
|