Aws::Transfer::TransferRequest Class Reference

#include <TransferRequest.h>

Inherits Aws::AmazonSerializableWebServiceRequest.

Inherited by Aws::Transfer::Model::CreateAccessRequest, Aws::Transfer::Model::CreateAgreementRequest, Aws::Transfer::Model::CreateConnectorRequest, Aws::Transfer::Model::CreateProfileRequest, Aws::Transfer::Model::CreateServerRequest, Aws::Transfer::Model::CreateUserRequest, Aws::Transfer::Model::CreateWorkflowRequest, Aws::Transfer::Model::DeleteAccessRequest, Aws::Transfer::Model::DeleteAgreementRequest, Aws::Transfer::Model::DeleteCertificateRequest, Aws::Transfer::Model::DeleteConnectorRequest, Aws::Transfer::Model::DeleteHostKeyRequest, Aws::Transfer::Model::DeleteProfileRequest, Aws::Transfer::Model::DeleteServerRequest, Aws::Transfer::Model::DeleteSshPublicKeyRequest, Aws::Transfer::Model::DeleteUserRequest, Aws::Transfer::Model::DeleteWorkflowRequest, Aws::Transfer::Model::DescribeAccessRequest, Aws::Transfer::Model::DescribeAgreementRequest, Aws::Transfer::Model::DescribeCertificateRequest, Aws::Transfer::Model::DescribeConnectorRequest, Aws::Transfer::Model::DescribeExecutionRequest, Aws::Transfer::Model::DescribeHostKeyRequest, Aws::Transfer::Model::DescribeProfileRequest, Aws::Transfer::Model::DescribeSecurityPolicyRequest, Aws::Transfer::Model::DescribeServerRequest, Aws::Transfer::Model::DescribeUserRequest, Aws::Transfer::Model::DescribeWorkflowRequest, Aws::Transfer::Model::ImportCertificateRequest, Aws::Transfer::Model::ImportHostKeyRequest, Aws::Transfer::Model::ImportSshPublicKeyRequest, Aws::Transfer::Model::ListAccessesRequest, Aws::Transfer::Model::ListAgreementsRequest, Aws::Transfer::Model::ListCertificatesRequest, Aws::Transfer::Model::ListConnectorsRequest, Aws::Transfer::Model::ListExecutionsRequest, Aws::Transfer::Model::ListFileTransferResultsRequest, Aws::Transfer::Model::ListHostKeysRequest, Aws::Transfer::Model::ListProfilesRequest, Aws::Transfer::Model::ListSecurityPoliciesRequest, Aws::Transfer::Model::ListServersRequest, Aws::Transfer::Model::ListTagsForResourceRequest, Aws::Transfer::Model::ListUsersRequest, Aws::Transfer::Model::ListWorkflowsRequest, Aws::Transfer::Model::SendWorkflowStepStateRequest, Aws::Transfer::Model::StartDirectoryListingRequest, Aws::Transfer::Model::StartFileTransferRequest, Aws::Transfer::Model::StartServerRequest, Aws::Transfer::Model::StopServerRequest, Aws::Transfer::Model::TagResourceRequest, Aws::Transfer::Model::TestConnectionRequest, Aws::Transfer::Model::TestIdentityProviderRequest, Aws::Transfer::Model::UntagResourceRequest, Aws::Transfer::Model::UpdateAccessRequest, Aws::Transfer::Model::UpdateAgreementRequest, Aws::Transfer::Model::UpdateCertificateRequest, Aws::Transfer::Model::UpdateConnectorRequest, Aws::Transfer::Model::UpdateHostKeyRequest, Aws::Transfer::Model::UpdateProfileRequest, Aws::Transfer::Model::UpdateServerRequest, and Aws::Transfer::Model::UpdateUserRequest.

Public Types

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Public Member Functions

virtual ~TransferRequest ()

 

void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const

 

Aws::Http::HeaderValueCollection GetHeaders () const override

 

Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest

 AmazonSerializableWebServiceRequest ()

 

virtual ~AmazonSerializableWebServiceRequest ()

 

virtual Aws::String SerializePayload () const=0

 

std::shared_ptr< Aws::IOStream > GetBody () const override

 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

virtual void AddQueryStringParameters (Aws::Http::URI &uri) const

 

virtual void PutToPresignedUrl (Aws::Http::URI &uri) const

 

virtual bool IsStreaming () const

 

virtual bool IsEventStreamRequest () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual const char * GetServiceRequestName () const=0

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Protected Member Functions

virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const

 

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

virtual void DumpBodyToUrl (Aws::Http::URI &uri) const

 

Additional Inherited Members

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 17 of file TransferRequest.h.

Member Typedef Documentation

EndpointParameter

using Aws::Transfer::TransferRequest::EndpointParameter = Aws::Endpoint::EndpointParameter

Definition at line 20 of file TransferRequest.h.

EndpointParameters

using Aws::Transfer::TransferRequest::EndpointParameters = Aws::Endpoint::EndpointParameters

Definition at line 21 of file TransferRequest.h.

Constructor & Destructor Documentation

~TransferRequest()

virtual Aws::Transfer::TransferRequest::~TransferRequest ( )

inlinevirtual

Definition at line 23 of file TransferRequest.h.

Member Function Documentation

AddParametersToRequest()

void Aws::Transfer::TransferRequest::AddParametersToRequest ( Aws::Http::HttpRequest &  httpRequest) const

inline

Definition at line 25 of file TransferRequest.h.

GetHeaders()

Aws::Http::HeaderValueCollection Aws::Transfer::TransferRequest::GetHeaders ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 27 of file TransferRequest.h.

GetRequestSpecificHeaders()

virtual Aws::Http::HeaderValueCollection Aws::Transfer::TransferRequest::GetRequestSpecificHeaders ( ) const

inlineprotectedvirtual

Reimplemented in Aws::Transfer::Model::CreateAccessRequest, Aws::Transfer::Model::CreateAgreementRequest, Aws::Transfer::Model::CreateConnectorRequest, Aws::Transfer::Model::CreateProfileRequest, Aws::Transfer::Model::CreateServerRequest, Aws::Transfer::Model::CreateUserRequest, Aws::Transfer::Model::CreateWorkflowRequest, Aws::Transfer::Model::DeleteAccessRequest, Aws::Transfer::Model::DeleteAgreementRequest, Aws::Transfer::Model::DeleteCertificateRequest, Aws::Transfer::Model::DeleteConnectorRequest, Aws::Transfer::Model::DeleteHostKeyRequest, Aws::Transfer::Model::DeleteProfileRequest, Aws::Transfer::Model::DeleteServerRequest, Aws::Transfer::Model::DeleteSshPublicKeyRequest, Aws::Transfer::Model::DeleteUserRequest, Aws::Transfer::Model::DeleteWorkflowRequest, Aws::Transfer::Model::DescribeAccessRequest, Aws::Transfer::Model::DescribeAgreementRequest, Aws::Transfer::Model::DescribeCertificateRequest, Aws::Transfer::Model::DescribeConnectorRequest, Aws::Transfer::Model::DescribeExecutionRequest, Aws::Transfer::Model::DescribeHostKeyRequest, Aws::Transfer::Model::DescribeProfileRequest, Aws::Transfer::Model::DescribeSecurityPolicyRequest, Aws::Transfer::Model::DescribeServerRequest, Aws::Transfer::Model::DescribeUserRequest, Aws::Transfer::Model::DescribeWorkflowRequest, Aws::Transfer::Model::ImportCertificateRequest, Aws::Transfer::Model::ImportHostKeyRequest, Aws::Transfer::Model::ImportSshPublicKeyRequest, Aws::Transfer::Model::ListAccessesRequest, Aws::Transfer::Model::ListAgreementsRequest, Aws::Transfer::Model::ListCertificatesRequest, Aws::Transfer::Model::ListConnectorsRequest, Aws::Transfer::Model::ListExecutionsRequest, Aws::Transfer::Model::ListFileTransferResultsRequest, Aws::Transfer::Model::ListHostKeysRequest, Aws::Transfer::Model::ListProfilesRequest, Aws::Transfer::Model::ListSecurityPoliciesRequest, Aws::Transfer::Model::ListServersRequest, Aws::Transfer::Model::ListTagsForResourceRequest, Aws::Transfer::Model::ListUsersRequest, Aws::Transfer::Model::ListWorkflowsRequest, Aws::Transfer::Model::SendWorkflowStepStateRequest, Aws::Transfer::Model::StartDirectoryListingRequest, Aws::Transfer::Model::StartFileTransferRequest, Aws::Transfer::Model::StartServerRequest, Aws::Transfer::Model::StopServerRequest, Aws::Transfer::Model::TagResourceRequest, Aws::Transfer::Model::TestConnectionRequest, Aws::Transfer::Model::TestIdentityProviderRequest, Aws::Transfer::Model::UntagResourceRequest, Aws::Transfer::Model::UpdateAccessRequest, Aws::Transfer::Model::UpdateAgreementRequest, Aws::Transfer::Model::UpdateCertificateRequest, Aws::Transfer::Model::UpdateConnectorRequest, Aws::Transfer::Model::UpdateHostKeyRequest, Aws::Transfer::Model::UpdateProfileRequest, Aws::Transfer::Model::UpdateServerRequest, and Aws::Transfer::Model::UpdateUserRequest.

Definition at line 40 of file TransferRequest.h.

---

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

• generated/src/aws-cpp-sdk-awstransfer/include/aws/awstransfer/TransferRequest.h