Aws::Kinesis::Model::DeleteStreamRequest Class Reference

#include <DeleteStreamRequest.h>

Inheritance diagram for Aws::Kinesis::Model::DeleteStreamRequest:

Public Member Functions
	DeleteStreamRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetStreamName () const
bool	StreamNameHasBeenSet () const
void	SetStreamName (const Aws::String &value)
void	SetStreamName (Aws::String &&value)
void	SetStreamName (const char *value)
DeleteStreamRequest &	WithStreamName (const Aws::String &value)
DeleteStreamRequest &	WithStreamName (Aws::String &&value)
DeleteStreamRequest &	WithStreamName (const char *value)
bool	GetEnforceConsumerDeletion () const
bool	EnforceConsumerDeletionHasBeenSet () const
void	SetEnforceConsumerDeletion (bool value)
DeleteStreamRequest &	WithEnforceConsumerDeletion (bool value)
Public Member Functions inherited from Aws::Kinesis::KinesisRequest
virtual	~KinesisRequest ()
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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::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

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

Detailed Description

Represents the input for DeleteStream.

See Also:

AWS API Reference

Definition at line 24 of file DeleteStreamRequest.h.

Constructor & Destructor Documentation

DeleteStreamRequest()

Aws::Kinesis::Model::DeleteStreamRequest::DeleteStreamRequest

(

)

Member Function Documentation

EnforceConsumerDeletionHasBeenSet()

bool Aws::Kinesis::Model::DeleteStreamRequest::EnforceConsumerDeletionHasBeenSet ( ) const

inline

If this parameter is unset (null) or if you set it to false, and the stream has registered consumers, the call to DeleteStream fails with a ResourceInUseException.

Definition at line 93 of file DeleteStreamRequest.h.

GetEnforceConsumerDeletion()

bool Aws::Kinesis::Model::DeleteStreamRequest::GetEnforceConsumerDeletion ( ) const

inline

If this parameter is unset (null) or if you set it to false, and the stream has registered consumers, the call to DeleteStream fails with a ResourceInUseException.

Definition at line 86 of file DeleteStreamRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Kinesis::Model::DeleteStreamRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::Kinesis::KinesisRequest.

GetServiceRequestName()

virtual const char* Aws::Kinesis::Model::DeleteStreamRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file DeleteStreamRequest.h.

GetStreamName()

const Aws::String& Aws::Kinesis::Model::DeleteStreamRequest::GetStreamName ( ) const

inline

The name of the stream to delete.

Definition at line 43 of file DeleteStreamRequest.h.

SerializePayload()

Aws::String Aws::Kinesis::Model::DeleteStreamRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetEnforceConsumerDeletion()

void Aws::Kinesis::Model::DeleteStreamRequest::SetEnforceConsumerDeletion ( bool  value )

inline

If this parameter is unset (null) or if you set it to false, and the stream has registered consumers, the call to DeleteStream fails with a ResourceInUseException.

Definition at line 100 of file DeleteStreamRequest.h.

SetStreamName() [1/3]

void Aws::Kinesis::Model::DeleteStreamRequest::SetStreamName ( const Aws::String &  value )

inline

The name of the stream to delete.

Definition at line 53 of file DeleteStreamRequest.h.

SetStreamName() [2/3]

void Aws::Kinesis::Model::DeleteStreamRequest::SetStreamName ( Aws::String &&  value )

inline

The name of the stream to delete.

Definition at line 58 of file DeleteStreamRequest.h.

SetStreamName() [3/3]

void Aws::Kinesis::Model::DeleteStreamRequest::SetStreamName ( const char *  value )

inline

The name of the stream to delete.

Definition at line 63 of file DeleteStreamRequest.h.

StreamNameHasBeenSet()

bool Aws::Kinesis::Model::DeleteStreamRequest::StreamNameHasBeenSet ( ) const

inline

The name of the stream to delete.

Definition at line 48 of file DeleteStreamRequest.h.

WithEnforceConsumerDeletion()

DeleteStreamRequest& Aws::Kinesis::Model::DeleteStreamRequest::WithEnforceConsumerDeletion ( bool  value )

inline

If this parameter is unset (null) or if you set it to false, and the stream has registered consumers, the call to DeleteStream fails with a ResourceInUseException.

Definition at line 107 of file DeleteStreamRequest.h.

WithStreamName() [1/3]

DeleteStreamRequest& Aws::Kinesis::Model::DeleteStreamRequest::WithStreamName ( const Aws::String &  value )

inline

The name of the stream to delete.

Definition at line 68 of file DeleteStreamRequest.h.

WithStreamName() [2/3]

DeleteStreamRequest& Aws::Kinesis::Model::DeleteStreamRequest::WithStreamName ( Aws::String &&  value )

inline

The name of the stream to delete.

Definition at line 73 of file DeleteStreamRequest.h.

WithStreamName() [3/3]

DeleteStreamRequest& Aws::Kinesis::Model::DeleteStreamRequest::WithStreamName ( const char *  value )

inline

The name of the stream to delete.

Definition at line 78 of file DeleteStreamRequest.h.

---

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

• aws-cpp-sdk-kinesis/include/aws/kinesis/model/DeleteStreamRequest.h