Aws::Internal::AWSHttpResourceClient Class Reference

#include <AWSHttpResourceClient.h>

Inheritance diagram for Aws::Internal::AWSHttpResourceClient:

Public Member Functions

 AWSHttpResourceClient (const char *logtag="AWSHttpResourceClient")

 

 AWSHttpResourceClient (const Client::ClientConfiguration &clientConfiguration, const char *logtag="AWSHttpResourceClient")

 

AWSHttpResourceClient & operator= (const AWSHttpResourceClient &rhs)=delete

 

 AWSHttpResourceClient (const AWSHttpResourceClient &rhs)=delete

 

AWSHttpResourceClient & operator= (const AWSHttpResourceClient &&rhs)=delete

 

 AWSHttpResourceClient (const AWSHttpResourceClient &&rhs)=delete

 

virtual ~AWSHttpResourceClient ()

 

virtual Aws::String GetResource (const char *endpoint, const char *resourcePath, const char *authToken) const

 

virtual AmazonWebServiceResult< Aws::String > GetResourceWithAWSWebServiceResult (const char *endpoint, const char *resourcePath, const char *authToken) const

 

virtual AmazonWebServiceResult< Aws::String > GetResourceWithAWSWebServiceResult (const std::shared_ptr< Http::HttpRequest > &httpRequest) const

 

void SetErrorMarshaller (Aws::UniquePtr< Client::AWSErrorMarshaller > errorMarshaller)

 

const Client::AWSErrorMarshaller * GetErrorMarshaller () const

 

Protected Attributes

Aws::String m_logtag

 

Aws::String m_userAgent

 

Detailed Description

Simple client for accessing the AWS remote data by Http. Currently we use it to access EC2 Metadata and ECS Credential.

Definition at line 33 of file AWSHttpResourceClient.h.

Constructor & Destructor Documentation

AWSHttpResourceClient() [1/4]

Aws::Internal::AWSHttpResourceClient::AWSHttpResourceClient ( const char *  logtag = "AWSHttpResourceClient")

Builds an AWSHttpResourceClient instance by using default http stack.

AWSHttpResourceClient() [2/4]

Aws::Internal::AWSHttpResourceClient::AWSHttpResourceClient ( const Client::ClientConfiguration &  clientConfiguration,

const char *  logtag = "AWSHttpResourceClient" 

)

AWSHttpResourceClient() [3/4]

Aws::Internal::AWSHttpResourceClient::AWSHttpResourceClient ( const AWSHttpResourceClient &  rhs)

delete

AWSHttpResourceClient() [4/4]

Aws::Internal::AWSHttpResourceClient::AWSHttpResourceClient ( const AWSHttpResourceClient &&  rhs)

delete

~AWSHttpResourceClient()

virtual Aws::Internal::AWSHttpResourceClient::~AWSHttpResourceClient ( )

virtual

Member Function Documentation

GetErrorMarshaller()

const Client::AWSErrorMarshaller * Aws::Internal::AWSHttpResourceClient::GetErrorMarshaller ( ) const

inline

Definition at line 83 of file AWSHttpResourceClient.h.

GetResource()

virtual Aws::String Aws::Internal::AWSHttpResourceClient::GetResource ( const char *  endpoint,

const char *  resourcePath,

const char *  authToken 

) const

virtual

Connects to an HTTP endpoint to read the specified resource and returns the text contents. The resource URI = endpoint + resourcePath (e.g:http://domain/path/to/res)

Parameters

endpoint	The HTTP resource to connect to.
resourcePath	A path appended to the endpoint to form the final URI.
authToken	An optional authorization token that will be passed as the value of the HTTP header 'Authorization'.

Returns

The response from the HTTP endpoint as a string.

Reimplemented in Aws::Internal::EC2MetadataClient.

GetResourceWithAWSWebServiceResult() [1/2]

virtual AmazonWebServiceResult< Aws::String > Aws::Internal::AWSHttpResourceClient::GetResourceWithAWSWebServiceResult ( const char *  endpoint,

const char *  resourcePath,

const char *  authToken 

) const

virtual

Connects to an HTTP endpoint to read the specified resource and returns the text contents. The resource URI = endpoint + resourcePath (e.g:http://domain/path/to/res)

Parameters

endpoint	The HTTP resource to connect to.
resourcePath	A path appended to the endpoint to form the final URI.
authToken	An optional authorization token that will be passed as the value of the HTTP header 'Authorization'.

Returns

The response from the HTTP endpoint as a string, together with the http response code.

GetResourceWithAWSWebServiceResult() [2/2]

virtual AmazonWebServiceResult< Aws::String > Aws::Internal::AWSHttpResourceClient::GetResourceWithAWSWebServiceResult ( const std::shared_ptr< Http::HttpRequest > &  httpRequest) const

virtual

Above Function: Aws::String GetResource(const char* endpoint, const char* resourcePath, const char* authToken) const; is limited to HTTP GET method and caller can't add wanted HTTP headers as well. This overload gives caller the flexibility to manipulate the request, as well returns the HttpResponseCode of the last attempt.

operator=() [1/2]

AWSHttpResourceClient & Aws::Internal::AWSHttpResourceClient::operator= ( const AWSHttpResourceClient &&  rhs)

delete

operator=() [2/2]

AWSHttpResourceClient & Aws::Internal::AWSHttpResourceClient::operator= ( const AWSHttpResourceClient &  rhs)

delete

SetErrorMarshaller()

void Aws::Internal::AWSHttpResourceClient::SetErrorMarshaller ( Aws::UniquePtr< Client::AWSErrorMarshaller >  errorMarshaller)

inline

Set an error marshaller so as to marshall error type from http response body if any. So that it can work with retry strategy to decide if a request should retry or not.

Definition at line 82 of file AWSHttpResourceClient.h.

Member Data Documentation

m_logtag

Aws::String Aws::Internal::AWSHttpResourceClient::m_logtag

protected

Definition at line 86 of file AWSHttpResourceClient.h.

m_userAgent

Aws::String Aws::Internal::AWSHttpResourceClient::m_userAgent

protected

Definition at line 87 of file AWSHttpResourceClient.h.

---

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

• src/aws-cpp-sdk-core/include/aws/core/internal/AWSHttpResourceClient.h