AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::CodePipeline::Model::StopPipelineExecutionRequest Class Reference

#include <StopPipelineExecutionRequest.h>

+ Inheritance diagram for Aws::CodePipeline::Model::StopPipelineExecutionRequest:

Public Member Functions

 StopPipelineExecutionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetPipelineName () const
 
bool PipelineNameHasBeenSet () const
 
void SetPipelineName (const Aws::String &value)
 
void SetPipelineName (Aws::String &&value)
 
void SetPipelineName (const char *value)
 
StopPipelineExecutionRequestWithPipelineName (const Aws::String &value)
 
StopPipelineExecutionRequestWithPipelineName (Aws::String &&value)
 
StopPipelineExecutionRequestWithPipelineName (const char *value)
 
const Aws::StringGetPipelineExecutionId () const
 
bool PipelineExecutionIdHasBeenSet () const
 
void SetPipelineExecutionId (const Aws::String &value)
 
void SetPipelineExecutionId (Aws::String &&value)
 
void SetPipelineExecutionId (const char *value)
 
StopPipelineExecutionRequestWithPipelineExecutionId (const Aws::String &value)
 
StopPipelineExecutionRequestWithPipelineExecutionId (Aws::String &&value)
 
StopPipelineExecutionRequestWithPipelineExecutionId (const char *value)
 
bool GetAbandon () const
 
bool AbandonHasBeenSet () const
 
void SetAbandon (bool value)
 
StopPipelineExecutionRequestWithAbandon (bool value)
 
const Aws::StringGetReason () const
 
bool ReasonHasBeenSet () const
 
void SetReason (const Aws::String &value)
 
void SetReason (Aws::String &&value)
 
void SetReason (const char *value)
 
StopPipelineExecutionRequestWithReason (const Aws::String &value)
 
StopPipelineExecutionRequestWithReason (Aws::String &&value)
 
StopPipelineExecutionRequestWithReason (const char *value)
 
- Public Member Functions inherited from Aws::CodePipeline::CodePipelineRequest
virtual ~CodePipelineRequest ()
 
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 21 of file StopPipelineExecutionRequest.h.

Constructor & Destructor Documentation

◆ StopPipelineExecutionRequest()

Aws::CodePipeline::Model::StopPipelineExecutionRequest::StopPipelineExecutionRequest ( )

Member Function Documentation

◆ AbandonHasBeenSet()

bool Aws::CodePipeline::Model::StopPipelineExecutionRequest::AbandonHasBeenSet ( ) const
inline

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

Definition at line 147 of file StopPipelineExecutionRequest.h.

◆ GetAbandon()

bool Aws::CodePipeline::Model::StopPipelineExecutionRequest::GetAbandon ( ) const
inline

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

Definition at line 140 of file StopPipelineExecutionRequest.h.

◆ GetPipelineExecutionId()

const Aws::String& Aws::CodePipeline::Model::StopPipelineExecutionRequest::GetPipelineExecutionId ( ) const
inline

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Definition at line 83 of file StopPipelineExecutionRequest.h.

◆ GetPipelineName()

const Aws::String& Aws::CodePipeline::Model::StopPipelineExecutionRequest::GetPipelineName ( ) const
inline

The name of the pipeline to stop.

Definition at line 40 of file StopPipelineExecutionRequest.h.

◆ GetReason()

const Aws::String& Aws::CodePipeline::Model::StopPipelineExecutionRequest::GetReason ( ) const
inline

Use this option to enter comments, such as the reason the pipeline was stopped.

Definition at line 168 of file StopPipelineExecutionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CodePipeline::Model::StopPipelineExecutionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CodePipeline::Model::StopPipelineExecutionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file StopPipelineExecutionRequest.h.

◆ PipelineExecutionIdHasBeenSet()

bool Aws::CodePipeline::Model::StopPipelineExecutionRequest::PipelineExecutionIdHasBeenSet ( ) const
inline

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Definition at line 90 of file StopPipelineExecutionRequest.h.

◆ PipelineNameHasBeenSet()

bool Aws::CodePipeline::Model::StopPipelineExecutionRequest::PipelineNameHasBeenSet ( ) const
inline

The name of the pipeline to stop.

Definition at line 45 of file StopPipelineExecutionRequest.h.

◆ ReasonHasBeenSet()

bool Aws::CodePipeline::Model::StopPipelineExecutionRequest::ReasonHasBeenSet ( ) const
inline

Use this option to enter comments, such as the reason the pipeline was stopped.

Definition at line 174 of file StopPipelineExecutionRequest.h.

◆ SerializePayload()

Aws::String Aws::CodePipeline::Model::StopPipelineExecutionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAbandon()

void Aws::CodePipeline::Model::StopPipelineExecutionRequest::SetAbandon ( bool  value)
inline

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

Definition at line 154 of file StopPipelineExecutionRequest.h.

◆ SetPipelineExecutionId() [1/3]

void Aws::CodePipeline::Model::StopPipelineExecutionRequest::SetPipelineExecutionId ( const Aws::String value)
inline

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Definition at line 97 of file StopPipelineExecutionRequest.h.

◆ SetPipelineExecutionId() [2/3]

void Aws::CodePipeline::Model::StopPipelineExecutionRequest::SetPipelineExecutionId ( Aws::String &&  value)
inline

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Definition at line 104 of file StopPipelineExecutionRequest.h.

◆ SetPipelineExecutionId() [3/3]

void Aws::CodePipeline::Model::StopPipelineExecutionRequest::SetPipelineExecutionId ( const char *  value)
inline

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Definition at line 111 of file StopPipelineExecutionRequest.h.

◆ SetPipelineName() [1/3]

void Aws::CodePipeline::Model::StopPipelineExecutionRequest::SetPipelineName ( const Aws::String value)
inline

The name of the pipeline to stop.

Definition at line 50 of file StopPipelineExecutionRequest.h.

◆ SetPipelineName() [2/3]

void Aws::CodePipeline::Model::StopPipelineExecutionRequest::SetPipelineName ( Aws::String &&  value)
inline

The name of the pipeline to stop.

Definition at line 55 of file StopPipelineExecutionRequest.h.

◆ SetPipelineName() [3/3]

void Aws::CodePipeline::Model::StopPipelineExecutionRequest::SetPipelineName ( const char *  value)
inline

The name of the pipeline to stop.

Definition at line 60 of file StopPipelineExecutionRequest.h.

◆ SetReason() [1/3]

void Aws::CodePipeline::Model::StopPipelineExecutionRequest::SetReason ( const Aws::String value)
inline

Use this option to enter comments, such as the reason the pipeline was stopped.

Definition at line 180 of file StopPipelineExecutionRequest.h.

◆ SetReason() [2/3]

void Aws::CodePipeline::Model::StopPipelineExecutionRequest::SetReason ( Aws::String &&  value)
inline

Use this option to enter comments, such as the reason the pipeline was stopped.

Definition at line 186 of file StopPipelineExecutionRequest.h.

◆ SetReason() [3/3]

void Aws::CodePipeline::Model::StopPipelineExecutionRequest::SetReason ( const char *  value)
inline

Use this option to enter comments, such as the reason the pipeline was stopped.

Definition at line 192 of file StopPipelineExecutionRequest.h.

◆ WithAbandon()

StopPipelineExecutionRequest& Aws::CodePipeline::Model::StopPipelineExecutionRequest::WithAbandon ( bool  value)
inline

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

Definition at line 161 of file StopPipelineExecutionRequest.h.

◆ WithPipelineExecutionId() [1/3]

StopPipelineExecutionRequest& Aws::CodePipeline::Model::StopPipelineExecutionRequest::WithPipelineExecutionId ( const Aws::String value)
inline

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Definition at line 118 of file StopPipelineExecutionRequest.h.

◆ WithPipelineExecutionId() [2/3]

StopPipelineExecutionRequest& Aws::CodePipeline::Model::StopPipelineExecutionRequest::WithPipelineExecutionId ( Aws::String &&  value)
inline

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Definition at line 125 of file StopPipelineExecutionRequest.h.

◆ WithPipelineExecutionId() [3/3]

StopPipelineExecutionRequest& Aws::CodePipeline::Model::StopPipelineExecutionRequest::WithPipelineExecutionId ( const char *  value)
inline

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Definition at line 132 of file StopPipelineExecutionRequest.h.

◆ WithPipelineName() [1/3]

StopPipelineExecutionRequest& Aws::CodePipeline::Model::StopPipelineExecutionRequest::WithPipelineName ( const Aws::String value)
inline

The name of the pipeline to stop.

Definition at line 65 of file StopPipelineExecutionRequest.h.

◆ WithPipelineName() [2/3]

StopPipelineExecutionRequest& Aws::CodePipeline::Model::StopPipelineExecutionRequest::WithPipelineName ( Aws::String &&  value)
inline

The name of the pipeline to stop.

Definition at line 70 of file StopPipelineExecutionRequest.h.

◆ WithPipelineName() [3/3]

StopPipelineExecutionRequest& Aws::CodePipeline::Model::StopPipelineExecutionRequest::WithPipelineName ( const char *  value)
inline

The name of the pipeline to stop.

Definition at line 75 of file StopPipelineExecutionRequest.h.

◆ WithReason() [1/3]

StopPipelineExecutionRequest& Aws::CodePipeline::Model::StopPipelineExecutionRequest::WithReason ( const Aws::String value)
inline

Use this option to enter comments, such as the reason the pipeline was stopped.

Definition at line 198 of file StopPipelineExecutionRequest.h.

◆ WithReason() [2/3]

StopPipelineExecutionRequest& Aws::CodePipeline::Model::StopPipelineExecutionRequest::WithReason ( Aws::String &&  value)
inline

Use this option to enter comments, such as the reason the pipeline was stopped.

Definition at line 204 of file StopPipelineExecutionRequest.h.

◆ WithReason() [3/3]

StopPipelineExecutionRequest& Aws::CodePipeline::Model::StopPipelineExecutionRequest::WithReason ( const char *  value)
inline

Use this option to enter comments, such as the reason the pipeline was stopped.

Definition at line 210 of file StopPipelineExecutionRequest.h.


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