GetObjectRequest Class

.NET Framework 4.5
 
 
 
Did this page help you?  Yes  No   Tell us about it...
Container for the parameters to the GetObject operation.

Retrieves objects from Amazon S3.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.S3.Model.GetObjectRequest

Namespace: Amazon.S3.Model
Assembly: AWSSDK.dll
Version: 2.0.0.3

Syntax

C#
public class GetObjectRequest : AmazonWebServiceRequest
         IRequestEvents

The GetObjectRequest type exposes the following members

Constructors

  Name Description
Public Method GetObjectRequest()

Properties

  Name Description
Public Property BucketName The name of the bucket containing the object.
Public Property ByteRange Downloads the specified range bytes of an object.
Public Property EtagToMatch ETag to be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned.
Public Property EtagToNotMatch ETag that should not be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned.
Public Property Key
Public Property ModifiedSinceDate Returns the object only if it has been modified since the specified time, otherwise returns a PreconditionFailed.
Public Property ResponseExpires Sets the Expires header of the response.
Public Property ResponseHeaderOverrides A set of response headers that should be returned with the object.
Public Property UnmodifiedSinceDate Returns the object only if it has not been modified since the specified time, otherwise returns a PreconditionFailed.
Public Property VersionId VersionId used to reference a specific version of the object.

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);
    }
}

                

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8

.NET for Windows Phone:
Supported in: Window Phone 8