C# Class Amazon.S3.Model.GetObjectResponse

The GetObjectResponse contains any header or metadata returned by S3. GetObjectResponse's contain resources that need to be disposed. The recommended way for handling GetObjectResponse objects is wrapping them in using clauses, like so: using (GetObjectResponse response = s3Client.GetObject(request)) { ... } This will ensure that any network resources, file streams and web headers have been returned back to the system for future use.

Inheritance: Amazon.S3.Model.S3Response

Show file Open project: aws/aws-sdk-net Class Usage Examples

Private Properties

Property	Type	Description
CreateDirectory	void
CreateDownloadStream	Stream
IsSetAcceptRanges	bool
IsSetDeleteMarker	bool
IsSetETag	bool
IsSetExpiration	bool
IsSetExpires	bool
IsSetLastModified	bool
IsSetMissingMeta	bool
IsSetPartsCount	bool
IsSetReplicationStatus	bool
IsSetRequestCharged	bool
IsSetServerSideEncryptionKeyManagementServiceKeyId	bool
IsSetServerSideEncryptionMethod	bool
IsSetStorageClass	bool
IsSetVersionId	bool
IsSetWebsiteRedirectLocation	bool
OnRaiseProgressEvent	void
ValidateWrittenStreamSize	void

Public Methods

Method	Description
WriteResponseStreamToFile ( string filePath ) : void	Writes the content of the ResponseStream a file indicated by the filePath argument.
WriteResponseStreamToFile ( string filePath, bool append ) : void	Writes the content of the ResponseStream a file indicated by the filePath argument.
WriteResponseStreamToFileAsync ( string filePath, bool append, System cancellationToken ) : System.Threading.Tasks.Task	Writes the content of the ResponseStream a file indicated by the filePath argument.

Private Methods

Method	Description
CreateDirectory ( string filePath ) : void
CreateDownloadStream ( string filePath, bool append ) : Stream
IsSetAcceptRanges ( ) : bool
IsSetDeleteMarker ( ) : bool
IsSetETag ( ) : bool
IsSetExpiration ( ) : bool
IsSetExpires ( ) : bool
IsSetLastModified ( ) : bool
IsSetMissingMeta ( ) : bool
IsSetPartsCount ( ) : bool	Checks if PartsCount is set.
IsSetReplicationStatus ( ) : bool	Checks if ReplicationStatus property is set.
IsSetRequestCharged ( ) : bool	Checks to see if RequestCharged is set.
IsSetServerSideEncryptionKeyManagementServiceKeyId ( ) : bool	Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set.
IsSetServerSideEncryptionMethod ( ) : bool
IsSetStorageClass ( ) : bool
IsSetVersionId ( ) : bool
IsSetWebsiteRedirectLocation ( ) : bool
OnRaiseProgressEvent ( string file, long incrementTransferred, long transferred, long total ) : void	This method is called by a producer of write object progress notifications. When called, all the subscribers in the invocation list will be called sequentially.
ValidateWrittenStreamSize ( long bytesWritten ) : void

Method Details

WriteResponseStreamToFile() public method

Writes the content of the ResponseStream a file indicated by the filePath argument.

public WriteResponseStreamToFile ( string filePath ) : void
filePath	string	The location where to write the ResponseStream
return	void

WriteResponseStreamToFile() public method

Writes the content of the ResponseStream a file indicated by the filePath argument.

public WriteResponseStreamToFile ( string filePath, bool append ) : void
filePath	string	The location where to write the ResponseStream
append	bool	Whether or not to append to the file if it exists
return	void

WriteResponseStreamToFileAsync() public method

Writes the content of the ResponseStream a file indicated by the filePath argument.

public WriteResponseStreamToFileAsync ( string filePath, bool append, System cancellationToken ) : System.Threading.Tasks.Task
filePath	string	The location where to write the ResponseStream
append	bool	Whether or not to append to the file if it exists
cancellationToken	System	Cancellation token which can be used to cancel this operation.
return	System.Threading.Tasks.Task