AWS SDK for C++  0.14.3
AWS SDK for C++
Public Member Functions | Friends | List of all members
Aws::Transfer::DownloadFileRequest Class Reference

#include <DownloadFileRequest.h>

+ Inheritance diagram for Aws::Transfer::DownloadFileRequest:

Public Member Functions

 DownloadFileRequest (const Aws::String &fileName, const Aws::String &bucketName, const Aws::String &keyName, const std::shared_ptr< Aws::S3::S3Client > &s3Client)
 
 ~DownloadFileRequest ()
 
bool DoSingleObjectDownload ()
 
bool IsReady () const override
 
void OnDataReceived (const Aws::Http::HttpRequest *, Aws::Http::HttpResponse *, long long)
 
uint32_t GetRetries () const
 
- Public Member Functions inherited from Aws::Transfer::S3FileRequest
 S3FileRequest (const Aws::String &fileName, const Aws::String &bucketName, const Aws::String &keyName, const std::shared_ptr< Aws::S3::S3Client > &s3Client)
 
virtual ~S3FileRequest ()
 
virtual float GetProgress () const
 
const Aws::StringGetBucketName () const
 
const Aws::StringGetFileName () const
 
const Aws::StringGetKeyName () const
 
bool IsDone () const
 
bool CompletedSuccessfully () const
 
virtual bool WaitUntilDone () const
 
const Aws::StringGetFailure () const
 
void SetLastFailure (const char *failureString)
 
virtual uint64_t GetFileSize () const
 
uint64_t GetProgressAmount () const
 
void AddCompletionCallback (S3FileCompletionCallback addCallback)
 

Friends

class TransferClient
 

Additional Inherited Members

- Public Types inherited from Aws::Transfer::S3FileRequest
using S3FileCompletionCallback = std::function< void() >
 
- Protected Member Functions inherited from Aws::Transfer::S3FileRequest
const std::shared_ptr< Aws::S3::S3Client > & GetS3Client () const
 
void Cancel ()
 
virtual void SetDone ()
 
void SetCompleted ()
 
void CompletionSuccess ()
 
virtual void CompletionFailure (const char *failureStr)
 
virtual void SetFileSize (uint64_t curSize)
 
void ClearProgress ()
 
void RegisterProgress (int64_t progressAmount)
 

Detailed Description

Definition at line 44 of file DownloadFileRequest.h.

Constructor & Destructor Documentation

Aws::Transfer::DownloadFileRequest::DownloadFileRequest ( const Aws::String fileName,
const Aws::String bucketName,
const Aws::String keyName,
const std::shared_ptr< Aws::S3::S3Client > &  s3Client 
)
Aws::Transfer::DownloadFileRequest::~DownloadFileRequest ( )

Member Function Documentation

bool Aws::Transfer::DownloadFileRequest::DoSingleObjectDownload ( )
uint32_t Aws::Transfer::DownloadFileRequest::GetRetries ( ) const
inline

Definition at line 56 of file DownloadFileRequest.h.

bool Aws::Transfer::DownloadFileRequest::IsReady ( ) const
overridevirtual
void Aws::Transfer::DownloadFileRequest::OnDataReceived ( const Aws::Http::HttpRequest ,
Aws::Http::HttpResponse ,
long  long 
)

Friends And Related Function Documentation

friend class TransferClient
friend

Definition at line 58 of file DownloadFileRequest.h.


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