Returns information about the GetObject response and response metadata.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceResponse
Amazon.S3.Model.StreamResponse
Amazon.S3.Model.GetObjectResponse
Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z
Syntax
public class GetObjectResponse : StreamResponse IDisposable
The GetObjectResponse type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetObjectResponse() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AcceptRanges | System.String |
Gets and sets the AcceptRanges. |
|
|
BucketName | System.String |
Gets and sets the BucketName property. |
|
|
ContentLength | System.Int64 | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
|
DeleteMarker | System.String |
Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response. |
|
|
ETag | System.String |
An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL |
|
|
Expiration | Amazon.S3.Model.Expiration |
Gets and sets the Expiration property. Specifies the expiration date for the object and the rule governing the expiration. Is null if expiration is not applicable. |
|
|
Expires | System.DateTime |
The date and time at which the object is no longer cacheable. |
|
|
Headers | Amazon.S3.Model.HeadersCollection |
The collection of headers for the request. |
|
|
HttpStatusCode | System.Net.HttpStatusCode | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
|
Key | System.String |
Gets and sets the Key property. |
|
|
LastModified | System.DateTime |
Last modified date of the object |
|
|
Metadata | Amazon.S3.Model.MetadataCollection |
The collection of meta data for the request. |
|
|
MissingMeta | System.Int32 |
This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers. |
|
|
PartsCount | System.Nullable<System.Int32> |
The number of parts this oject has. |
|
|
ReplicationStatus | Amazon.S3.ReplicationStatus |
The status of the replication job associated with this source object. |
|
|
RequestCharged | Amazon.S3.RequestCharged |
If present, indicates that the requester was successfully charged for the request. |
|
|
ResponseMetadata | Amazon.Runtime.ResponseMetadata | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
|
ResponseStream | System.IO.Stream | Inherited from Amazon.S3.Model.StreamResponse. |
|
|
RestoreExpiration | System.Nullable<System.DateTime> |
Gets and sets the RestoreExpiration property. RestoreExpiration will be set for objects that have been restored from Amazon Glacier. It indiciates for those objects how long the restored object will exist. |
|
|
RestoreInProgress | System.Boolean |
Gets and sets the RestoreInProgress Will be true when the object is in the process of being restored from Amazon Glacier. |
|
|
ServerSideEncryptionCustomerMethod | Amazon.S3.ServerSideEncryptionCustomerMethod |
The Server-side encryption algorithm to be used with the customer provided key. |
|
|
ServerSideEncryptionKeyManagementServiceKeyId | System.String |
The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. |
|
|
ServerSideEncryptionMethod | Amazon.S3.ServerSideEncryptionMethod |
The Server-side encryption algorithm used when storing this object in S3. |
|
|
StorageClass | Amazon.S3.S3StorageClass |
The class of storage used to store the object. |
|
|
TagCount | System.Int32 |
The number of tags, if any, on the object. |
|
|
VersionId | System.String |
Version of the object. |
|
|
WebsiteRedirectLocation | System.String |
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. |
Methods
| Name | Description | |
|---|---|---|
|
|
Dispose() | Inherited from Amazon.S3.Model.StreamResponse. |
|
|
WriteResponseStreamToFile(string) |
Writes the content of the ResponseStream a file indicated by the filePath argument. |
|
|
WriteResponseStreamToFile(string, bool) |
Writes the content of the ResponseStream a file indicated by the filePath argument. |
|
|
WriteResponseStreamToFileAsync(string, bool, CancellationToken) |
Writes the content of the ResponseStream a file indicated by the filePath argument. |
Events
| Name | Description | |
|---|---|---|
|
|
WriteObjectProgressEvent |
Examples
This example shows how to get an object.
GetObject sample
// Create a client
AmazonS3Client client = new AmazonS3Client();
// Create a GetObject request
GetObjectRequest request = new GetObjectRequest
{
BucketName = "SampleBucket",
Key = "Item1"
};
// Issue request and remember to dispose of the response
using (GetObjectResponse response = client.GetObject(request))
{
using (StreamReader reader = new StreamReader(response.ResponseStream))
{
string contents = reader.ReadToEnd();
Console.WriteLine("Object - " + response.Key);
Console.WriteLine(" Version Id - " + response.VersionId);
Console.WriteLine(" Contents - " + contents);
}
}
This example shows how to get an object and write it to a local file.
GetObject WriteResponseStreamToFile Sample
// Create a client
AmazonS3Client client = new AmazonS3Client();
// Create a GetObject request
GetObjectRequest request = new GetObjectRequest
{
BucketName = "SampleBucket",
Key = "Item1"
};
// Issue request and remember to dispose of the response
using (GetObjectResponse response = client.GetObject(request))
{
// Save object to local file
response.WriteResponseStreamToFile("Item1.txt");
}
Version Information
.NET Standard:
Supported in: 1.3
.NET Framework:
Supported in: 4.5, 4.0, 3.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms
Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone
