Provides service job configuration using settings properties.
More...
#include <HttpRequestJobConfig.h>
Inherits AWSCore::AwsApiJobConfig, and AWSCore::IHttpRequestJobConfig.
Inherited by AWSCore::ServiceJobConfig.
|
using | InitializerFunction = AZStd::function< void(HttpRequestJobConfig &config)> |
|
using | InitializerFunction = AZStd::function< void(AwsApiJobConfig &config)> |
|
template<typename T > |
using | Override = AZStd::optional< T > |
| Type used to encapsulate override values.
|
|
|
| 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.
|
|
| 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 |
|
|
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 |
|
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 |
|
template<typename T > |
static void | CheckAndSet (const Override< T > &src, T &dst) |
| Helper function for applying Override typed members.
|
|
Provides service job configuration using settings properties.
◆ HttpRequestJobConfig()
AWSCore::HttpRequestJobConfig::HttpRequestJobConfig |
( |
AwsApiJobConfig * |
defaultConfig = nullptr , |
|
|
InitializerFunction |
initializer = nullptr |
|
) |
| |
|
inline |
Initialize an HttpRequestJobConfig 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. |
◆ ApplySettings()
void AWSCore::HttpRequestJobConfig::ApplySettings |
( |
| ) |
|
|
overridevirtual |
◆ GetHttpClient()
std::shared_ptr< Aws::Http::HttpClient > AWSCore::HttpRequestJobConfig::GetHttpClient |
( |
| ) |
|
|
inlineoverridevirtual |
◆ GetReadRateLimiter()
std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterface > AWSCore::HttpRequestJobConfig::GetReadRateLimiter |
( |
| ) |
|
|
inlineoverridevirtual |
◆ GetUserAgent()
const Aws::String & AWSCore::HttpRequestJobConfig::GetUserAgent |
( |
| ) |
|
|
inlineoverridevirtual |
◆ GetWriteRateLimiter()
std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterface > AWSCore::HttpRequestJobConfig::GetWriteRateLimiter |
( |
| ) |
|
|
inlineoverridevirtual |
The documentation for this class was generated from the following file:
- Gems/AWSCore/Code/Include/Framework/HttpRequestJobConfig.h