Provides service job configuration using settings properties. More...

#include <ServiceClientJobConfig.h>

Inherits AWSCore::ServiceJobConfig, and AWSCore::IServiceClientJobConfig.

Public Types
using	ServiceClientJobConfigType = ServiceClientJobConfig< ServiceTraitsType >

using	InitializerFunction = AZStd::function< void(ServiceClientJobConfig &config)>

Public Types inherited from AWSCore::ServiceJobConfig
using	InitializerFunction = AZStd::function< void(ServiceJobConfig &config)>

Public Types inherited from AWSCore::HttpRequestJobConfig
using	InitializerFunction = AZStd::function< void(HttpRequestJobConfig &config)>

Public Types inherited from AWSCore::AwsApiJobConfig
using	InitializerFunction = AZStd::function< void(AwsApiJobConfig &config)>

template<typename T >
using	Override = AZStd::optional< T >
	Type used to encapsulate override values.

Public Member Functions
	AZ_CLASS_ALLOCATOR (ServiceClientJobConfig, AZ::SystemAllocator)

	ServiceClientJobConfig (AwsApiJobConfig *defaultConfig=nullptr, InitializerFunction initializer=nullptr)

AZStd::string	GetServiceUrl () override

Public Member Functions inherited from AWSCore::ServiceJobConfig
	AZ_CLASS_ALLOCATOR (ServiceJobConfig, AZ::SystemAllocator)

	ServiceJobConfig (AwsApiJobConfig *defaultConfig=nullptr, InitializerFunction initializer=nullptr)

void	ApplySettings () override
	Applies settings changes made after first use.

Public Member Functions inherited from AWSCore::HttpRequestJobConfig
	AZ_CLASS_ALLOCATOR (HttpRequestJobConfig, AZ::SystemAllocator)

	HttpRequestJobConfig (AwsApiJobConfig *defaultConfig=nullptr, InitializerFunction initializer=nullptr)

std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterface >	GetReadRateLimiter () override

std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterface >	GetWriteRateLimiter () override

std::shared_ptr< Aws::Http::HttpClient >	GetHttpClient () override

const Aws::String &	GetUserAgent () override

void	ApplySettings () override
	Applies settings changes made after first use.

Public Member Functions inherited from AWSCore::AwsApiJobConfig
	AZ_CLASS_ALLOCATOR (AwsApiJobConfig, AZ::SystemAllocator)

	AwsApiJobConfig (AwsApiJobConfig *defaultConfig=nullptr, InitializerFunction initializer=nullptr)

virtual void	ApplySettings ()
	Applies settings changes made after first use.

AZ::JobContext *	GetJobContext () override

Aws::Client::ClientConfiguration	GetClientConfiguration () const

virtual AZ::JobContext *	GetJobContext ()=0

virtual std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterface >	GetReadRateLimiter ()=0

virtual std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterface >	GetWriteRateLimiter ()=0

virtual std::shared_ptr< Aws::Http::HttpClient >	GetHttpClient ()=0

virtual const Aws::String &	GetUserAgent ()=0

virtual AZStd::string	GetServiceUrl ()=0

Additional Inherited Members
Public Attributes inherited from AWSCore::AwsApiJobConfig
Override< AZ::JobContext * >	jobContext

Override< std::shared_ptr< Aws::Auth::AWSCredentialsProvider > >	credentialsProvider

Override< Aws::String >	userAgent

Override< Aws::Http::Scheme >	scheme

Override< Aws::String >	region

Override< unsigned >	maxConnections

Override< long >	requestTimeoutMs

Override< long >	connectTimeoutMs

Override< std::shared_ptr< Aws::Client::RetryStrategy > >	retryStrategy

Override< Aws::String >	endpointOverride

Override< Aws::String >	proxyHost

Override< unsigned >	proxyPort

Override< Aws::String >	proxyUserName

Override< Aws::String >	proxyPassword

Override< std::shared_ptr< Aws::Utils::Threading::Executor > >	executor

Override< bool >	verifySSL

Override< std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterface > >	writeRateLimiter

Override< std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterface > >	readRateLimiter

Override< Aws::Http::TransferLibType >	httpLibOverride

Override< bool >	followRedirects

Override< Aws::String >	caFile

Protected Member Functions inherited from AWSCore::AwsApiJobConfig
void	EnsureSettingsApplied ()
	Ensures that ApplySettings has been called.

template<class ConfigType >
void	Visit (AZStd::function< void(const ConfigType &)> visitor) const

std::shared_ptr< Aws::Auth::AWSCredentialsProvider >	GetCredentialsProvider () const

Static Protected Member Functions inherited from AWSCore::AwsApiJobConfig
template<typename T >
static void	CheckAndSet (const Override< T > &src, T &dst)
	Helper function for applying Override typed members.

Detailed Description

template<class ServiceTraitsType>
class AWSCore::ServiceClientJobConfig< ServiceTraitsType >

Provides service job configuration using settings properties.

Constructor & Destructor Documentation

◆ ServiceClientJobConfig()

template<class ServiceTraitsType >

AWSCore::ServiceClientJobConfig< ServiceTraitsType >::ServiceClientJobConfig	(	AwsApiJobConfig *	defaultConfig = `nullptr`,
		InitializerFunction	initializer = `nullptr`
	)

inline

Initialize an ServiceClientJobConfig object.

Parameters

defaultConfig	- the config object that provides values when no override has been set in this object. The default is nullptr, which will cause a default value to be used.
initializer	- a function called to initialize this object. This simplifies the initialization of static instances. The default value is nullptr, in which case no initializer will be called.

Member Function Documentation

◆ GetServiceUrl()

template<class ServiceTraitsType >

AZStd::string AWSCore::ServiceClientJobConfig< ServiceTraitsType >::GetServiceUrl ( )

inlineoverridevirtual

This implementation assumes the caller will cache this value as needed. See it's use in ServiceRequestJobConfig.

Implements AWSCore::IServiceClientJobConfig.

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

Gems/AWSCore/Code/Include/Framework/ServiceClientJobConfig.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ServiceClientJobConfig()

Member Function Documentation

◆ GetServiceUrl()