AWS SDK for C++  1.9.153
AWS SDK for C++
Public Member Functions | List of all members
Aws::Transfer::Model::CreateWorkflowRequest Class Reference

#include <CreateWorkflowRequest.h>

+ Inheritance diagram for Aws::Transfer::Model::CreateWorkflowRequest:

Public Member Functions

 CreateWorkflowRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateWorkflowRequestWithDescription (const Aws::String &value)
 
CreateWorkflowRequestWithDescription (Aws::String &&value)
 
CreateWorkflowRequestWithDescription (const char *value)
 
const Aws::Vector< WorkflowStep > & GetSteps () const
 
bool StepsHasBeenSet () const
 
void SetSteps (const Aws::Vector< WorkflowStep > &value)
 
void SetSteps (Aws::Vector< WorkflowStep > &&value)
 
CreateWorkflowRequestWithSteps (const Aws::Vector< WorkflowStep > &value)
 
CreateWorkflowRequestWithSteps (Aws::Vector< WorkflowStep > &&value)
 
CreateWorkflowRequestAddSteps (const WorkflowStep &value)
 
CreateWorkflowRequestAddSteps (WorkflowStep &&value)
 
const Aws::Vector< WorkflowStep > & GetOnExceptionSteps () const
 
bool OnExceptionStepsHasBeenSet () const
 
void SetOnExceptionSteps (const Aws::Vector< WorkflowStep > &value)
 
void SetOnExceptionSteps (Aws::Vector< WorkflowStep > &&value)
 
CreateWorkflowRequestWithOnExceptionSteps (const Aws::Vector< WorkflowStep > &value)
 
CreateWorkflowRequestWithOnExceptionSteps (Aws::Vector< WorkflowStep > &&value)
 
CreateWorkflowRequestAddOnExceptionSteps (const WorkflowStep &value)
 
CreateWorkflowRequestAddOnExceptionSteps (WorkflowStep &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateWorkflowRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateWorkflowRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateWorkflowRequestAddTags (const Tag &value)
 
CreateWorkflowRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::Transfer::TransferRequest
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 ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
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 IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file CreateWorkflowRequest.h.

Constructor & Destructor Documentation

◆ CreateWorkflowRequest()

Aws::Transfer::Model::CreateWorkflowRequest::CreateWorkflowRequest ( )

Member Function Documentation

◆ AddOnExceptionSteps() [1/2]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::AddOnExceptionSteps ( const WorkflowStep value)
inline

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

Definition at line 239 of file CreateWorkflowRequest.h.

◆ AddOnExceptionSteps() [2/2]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::AddOnExceptionSteps ( WorkflowStep &&  value)
inline

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

Definition at line 248 of file CreateWorkflowRequest.h.

◆ AddSteps() [1/2]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::AddSteps ( const WorkflowStep value)
inline

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

  • Copy: copy the file to another location

  • Custom: custom step with a lambda target

  • Delete: delete the file

  • Tag: add a tag to the file

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.

Definition at line 163 of file CreateWorkflowRequest.h.

◆ AddSteps() [2/2]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::AddSteps ( WorkflowStep &&  value)
inline

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

  • Copy: copy the file to another location

  • Custom: custom step with a lambda target

  • Delete: delete the file

  • Tag: add a tag to the file

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.

Definition at line 175 of file CreateWorkflowRequest.h.

◆ AddTags() [1/2]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::AddTags ( const Tag value)
inline

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Definition at line 291 of file CreateWorkflowRequest.h.

◆ AddTags() [2/2]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::AddTags ( Tag &&  value)
inline

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Definition at line 297 of file CreateWorkflowRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::Transfer::Model::CreateWorkflowRequest::DescriptionHasBeenSet ( ) const
inline

A textual description for the workflow.

Definition at line 48 of file CreateWorkflowRequest.h.

◆ GetDescription()

const Aws::String& Aws::Transfer::Model::CreateWorkflowRequest::GetDescription ( ) const
inline

A textual description for the workflow.

Definition at line 43 of file CreateWorkflowRequest.h.

◆ GetOnExceptionSteps()

const Aws::Vector<WorkflowStep>& Aws::Transfer::Model::CreateWorkflowRequest::GetOnExceptionSteps ( ) const
inline

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

Definition at line 185 of file CreateWorkflowRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Transfer::Model::CreateWorkflowRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Transfer::TransferRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Transfer::Model::CreateWorkflowRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateWorkflowRequest.h.

◆ GetSteps()

const Aws::Vector<WorkflowStep>& Aws::Transfer::Model::CreateWorkflowRequest::GetSteps ( ) const
inline

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

  • Copy: copy the file to another location

  • Custom: custom step with a lambda target

  • Delete: delete the file

  • Tag: add a tag to the file

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.

Definition at line 91 of file CreateWorkflowRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::Transfer::Model::CreateWorkflowRequest::GetTags ( ) const
inline

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Definition at line 255 of file CreateWorkflowRequest.h.

◆ OnExceptionStepsHasBeenSet()

bool Aws::Transfer::Model::CreateWorkflowRequest::OnExceptionStepsHasBeenSet ( ) const
inline

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

Definition at line 194 of file CreateWorkflowRequest.h.

◆ SerializePayload()

Aws::String Aws::Transfer::Model::CreateWorkflowRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

void Aws::Transfer::Model::CreateWorkflowRequest::SetDescription ( Aws::String &&  value)
inline

A textual description for the workflow.

Definition at line 58 of file CreateWorkflowRequest.h.

◆ SetDescription() [2/3]

void Aws::Transfer::Model::CreateWorkflowRequest::SetDescription ( const Aws::String value)
inline

A textual description for the workflow.

Definition at line 53 of file CreateWorkflowRequest.h.

◆ SetDescription() [3/3]

void Aws::Transfer::Model::CreateWorkflowRequest::SetDescription ( const char *  value)
inline

A textual description for the workflow.

Definition at line 63 of file CreateWorkflowRequest.h.

◆ SetOnExceptionSteps() [1/2]

void Aws::Transfer::Model::CreateWorkflowRequest::SetOnExceptionSteps ( Aws::Vector< WorkflowStep > &&  value)
inline

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

Definition at line 212 of file CreateWorkflowRequest.h.

◆ SetOnExceptionSteps() [2/2]

void Aws::Transfer::Model::CreateWorkflowRequest::SetOnExceptionSteps ( const Aws::Vector< WorkflowStep > &  value)
inline

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

Definition at line 203 of file CreateWorkflowRequest.h.

◆ SetSteps() [1/2]

void Aws::Transfer::Model::CreateWorkflowRequest::SetSteps ( Aws::Vector< WorkflowStep > &&  value)
inline

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

  • Copy: copy the file to another location

  • Custom: custom step with a lambda target

  • Delete: delete the file

  • Tag: add a tag to the file

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.

Definition at line 127 of file CreateWorkflowRequest.h.

◆ SetSteps() [2/2]

void Aws::Transfer::Model::CreateWorkflowRequest::SetSteps ( const Aws::Vector< WorkflowStep > &  value)
inline

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

  • Copy: copy the file to another location

  • Custom: custom step with a lambda target

  • Delete: delete the file

  • Tag: add a tag to the file

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.

Definition at line 115 of file CreateWorkflowRequest.h.

◆ SetTags() [1/2]

void Aws::Transfer::Model::CreateWorkflowRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Definition at line 273 of file CreateWorkflowRequest.h.

◆ SetTags() [2/2]

void Aws::Transfer::Model::CreateWorkflowRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Definition at line 267 of file CreateWorkflowRequest.h.

◆ StepsHasBeenSet()

bool Aws::Transfer::Model::CreateWorkflowRequest::StepsHasBeenSet ( ) const
inline

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

  • Copy: copy the file to another location

  • Custom: custom step with a lambda target

  • Delete: delete the file

  • Tag: add a tag to the file

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.

Definition at line 103 of file CreateWorkflowRequest.h.

◆ TagsHasBeenSet()

bool Aws::Transfer::Model::CreateWorkflowRequest::TagsHasBeenSet ( ) const
inline

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Definition at line 261 of file CreateWorkflowRequest.h.

◆ WithDescription() [1/3]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::WithDescription ( Aws::String &&  value)
inline

A textual description for the workflow.

Definition at line 73 of file CreateWorkflowRequest.h.

◆ WithDescription() [2/3]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::WithDescription ( const Aws::String value)
inline

A textual description for the workflow.

Definition at line 68 of file CreateWorkflowRequest.h.

◆ WithDescription() [3/3]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::WithDescription ( const char *  value)
inline

A textual description for the workflow.

Definition at line 78 of file CreateWorkflowRequest.h.

◆ WithOnExceptionSteps() [1/2]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::WithOnExceptionSteps ( Aws::Vector< WorkflowStep > &&  value)
inline

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

Definition at line 230 of file CreateWorkflowRequest.h.

◆ WithOnExceptionSteps() [2/2]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::WithOnExceptionSteps ( const Aws::Vector< WorkflowStep > &  value)
inline

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

Definition at line 221 of file CreateWorkflowRequest.h.

◆ WithSteps() [1/2]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::WithSteps ( Aws::Vector< WorkflowStep > &&  value)
inline

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

  • Copy: copy the file to another location

  • Custom: custom step with a lambda target

  • Delete: delete the file

  • Tag: add a tag to the file

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.

Definition at line 151 of file CreateWorkflowRequest.h.

◆ WithSteps() [2/2]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::WithSteps ( const Aws::Vector< WorkflowStep > &  value)
inline

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

  • Copy: copy the file to another location

  • Custom: custom step with a lambda target

  • Delete: delete the file

  • Tag: add a tag to the file

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.

Definition at line 139 of file CreateWorkflowRequest.h.

◆ WithTags() [1/2]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Definition at line 285 of file CreateWorkflowRequest.h.

◆ WithTags() [2/2]

CreateWorkflowRequest& Aws::Transfer::Model::CreateWorkflowRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Definition at line 279 of file CreateWorkflowRequest.h.


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