#include <S3.h>

Inheritance diagram for Aws::Crt::S3::S3GetObjectMetaRequestOptions:

Public Member Functions
	S3GetObjectMetaRequestOptions (const S3GetObjectMetaRequestOptions &)=delete

	S3GetObjectMetaRequestOptions (S3GetObjectMetaRequestOptions &&)=delete

S3GetObjectMetaRequestOptions &	operator= (const S3GetObjectMetaRequestOptions &)=delete

S3GetObjectMetaRequestOptions &	operator= (S3GetObjectMetaRequestOptions &&)=delete

Public Member Functions inherited from Aws::Crt::S3::S3MetaRequestOptions
	S3MetaRequestOptions (const S3MetaRequestOptions &)=delete

	S3MetaRequestOptions (S3MetaRequestOptions &&)=delete

S3MetaRequestOptions &	operator= (const S3MetaRequestOptions &)=delete

S3MetaRequestOptions &	operator= (S3MetaRequestOptions &&)=delete

virtual	~S3MetaRequestOptions () noexcept

S3MetaRequestOptions &	SetSigningConfig (const Auth::AwsSigningConfig &config) noexcept

S3MetaRequestOptions &	SetSigningConfigFromEndpoint (const String &region, const String &signingRegion, const String &signingName, bool isS3Express, const std::shared_ptr< Auth::ICredentialsProvider > &provider) noexcept

S3MetaRequestOptions &	SetChecksumConfig (const S3ChecksumConfig &config) noexcept

S3MetaRequestOptions &	SetEndpoint (const Io::Uri &endpoint) noexcept

S3MetaRequestOptions &	SetHeadersCallback (HeadersCallback cb) noexcept

S3MetaRequestOptions &	SetProgressCallback (ProgressCallback cb) noexcept

S3MetaRequestOptions &	SetFinishCallback (FinishCallback cb) noexcept

S3MetaRequestOptions &	SetShutdownCallback (ShutdownCallback cb) noexcept

S3MetaRequestOptions &	SetRecvFileMode (S3RecvFileMode mode) noexcept

S3MetaRequestOptions &	SetRecvFilePosition (uint64_t position) noexcept

S3MetaRequestOptions &	SetRecvFileDeleteOnFailure (bool deleteOnFailure) noexcept

S3MetaRequestOptions &	SetObjectSizeHint (uint64_t bytes) noexcept

S3MetaRequestOptions &	SetPartSize (uint64_t bytes) noexcept

S3MetaRequestOptions &	SetMultipartUploadThreshold (uint64_t bytes) noexcept

const BodyCallback &	GetBodyCallback () const noexcept

const BodyCallbackEx &	GetBodyCallbackEx () const noexcept

const HeadersCallback &	GetHeadersCallback () const noexcept

const ProgressCallback &	GetProgressCallback () const noexcept

const FinishCallback &	GetFinishCallback () const noexcept

const ShutdownCallback &	GetShutdownCallback () const noexcept

int	GetLastError () const noexcept

Static Public Member Functions
static ScopedResource< S3MetaRequestOptions >	Create (const std::shared_ptr< Http::HttpRequest > &request, BodyCallback cb) noexcept

static ScopedResource< S3MetaRequestOptions >	Create (const std::shared_ptr< Http::HttpRequest > &request, BodyCallbackEx cb) noexcept

static ScopedResource< S3MetaRequestOptions >	Create (const std::shared_ptr< Http::HttpRequest > &request, const Crt::String &recvFilepath) noexcept

Additional Inherited Members
Public Types inherited from Aws::Crt::S3::S3MetaRequestOptions
using	BodyCallback = std::function< bool(ByteCursor body, uint64_t rangeStart)>

using	BodyCallbackEx = std::function< bool(ByteCursor body, uint64_t rangeStart, S3BufferTicket &ticket)>

using	HeadersCallback = std::function< bool(const Vector< Http::HttpHeader > &headers, int responseStatus)>

using	ProgressCallback = std::function< void(uint64_t bytesTransferred, uint64_t contentLength)>

using	FinishCallback = std::function< void(const S3MetaRequestResult &result)>

using	ShutdownCallback = std::function< void()>

Protected Member Functions inherited from Aws::Crt::S3::S3MetaRequestOptions
	S3MetaRequestOptions (S3MetaRequestType type, const std::shared_ptr< Http::HttpRequest > &request) noexcept

Protected Attributes inherited from Aws::Crt::S3::S3MetaRequestOptions
ScopedResource< Impl >	m_impl

std::shared_ptr< Http::HttpRequest >	m_httpRequest

String	m_operationName

String	m_sendFilepath

String	m_recvFilepath

aws_uri	m_endpoint

bool	m_endpointInit

Optional< uint64_t >	m_objectSizeHint

BodyCallback	m_bodyCb

BodyCallbackEx	m_bodyCbEx

HeadersCallback	m_headersCb

ProgressCallback	m_progressCb

FinishCallback	m_finishCb

ShutdownCallback	m_shutdownCb

int	m_lastError = AWS_ERROR_SUCCESS

Detailed Description

Options for a GetObject meta request. Every download must land somewhere; the three Create overloads pin the delivery path at construction and make it impossible to submit a GetObject that silently drops the body. Which sink is used is determined by the argument type: a BodyCallback, a BodyCallbackEx, or a destination file path.

Constructor & Destructor Documentation

Aws::Crt::S3::S3GetObjectMetaRequestOptions::S3GetObjectMetaRequestOptions ( const S3GetObjectMetaRequestOptions & )

delete

Aws::Crt::S3::S3GetObjectMetaRequestOptions::S3GetObjectMetaRequestOptions ( S3GetObjectMetaRequestOptions && )

delete

Member Function Documentation

ScopedResource< S3MetaRequestOptions > Aws::Crt::S3::S3GetObjectMetaRequestOptions::Create	(	const std::shared_ptr< Http::HttpRequest > &	request,
		BodyCallback	cb
	)

staticnoexcept

Build options that deliver body chunks through a caller-owned BodyCallback.

Parameters

request	the prepared HTTP request.
cb	the body callback to invoke for each chunk.

Returns: a unique_ptr to the base type, or nullptr on failure.

ScopedResource< S3MetaRequestOptions > Aws::Crt::S3::S3GetObjectMetaRequestOptions::Create	(	const std::shared_ptr< Http::HttpRequest > &	request,
		BodyCallbackEx	cb
	)

staticnoexcept

Build options that deliver body chunks through a caller-owned zero-copy BodyCallbackEx, which receives a borrowed S3BufferTicket for each chunk.

Parameters

request	the prepared HTTP request.
cb	the zero-copy body callback.

Returns: a unique_ptr to the base type, or nullptr on failure.

ScopedResource< S3MetaRequestOptions > Aws::Crt::S3::S3GetObjectMetaRequestOptions::Create	(	const std::shared_ptr< Http::HttpRequest > &	request,
		const Crt::String &	recvFilepath
	)

staticnoexcept

Build options that stream the response body directly to a file on disk. Neither BodyCallback nor BodyCallbackEx fires when this overload is used.

Parameters

request	the prepared HTTP request.
recvFilepath	destination file path.

Returns: a unique_ptr to the base type, or nullptr on failure.

S3GetObjectMetaRequestOptions& Aws::Crt::S3::S3GetObjectMetaRequestOptions::operator= ( const S3GetObjectMetaRequestOptions & )

delete

S3GetObjectMetaRequestOptions& Aws::Crt::S3::S3GetObjectMetaRequestOptions::operator= ( S3GetObjectMetaRequestOptions && )

delete

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

include/aws/crt/s3/S3.h
source/s3/S3.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation