Public Member Functions | Protected Attributes | Properties

S3GetObjectRequest Class Reference

contains the parameters used for the getObject operation. More...

#import <S3GetObjectRequest.h>

Inherits S3Request.

Inherited by S3GetObjectMetadataRequest.

List of all members.

Public Member Functions

(S3GetObjectRequest *) - initWithKey:withBucket:
 Initialize the request setting the key and bucketName properties.
(void) - setRangeStart:rangeEnd:
 sets the start and end of the range.
(NSString *) - getRange
 returns the range in the form 'bytes=start:end'

Protected Attributes

bool rangeSet

Properties

int rangeStart
 Specifies the starting index of the byte range to download.
int rangeEnd
 Specifies the end index of the byte range to download.
NSDate * ifModifiedSince
 Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
NSDate * ifUnmodifiedSince
 Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
NSString * ifMatch
 Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
NSString * ifNoneMatch
 Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
NSOutputStream * outputStream
 Gets and Sets the output stream for the response data.

Detailed Description

contains the parameters used for the getObject operation.


Member Function Documentation

- (S3GetObjectRequest * S3GetObjectRequest.)initWithKey: (NSString *)  key
withBucket: (NSString *)  bucket 

Initialize the request setting the key and bucketName properties.

- (void S3GetObjectRequest.)setRangeStart: (int)  start
rangeEnd: (int)  end 

sets the start and end of the range.


Property Documentation

- (NSString *) ifMatch [read, write, retain]

Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

- (NSDate *) ifModifiedSince [read, write, retain]

Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

- (NSString *) ifNoneMatch [read, write, retain]

Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

- (NSDate *) ifUnmodifiedSince [read, write, retain]

Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

- (NSOutputStream *) outputStream [read, write, assign]

Gets and Sets the output stream for the response data.

If this is set, then the response will write the data to the supplied stream instead of making it available through the data property.

The stream must be opened and scheduled in the desired runloop. The SDK will not close the stream.


The documentation for this class was generated from the following file: