AWS SDK for C++  1.9.40
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::CloudWatch::Model::ListMetricsRequest Class Reference

#include <ListMetricsRequest.h>

+ Inheritance diagram for Aws::CloudWatch::Model::ListMetricsRequest:

Public Member Functions

 ListMetricsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetNamespace () const
 
bool NamespaceHasBeenSet () const
 
void SetNamespace (const Aws::String &value)
 
void SetNamespace (Aws::String &&value)
 
void SetNamespace (const char *value)
 
ListMetricsRequestWithNamespace (const Aws::String &value)
 
ListMetricsRequestWithNamespace (Aws::String &&value)
 
ListMetricsRequestWithNamespace (const char *value)
 
const Aws::StringGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const Aws::String &value)
 
void SetMetricName (Aws::String &&value)
 
void SetMetricName (const char *value)
 
ListMetricsRequestWithMetricName (const Aws::String &value)
 
ListMetricsRequestWithMetricName (Aws::String &&value)
 
ListMetricsRequestWithMetricName (const char *value)
 
const Aws::Vector< DimensionFilter > & GetDimensions () const
 
bool DimensionsHasBeenSet () const
 
void SetDimensions (const Aws::Vector< DimensionFilter > &value)
 
void SetDimensions (Aws::Vector< DimensionFilter > &&value)
 
ListMetricsRequestWithDimensions (const Aws::Vector< DimensionFilter > &value)
 
ListMetricsRequestWithDimensions (Aws::Vector< DimensionFilter > &&value)
 
ListMetricsRequestAddDimensions (const DimensionFilter &value)
 
ListMetricsRequestAddDimensions (DimensionFilter &&value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListMetricsRequestWithNextToken (const Aws::String &value)
 
ListMetricsRequestWithNextToken (Aws::String &&value)
 
ListMetricsRequestWithNextToken (const char *value)
 
const RecentlyActiveGetRecentlyActive () const
 
bool RecentlyActiveHasBeenSet () const
 
void SetRecentlyActive (const RecentlyActive &value)
 
void SetRecentlyActive (RecentlyActive &&value)
 
ListMetricsRequestWithRecentlyActive (const RecentlyActive &value)
 
ListMetricsRequestWithRecentlyActive (RecentlyActive &&value)
 
- Public Member Functions inherited from Aws::CloudWatch::CloudWatchRequest
virtual ~CloudWatchRequest ()
 
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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::CloudWatch::CloudWatchRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 24 of file ListMetricsRequest.h.

Constructor & Destructor Documentation

◆ ListMetricsRequest()

Aws::CloudWatch::Model::ListMetricsRequest::ListMetricsRequest ( )

Member Function Documentation

◆ AddDimensions() [1/2]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::AddDimensions ( const DimensionFilter value)
inline

The dimensions to filter against. Only the dimensions that match exactly will be returned.

Definition at line 180 of file ListMetricsRequest.h.

◆ AddDimensions() [2/2]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::AddDimensions ( DimensionFilter &&  value)
inline

The dimensions to filter against. Only the dimensions that match exactly will be returned.

Definition at line 186 of file ListMetricsRequest.h.

◆ DimensionsHasBeenSet()

bool Aws::CloudWatch::Model::ListMetricsRequest::DimensionsHasBeenSet ( ) const
inline

The dimensions to filter against. Only the dimensions that match exactly will be returned.

Definition at line 150 of file ListMetricsRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudWatch::Model::ListMetricsRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetDimensions()

const Aws::Vector<DimensionFilter>& Aws::CloudWatch::Model::ListMetricsRequest::GetDimensions ( ) const
inline

The dimensions to filter against. Only the dimensions that match exactly will be returned.

Definition at line 144 of file ListMetricsRequest.h.

◆ GetMetricName()

const Aws::String& Aws::CloudWatch::Model::ListMetricsRequest::GetMetricName ( ) const
inline

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Definition at line 95 of file ListMetricsRequest.h.

◆ GetNamespace()

const Aws::String& Aws::CloudWatch::Model::ListMetricsRequest::GetNamespace ( ) const
inline

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Definition at line 46 of file ListMetricsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::CloudWatch::Model::ListMetricsRequest::GetNextToken ( ) const
inline

The token returned by a previous call to indicate that there is more data available.

Definition at line 193 of file ListMetricsRequest.h.

◆ GetRecentlyActive()

const RecentlyActive& Aws::CloudWatch::Model::ListMetricsRequest::GetRecentlyActive ( ) const
inline

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Definition at line 246 of file ListMetricsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CloudWatch::Model::ListMetricsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file ListMetricsRequest.h.

◆ MetricNameHasBeenSet()

bool Aws::CloudWatch::Model::ListMetricsRequest::MetricNameHasBeenSet ( ) const
inline

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Definition at line 101 of file ListMetricsRequest.h.

◆ NamespaceHasBeenSet()

bool Aws::CloudWatch::Model::ListMetricsRequest::NamespaceHasBeenSet ( ) const
inline

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Definition at line 52 of file ListMetricsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::CloudWatch::Model::ListMetricsRequest::NextTokenHasBeenSet ( ) const
inline

The token returned by a previous call to indicate that there is more data available.

Definition at line 199 of file ListMetricsRequest.h.

◆ RecentlyActiveHasBeenSet()

bool Aws::CloudWatch::Model::ListMetricsRequest::RecentlyActiveHasBeenSet ( ) const
inline

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Definition at line 256 of file ListMetricsRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudWatch::Model::ListMetricsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDimensions() [1/2]

void Aws::CloudWatch::Model::ListMetricsRequest::SetDimensions ( Aws::Vector< DimensionFilter > &&  value)
inline

The dimensions to filter against. Only the dimensions that match exactly will be returned.

Definition at line 162 of file ListMetricsRequest.h.

◆ SetDimensions() [2/2]

void Aws::CloudWatch::Model::ListMetricsRequest::SetDimensions ( const Aws::Vector< DimensionFilter > &  value)
inline

The dimensions to filter against. Only the dimensions that match exactly will be returned.

Definition at line 156 of file ListMetricsRequest.h.

◆ SetMetricName() [1/3]

void Aws::CloudWatch::Model::ListMetricsRequest::SetMetricName ( Aws::String &&  value)
inline

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Definition at line 113 of file ListMetricsRequest.h.

◆ SetMetricName() [2/3]

void Aws::CloudWatch::Model::ListMetricsRequest::SetMetricName ( const Aws::String value)
inline

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Definition at line 107 of file ListMetricsRequest.h.

◆ SetMetricName() [3/3]

void Aws::CloudWatch::Model::ListMetricsRequest::SetMetricName ( const char *  value)
inline

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Definition at line 119 of file ListMetricsRequest.h.

◆ SetNamespace() [1/3]

void Aws::CloudWatch::Model::ListMetricsRequest::SetNamespace ( Aws::String &&  value)
inline

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Definition at line 64 of file ListMetricsRequest.h.

◆ SetNamespace() [2/3]

void Aws::CloudWatch::Model::ListMetricsRequest::SetNamespace ( const Aws::String value)
inline

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Definition at line 58 of file ListMetricsRequest.h.

◆ SetNamespace() [3/3]

void Aws::CloudWatch::Model::ListMetricsRequest::SetNamespace ( const char *  value)
inline

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Definition at line 70 of file ListMetricsRequest.h.

◆ SetNextToken() [1/3]

void Aws::CloudWatch::Model::ListMetricsRequest::SetNextToken ( Aws::String &&  value)
inline

The token returned by a previous call to indicate that there is more data available.

Definition at line 211 of file ListMetricsRequest.h.

◆ SetNextToken() [2/3]

void Aws::CloudWatch::Model::ListMetricsRequest::SetNextToken ( const Aws::String value)
inline

The token returned by a previous call to indicate that there is more data available.

Definition at line 205 of file ListMetricsRequest.h.

◆ SetNextToken() [3/3]

void Aws::CloudWatch::Model::ListMetricsRequest::SetNextToken ( const char *  value)
inline

The token returned by a previous call to indicate that there is more data available.

Definition at line 217 of file ListMetricsRequest.h.

◆ SetRecentlyActive() [1/2]

void Aws::CloudWatch::Model::ListMetricsRequest::SetRecentlyActive ( const RecentlyActive value)
inline

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Definition at line 266 of file ListMetricsRequest.h.

◆ SetRecentlyActive() [2/2]

void Aws::CloudWatch::Model::ListMetricsRequest::SetRecentlyActive ( RecentlyActive &&  value)
inline

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Definition at line 276 of file ListMetricsRequest.h.

◆ WithDimensions() [1/2]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithDimensions ( Aws::Vector< DimensionFilter > &&  value)
inline

The dimensions to filter against. Only the dimensions that match exactly will be returned.

Definition at line 174 of file ListMetricsRequest.h.

◆ WithDimensions() [2/2]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithDimensions ( const Aws::Vector< DimensionFilter > &  value)
inline

The dimensions to filter against. Only the dimensions that match exactly will be returned.

Definition at line 168 of file ListMetricsRequest.h.

◆ WithMetricName() [1/3]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithMetricName ( Aws::String &&  value)
inline

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Definition at line 131 of file ListMetricsRequest.h.

◆ WithMetricName() [2/3]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithMetricName ( const Aws::String value)
inline

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Definition at line 125 of file ListMetricsRequest.h.

◆ WithMetricName() [3/3]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithMetricName ( const char *  value)
inline

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Definition at line 137 of file ListMetricsRequest.h.

◆ WithNamespace() [1/3]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithNamespace ( Aws::String &&  value)
inline

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Definition at line 82 of file ListMetricsRequest.h.

◆ WithNamespace() [2/3]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithNamespace ( const Aws::String value)
inline

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Definition at line 76 of file ListMetricsRequest.h.

◆ WithNamespace() [3/3]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithNamespace ( const char *  value)
inline

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Definition at line 88 of file ListMetricsRequest.h.

◆ WithNextToken() [1/3]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithNextToken ( Aws::String &&  value)
inline

The token returned by a previous call to indicate that there is more data available.

Definition at line 229 of file ListMetricsRequest.h.

◆ WithNextToken() [2/3]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithNextToken ( const Aws::String value)
inline

The token returned by a previous call to indicate that there is more data available.

Definition at line 223 of file ListMetricsRequest.h.

◆ WithNextToken() [3/3]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithNextToken ( const char *  value)
inline

The token returned by a previous call to indicate that there is more data available.

Definition at line 235 of file ListMetricsRequest.h.

◆ WithRecentlyActive() [1/2]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithRecentlyActive ( const RecentlyActive value)
inline

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Definition at line 286 of file ListMetricsRequest.h.

◆ WithRecentlyActive() [2/2]

ListMetricsRequest& Aws::CloudWatch::Model::ListMetricsRequest::WithRecentlyActive ( RecentlyActive &&  value)
inline

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Definition at line 296 of file ListMetricsRequest.h.


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