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

#include <DescribeChannelRequest.h>

+ Inheritance diagram for Aws::IoTAnalytics::Model::DescribeChannelRequest:

Public Member Functions

 DescribeChannelRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetChannelName () const
 
bool ChannelNameHasBeenSet () const
 
void SetChannelName (const Aws::String &value)
 
void SetChannelName (Aws::String &&value)
 
void SetChannelName (const char *value)
 
DescribeChannelRequestWithChannelName (const Aws::String &value)
 
DescribeChannelRequestWithChannelName (Aws::String &&value)
 
DescribeChannelRequestWithChannelName (const char *value)
 
bool GetIncludeStatistics () const
 
bool IncludeStatisticsHasBeenSet () const
 
void SetIncludeStatistics (bool value)
 
DescribeChannelRequestWithIncludeStatistics (bool value)
 
- Public Member Functions inherited from Aws::IoTAnalytics::IoTAnalyticsRequest
virtual ~IoTAnalyticsRequest ()
 
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 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::IoTAnalytics::IoTAnalyticsRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file DescribeChannelRequest.h.

Constructor & Destructor Documentation

◆ DescribeChannelRequest()

Aws::IoTAnalytics::Model::DescribeChannelRequest::DescribeChannelRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::IoTAnalytics::Model::DescribeChannelRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ChannelNameHasBeenSet()

bool Aws::IoTAnalytics::Model::DescribeChannelRequest::ChannelNameHasBeenSet ( ) const
inline

The name of the channel whose information is retrieved.

Definition at line 49 of file DescribeChannelRequest.h.

◆ GetChannelName()

const Aws::String& Aws::IoTAnalytics::Model::DescribeChannelRequest::GetChannelName ( ) const
inline

The name of the channel whose information is retrieved.

Definition at line 44 of file DescribeChannelRequest.h.

◆ GetIncludeStatistics()

bool Aws::IoTAnalytics::Model::DescribeChannelRequest::GetIncludeStatistics ( ) const
inline

If true, additional statistical information about the channel is included in the response. This feature cannot be used with a channel whose S3 storage is customer-managed.

Definition at line 87 of file DescribeChannelRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IoTAnalytics::Model::DescribeChannelRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeChannelRequest.h.

◆ IncludeStatisticsHasBeenSet()

bool Aws::IoTAnalytics::Model::DescribeChannelRequest::IncludeStatisticsHasBeenSet ( ) const
inline

If true, additional statistical information about the channel is included in the response. This feature cannot be used with a channel whose S3 storage is customer-managed.

Definition at line 94 of file DescribeChannelRequest.h.

◆ SerializePayload()

Aws::String Aws::IoTAnalytics::Model::DescribeChannelRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetChannelName() [1/3]

void Aws::IoTAnalytics::Model::DescribeChannelRequest::SetChannelName ( const Aws::String value)
inline

The name of the channel whose information is retrieved.

Definition at line 54 of file DescribeChannelRequest.h.

◆ SetChannelName() [2/3]

void Aws::IoTAnalytics::Model::DescribeChannelRequest::SetChannelName ( Aws::String &&  value)
inline

The name of the channel whose information is retrieved.

Definition at line 59 of file DescribeChannelRequest.h.

◆ SetChannelName() [3/3]

void Aws::IoTAnalytics::Model::DescribeChannelRequest::SetChannelName ( const char *  value)
inline

The name of the channel whose information is retrieved.

Definition at line 64 of file DescribeChannelRequest.h.

◆ SetIncludeStatistics()

void Aws::IoTAnalytics::Model::DescribeChannelRequest::SetIncludeStatistics ( bool  value)
inline

If true, additional statistical information about the channel is included in the response. This feature cannot be used with a channel whose S3 storage is customer-managed.

Definition at line 101 of file DescribeChannelRequest.h.

◆ WithChannelName() [1/3]

DescribeChannelRequest& Aws::IoTAnalytics::Model::DescribeChannelRequest::WithChannelName ( const Aws::String value)
inline

The name of the channel whose information is retrieved.

Definition at line 69 of file DescribeChannelRequest.h.

◆ WithChannelName() [2/3]

DescribeChannelRequest& Aws::IoTAnalytics::Model::DescribeChannelRequest::WithChannelName ( Aws::String &&  value)
inline

The name of the channel whose information is retrieved.

Definition at line 74 of file DescribeChannelRequest.h.

◆ WithChannelName() [3/3]

DescribeChannelRequest& Aws::IoTAnalytics::Model::DescribeChannelRequest::WithChannelName ( const char *  value)
inline

The name of the channel whose information is retrieved.

Definition at line 79 of file DescribeChannelRequest.h.

◆ WithIncludeStatistics()

DescribeChannelRequest& Aws::IoTAnalytics::Model::DescribeChannelRequest::WithIncludeStatistics ( bool  value)
inline

If true, additional statistical information about the channel is included in the response. This feature cannot be used with a channel whose S3 storage is customer-managed.

Definition at line 108 of file DescribeChannelRequest.h.


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