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

#include <DeactivatePipelineRequest.h>

+ Inheritance diagram for Aws::DataPipeline::Model::DeactivatePipelineRequest:

Public Member Functions

 DeactivatePipelineRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetPipelineId () const
 
bool PipelineIdHasBeenSet () const
 
void SetPipelineId (const Aws::String &value)
 
void SetPipelineId (Aws::String &&value)
 
void SetPipelineId (const char *value)
 
DeactivatePipelineRequestWithPipelineId (const Aws::String &value)
 
DeactivatePipelineRequestWithPipelineId (Aws::String &&value)
 
DeactivatePipelineRequestWithPipelineId (const char *value)
 
bool GetCancelActive () const
 
bool CancelActiveHasBeenSet () const
 
void SetCancelActive (bool value)
 
DeactivatePipelineRequestWithCancelActive (bool value)
 
- Public Member Functions inherited from Aws::DataPipeline::DataPipelineRequest
virtual ~DataPipelineRequest ()
 
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

Contains the parameters for DeactivatePipeline.

See Also:

AWS API Reference

Definition at line 24 of file DeactivatePipelineRequest.h.

Constructor & Destructor Documentation

◆ DeactivatePipelineRequest()

Aws::DataPipeline::Model::DeactivatePipelineRequest::DeactivatePipelineRequest ( )

Member Function Documentation

◆ CancelActiveHasBeenSet()

bool Aws::DataPipeline::Model::DeactivatePipelineRequest::CancelActiveHasBeenSet ( ) const
inline

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Definition at line 93 of file DeactivatePipelineRequest.h.

◆ GetCancelActive()

bool Aws::DataPipeline::Model::DeactivatePipelineRequest::GetCancelActive ( ) const
inline

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Definition at line 86 of file DeactivatePipelineRequest.h.

◆ GetPipelineId()

const Aws::String& Aws::DataPipeline::Model::DeactivatePipelineRequest::GetPipelineId ( ) const
inline

The ID of the pipeline.

Definition at line 43 of file DeactivatePipelineRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DataPipeline::Model::DeactivatePipelineRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::DataPipeline::Model::DeactivatePipelineRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file DeactivatePipelineRequest.h.

◆ PipelineIdHasBeenSet()

bool Aws::DataPipeline::Model::DeactivatePipelineRequest::PipelineIdHasBeenSet ( ) const
inline

The ID of the pipeline.

Definition at line 48 of file DeactivatePipelineRequest.h.

◆ SerializePayload()

Aws::String Aws::DataPipeline::Model::DeactivatePipelineRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCancelActive()

void Aws::DataPipeline::Model::DeactivatePipelineRequest::SetCancelActive ( bool  value)
inline

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Definition at line 100 of file DeactivatePipelineRequest.h.

◆ SetPipelineId() [1/3]

void Aws::DataPipeline::Model::DeactivatePipelineRequest::SetPipelineId ( const Aws::String value)
inline

The ID of the pipeline.

Definition at line 53 of file DeactivatePipelineRequest.h.

◆ SetPipelineId() [2/3]

void Aws::DataPipeline::Model::DeactivatePipelineRequest::SetPipelineId ( Aws::String &&  value)
inline

The ID of the pipeline.

Definition at line 58 of file DeactivatePipelineRequest.h.

◆ SetPipelineId() [3/3]

void Aws::DataPipeline::Model::DeactivatePipelineRequest::SetPipelineId ( const char *  value)
inline

The ID of the pipeline.

Definition at line 63 of file DeactivatePipelineRequest.h.

◆ WithCancelActive()

DeactivatePipelineRequest& Aws::DataPipeline::Model::DeactivatePipelineRequest::WithCancelActive ( bool  value)
inline

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Definition at line 107 of file DeactivatePipelineRequest.h.

◆ WithPipelineId() [1/3]

DeactivatePipelineRequest& Aws::DataPipeline::Model::DeactivatePipelineRequest::WithPipelineId ( const Aws::String value)
inline

The ID of the pipeline.

Definition at line 68 of file DeactivatePipelineRequest.h.

◆ WithPipelineId() [2/3]

DeactivatePipelineRequest& Aws::DataPipeline::Model::DeactivatePipelineRequest::WithPipelineId ( Aws::String &&  value)
inline

The ID of the pipeline.

Definition at line 73 of file DeactivatePipelineRequest.h.

◆ WithPipelineId() [3/3]

DeactivatePipelineRequest& Aws::DataPipeline::Model::DeactivatePipelineRequest::WithPipelineId ( const char *  value)
inline

The ID of the pipeline.

Definition at line 78 of file DeactivatePipelineRequest.h.


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