AWSCore::AwsApiRequestJob< RequestTraits >::Function Class Reference

#include <AWSApiRequestJob.h>

Inherits AWSCore::AwsApiRequestJob< RequestTraits >.

Public Member Functions
	AZ_CLASS_ALLOCATOR (Function, AZ::SystemAllocator)
	Function (OnSuccessFunction onSuccess, OnFailureFunction onFailure=OnFailureFunction{}, IConfig *config=GetDefaultConfig())
Public Member Functions inherited from AWSCore::AwsApiRequestJob< RequestTraits >
	AZ_CLASS_ALLOCATOR (AwsApiRequestJob, AZ::SystemAllocator)
	AwsApiRequestJob (bool isAutoDelete, IConfig *config=GetDefaultConfig())
void	Reset (bool isClearDependent) override
bool	WasSuccess ()
	Determines if the request was successful.
template<class Allocator >
AwsApiRequestJob< RequestTraits > *	Create (OnSuccessFunction onSuccess, OnFailureFunction onFailure, IConfig *config)
Public Member Functions inherited from AWSCore::AwsApiClientJob< RequestTraits::ClientType >
	AZ_CLASS_ALLOCATOR (AwsApiClientJob, AZ::SystemAllocator)
Public Member Functions inherited from AWSCore::AwsApiJob
	AZ_CLASS_ALLOCATOR (AwsApiJob, AZ::SystemAllocator)

Additional Inherited Members
Public Types inherited from AWSCore::AwsApiRequestJob< RequestTraits >
using	AwsApiRequestJobType = AwsApiRequestJob< RequestTraits >
using	AwsApiClientJobType = AwsApiClientJob< typename RequestTraits::ClientType >
using	ClientType = typename RequestTraits::ClientType
using	RequestType = typename RequestTraits::RequestType
using	OutcomeType = typename RequestTraits::OutcomeType
using	ResultType = typename RequestTraits::ResultType
using	ErrorType = typename RequestTraits::ErrorType
using	IConfig = IAwsApiRequestJobConfig< RequestTraits >
using	Config = AwsApiRequestJobConfig< RequestTraits >
using	OnSuccessFunction = AZStd::function< void(AwsApiRequestJob *job)>
using	OnFailureFunction = AZStd::function< void(AwsApiRequestJob *job)>
Public Types inherited from AWSCore::AwsApiClientJob< RequestTraits::ClientType >
using	AwsApiClientJobType = AwsApiClientJob< RequestTraits::ClientType >
using	IConfig = IAwsApiClientJobConfig< RequestTraits::ClientType >
using	Config = AwsApiClientJobConfig< RequestTraits::ClientType >
Public Types inherited from AWSCore::AwsApiJob
using	IConfig = IAwsApiJobConfig
using	Config = AwsApiJobConfig
Static Public Member Functions inherited from AWSCore::AwsApiRequestJob< RequestTraits >
template<class Allocator = AZ::SystemAllocator>
static AwsApiRequestJob *	Create (OnSuccessFunction onSuccess, OnFailureFunction onFailure=OnFailureFunction{}, IConfig *config=GetDefaultConfig())
static Config *	GetDefaultConfig ()
Static Public Member Functions inherited from AWSCore::AwsApiClientJob< RequestTraits::ClientType >
static Config *	GetDefaultConfig ()
Static Public Member Functions inherited from AWSCore::AwsApiJob
static Config *	GetDefaultConfig ()
Public Attributes inherited from AWSCore::AwsApiRequestJob< RequestTraits >
RequestType	request
ResultType	result
ErrorType	error
Protected Member Functions inherited from AWSCore::AwsApiRequestJob< RequestTraits >
void	Process () override
virtual bool	PrepareRequest ()
virtual void	OnSuccess ()
	Called when request has completed successfully.
virtual void	OnFailure ()
	Called when the request fails.
virtual void	DoCleanup ()
	Called when request can't process and still requires cleanup (Specifically for the derived class AwsApiRequestJob<RequestTraits>::Function which does not use auto delete)
Protected Member Functions inherited from AWSCore::AwsApiClientJob< RequestTraits::ClientType >
	AwsApiClientJob (bool isAutoDelete, IConfig *config=GetDefaultConfig())
Protected Member Functions inherited from AWSCore::AwsApiJob
	AwsApiJob (bool isAutoDelete, IConfig *config=GetDefaultConfig())
Protected Attributes inherited from AWSCore::AwsApiRequestJob< RequestTraits >
bool	m_wasSuccess { false }
Protected Attributes inherited from AWSCore::AwsApiClientJob< RequestTraits::ClientType >
std::shared_ptr< RequestTraits::ClientType >	m_client
Static Protected Attributes inherited from AWSCore::AwsApiJob
static const char *	COMPONENT_DISPLAY_NAME
	Used for error messages.

Detailed Description

template<class RequestTraits>
class AWSCore::AwsApiRequestJob< RequestTraits >::Function

A specialization of AwsApiRequestJob that lets you provide functions that are called on success or failure of the request.

---

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

• Gems/AWSCore/Code/Include/Framework/AWSApiRequestJob.h