Aws::Endpoint::EndpointProviderBase< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT > Class Template Reference

#include <EndpointProviderBase.h>

Inheritance diagram for Aws::Endpoint::EndpointProviderBase< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >:

Public Types

using BuiltInParameters = BuiltInParametersT

 

using ClientContextParameters = ClientContextParametersT

 

Public Member Functions

virtual ~EndpointProviderBase ()=default

 

virtual void InitBuiltInParameters (const ClientConfigurationT &config)=0

 

virtual void InitBuiltInParameters (const ClientConfigurationT &config, const Aws::String &serviceName)

 

virtual void OverrideEndpoint (const Aws::String &endpoint)=0

 

virtual ClientContextParametersT & AccessClientContextParameters ()=0

 

virtual const ClientContextParametersT & GetClientContextParameters () const =0

 

virtual ResolveEndpointOutcome ResolveEndpoint (const EndpointParameters &endpointParameters) const =0

 

Detailed Description

template<typename ClientConfigurationT = Aws::Client::GenericClientConfiguration, typename BuiltInParametersT = Aws::Endpoint::BuiltInParameters, typename ClientContextParametersT = Aws::Endpoint::ClientContextParameters>
class Aws::Endpoint::EndpointProviderBase< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >

EndpointProviderBase is an interface definition that resolves the provided EndpointParameters to either an Endpoint or an error. This Base class represents a min interface required to be implemented to override an endpoint provider.

Definition at line 39 of file EndpointProviderBase.h.

Member Typedef Documentation

BuiltInParameters

template<typename ClientConfigurationT = Aws::Client::GenericClientConfiguration, typename BuiltInParametersT = Aws::Endpoint::BuiltInParameters, typename ClientContextParametersT = Aws::Endpoint::ClientContextParameters>

using Aws::Endpoint::EndpointProviderBase< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >::BuiltInParameters = BuiltInParametersT

Definition at line 42 of file EndpointProviderBase.h.

ClientContextParameters

template<typename ClientConfigurationT = Aws::Client::GenericClientConfiguration, typename BuiltInParametersT = Aws::Endpoint::BuiltInParameters, typename ClientContextParametersT = Aws::Endpoint::ClientContextParameters>

using Aws::Endpoint::EndpointProviderBase< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >::ClientContextParameters = ClientContextParametersT

Definition at line 43 of file EndpointProviderBase.h.

Constructor & Destructor Documentation

~EndpointProviderBase()

template<typename ClientConfigurationT = Aws::Client::GenericClientConfiguration, typename BuiltInParametersT = Aws::Endpoint::BuiltInParameters, typename ClientContextParametersT = Aws::Endpoint::ClientContextParameters>

virtual Aws::Endpoint::EndpointProviderBase< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >::~EndpointProviderBase ( )

virtualdefault

Member Function Documentation

AccessClientContextParameters()

template<typename ClientConfigurationT = Aws::Client::GenericClientConfiguration, typename BuiltInParametersT = Aws::Endpoint::BuiltInParameters, typename ClientContextParametersT = Aws::Endpoint::ClientContextParameters>

virtual ClientContextParametersT & Aws::Endpoint::EndpointProviderBase< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >::AccessClientContextParameters ( )

pure virtual

Method for write access to Client Context Parameters (i.e. configurable service-specific parameters)

Implemented in Aws::Endpoint::DefaultEndpointProvider< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >.

GetClientContextParameters()

template<typename ClientConfigurationT = Aws::Client::GenericClientConfiguration, typename BuiltInParametersT = Aws::Endpoint::BuiltInParameters, typename ClientContextParametersT = Aws::Endpoint::ClientContextParameters>

virtual const ClientContextParametersT & Aws::Endpoint::EndpointProviderBase< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >::GetClientContextParameters ( ) const

pure virtual

Method for read-only access to Client Context Parameters (i.e. configurable service-specific parameters)

Implemented in Aws::Endpoint::DefaultEndpointProvider< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >.

InitBuiltInParameters() [1/2]

template<typename ClientConfigurationT = Aws::Client::GenericClientConfiguration, typename BuiltInParametersT = Aws::Endpoint::BuiltInParameters, typename ClientContextParametersT = Aws::Endpoint::ClientContextParameters>

virtual void Aws::Endpoint::EndpointProviderBase< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >::InitBuiltInParameters ( const ClientConfigurationT &  config)

pure virtual

Initialize client context parameters from a ClientConfiguration

Implemented in Aws::Endpoint::DefaultEndpointProvider< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >.

InitBuiltInParameters() [2/2]

template<typename ClientConfigurationT = Aws::Client::GenericClientConfiguration, typename BuiltInParametersT = Aws::Endpoint::BuiltInParameters, typename ClientContextParametersT = Aws::Endpoint::ClientContextParameters>

virtual void Aws::Endpoint::EndpointProviderBase< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >::InitBuiltInParameters ( const ClientConfigurationT &  config,

const Aws::String &  serviceName 

)

inlinevirtual

Initialize client context parameters from a ClientConfiguration with service name

Reimplemented in Aws::Endpoint::DefaultEndpointProvider< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >.

Definition at line 55 of file EndpointProviderBase.h.

OverrideEndpoint()

template<typename ClientConfigurationT = Aws::Client::GenericClientConfiguration, typename BuiltInParametersT = Aws::Endpoint::BuiltInParameters, typename ClientContextParametersT = Aws::Endpoint::ClientContextParameters>

virtual void Aws::Endpoint::EndpointProviderBase< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >::OverrideEndpoint ( const Aws::String &  endpoint)

pure virtual

Function to override endpoint, i.e. to set built-in parameter "AWS::Endpoint"

Implemented in Aws::Endpoint::DefaultEndpointProvider< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >.

ResolveEndpoint()

template<typename ClientConfigurationT = Aws::Client::GenericClientConfiguration, typename BuiltInParametersT = Aws::Endpoint::BuiltInParameters, typename ClientContextParametersT = Aws::Endpoint::ClientContextParameters>

virtual ResolveEndpointOutcome Aws::Endpoint::EndpointProviderBase< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >::ResolveEndpoint ( const EndpointParameters &  endpointParameters) const

pure virtual

The core of the endpoint provider interface.

Implemented in Aws::Endpoint::DefaultEndpointProvider< ClientConfigurationT, BuiltInParametersT, ClientContextParametersT >.

---

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

• src/aws-cpp-sdk-core/include/aws/core/endpoint/EndpointProviderBase.h