AWS SDK for C++  1.9.106
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::GetBucketMetricDataRequest Class Reference

#include <GetBucketMetricDataRequest.h>

+ Inheritance diagram for Aws::Lightsail::Model::GetBucketMetricDataRequest:

Public Member Functions

 GetBucketMetricDataRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetBucketName () const
 
bool BucketNameHasBeenSet () const
 
void SetBucketName (const Aws::String &value)
 
void SetBucketName (Aws::String &&value)
 
void SetBucketName (const char *value)
 
GetBucketMetricDataRequestWithBucketName (const Aws::String &value)
 
GetBucketMetricDataRequestWithBucketName (Aws::String &&value)
 
GetBucketMetricDataRequestWithBucketName (const char *value)
 
const BucketMetricNameGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const BucketMetricName &value)
 
void SetMetricName (BucketMetricName &&value)
 
GetBucketMetricDataRequestWithMetricName (const BucketMetricName &value)
 
GetBucketMetricDataRequestWithMetricName (BucketMetricName &&value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
GetBucketMetricDataRequestWithStartTime (const Aws::Utils::DateTime &value)
 
GetBucketMetricDataRequestWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
GetBucketMetricDataRequestWithEndTime (const Aws::Utils::DateTime &value)
 
GetBucketMetricDataRequestWithEndTime (Aws::Utils::DateTime &&value)
 
int GetPeriod () const
 
bool PeriodHasBeenSet () const
 
void SetPeriod (int value)
 
GetBucketMetricDataRequestWithPeriod (int value)
 
const Aws::Vector< MetricStatistic > & GetStatistics () const
 
bool StatisticsHasBeenSet () const
 
void SetStatistics (const Aws::Vector< MetricStatistic > &value)
 
void SetStatistics (Aws::Vector< MetricStatistic > &&value)
 
GetBucketMetricDataRequestWithStatistics (const Aws::Vector< MetricStatistic > &value)
 
GetBucketMetricDataRequestWithStatistics (Aws::Vector< MetricStatistic > &&value)
 
GetBucketMetricDataRequestAddStatistics (const MetricStatistic &value)
 
GetBucketMetricDataRequestAddStatistics (MetricStatistic &&value)
 
const MetricUnitGetUnit () const
 
bool UnitHasBeenSet () const
 
void SetUnit (const MetricUnit &value)
 
void SetUnit (MetricUnit &&value)
 
GetBucketMetricDataRequestWithUnit (const MetricUnit &value)
 
GetBucketMetricDataRequestWithUnit (MetricUnit &&value)
 
- Public Member Functions inherited from Aws::Lightsail::LightsailRequest
virtual ~LightsailRequest ()
 
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 26 of file GetBucketMetricDataRequest.h.

Constructor & Destructor Documentation

◆ GetBucketMetricDataRequest()

Aws::Lightsail::Model::GetBucketMetricDataRequest::GetBucketMetricDataRequest ( )

Member Function Documentation

◆ AddStatistics() [1/2]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::AddStatistics ( const MetricStatistic value)
inline

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount

    • The count, or number, of data points used for the statistical calculation.

Definition at line 431 of file GetBucketMetricDataRequest.h.

◆ AddStatistics() [2/2]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::AddStatistics ( MetricStatistic &&  value)
inline

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount

    • The count, or number, of data points used for the statistical calculation.

Definition at line 451 of file GetBucketMetricDataRequest.h.

◆ BucketNameHasBeenSet()

bool Aws::Lightsail::Model::GetBucketMetricDataRequest::BucketNameHasBeenSet ( ) const
inline

The name of the bucket for which to get metric data.

Definition at line 50 of file GetBucketMetricDataRequest.h.

◆ EndTimeHasBeenSet()

bool Aws::Lightsail::Model::GetBucketMetricDataRequest::EndTimeHasBeenSet ( ) const
inline

The timestamp indicating the latest data to be returned.

Definition at line 237 of file GetBucketMetricDataRequest.h.

◆ GetBucketName()

const Aws::String& Aws::Lightsail::Model::GetBucketMetricDataRequest::GetBucketName ( ) const
inline

The name of the bucket for which to get metric data.

Definition at line 45 of file GetBucketMetricDataRequest.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::Lightsail::Model::GetBucketMetricDataRequest::GetEndTime ( ) const
inline

The timestamp indicating the latest data to be returned.

Definition at line 232 of file GetBucketMetricDataRequest.h.

◆ GetMetricName()

const BucketMetricName& Aws::Lightsail::Model::GetBucketMetricDataRequest::GetMetricName ( ) const
inline

The metric for which you want to return information.

Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

These bucket metrics are reported once per day.

  • BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated by summing the size of all objects in the bucket (including object versions), including the size of all parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Maximum.

    Unit: The published unit is Bytes.

  • NumberOfObjects - The total number of objects stored in a bucket. This value is calculated by counting all objects in the bucket (including object versions) and the total number of parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Count.

Definition at line 100 of file GetBucketMetricDataRequest.h.

◆ GetPeriod()

int Aws::Lightsail::Model::GetBucketMetricDataRequest::GetPeriod ( ) const
inline

The granularity, in seconds, of the returned data points.

Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.

Definition at line 266 of file GetBucketMetricDataRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Lightsail::Model::GetBucketMetricDataRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Lightsail::LightsailRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Lightsail::Model::GetBucketMetricDataRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetBucketMetricDataRequest.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::Lightsail::Model::GetBucketMetricDataRequest::GetStartTime ( ) const
inline

The timestamp indicating the earliest data to be returned.

Definition at line 201 of file GetBucketMetricDataRequest.h.

◆ GetStatistics()

const Aws::Vector<MetricStatistic>& Aws::Lightsail::Model::GetBucketMetricDataRequest::GetStatistics ( ) const
inline

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount

    • The count, or number, of data points used for the statistical calculation.

Definition at line 311 of file GetBucketMetricDataRequest.h.

◆ GetUnit()

const MetricUnit& Aws::Lightsail::Model::GetBucketMetricDataRequest::GetUnit ( ) const
inline

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Definition at line 459 of file GetBucketMetricDataRequest.h.

◆ MetricNameHasBeenSet()

bool Aws::Lightsail::Model::GetBucketMetricDataRequest::MetricNameHasBeenSet ( ) const
inline

The metric for which you want to return information.

Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

These bucket metrics are reported once per day.

  • BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated by summing the size of all objects in the bucket (including object versions), including the size of all parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Maximum.

    Unit: The published unit is Bytes.

  • NumberOfObjects - The total number of objects stored in a bucket. This value is calculated by counting all objects in the bucket (including object versions) and the total number of parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Count.

Definition at line 119 of file GetBucketMetricDataRequest.h.

◆ PeriodHasBeenSet()

bool Aws::Lightsail::Model::GetBucketMetricDataRequest::PeriodHasBeenSet ( ) const
inline

The granularity, in seconds, of the returned data points.

Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.

Definition at line 274 of file GetBucketMetricDataRequest.h.

◆ SerializePayload()

Aws::String Aws::Lightsail::Model::GetBucketMetricDataRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucketName() [1/3]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetBucketName ( Aws::String &&  value)
inline

The name of the bucket for which to get metric data.

Definition at line 60 of file GetBucketMetricDataRequest.h.

◆ SetBucketName() [2/3]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetBucketName ( const Aws::String value)
inline

The name of the bucket for which to get metric data.

Definition at line 55 of file GetBucketMetricDataRequest.h.

◆ SetBucketName() [3/3]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetBucketName ( const char *  value)
inline

The name of the bucket for which to get metric data.

Definition at line 65 of file GetBucketMetricDataRequest.h.

◆ SetEndTime() [1/2]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

The timestamp indicating the latest data to be returned.

Definition at line 247 of file GetBucketMetricDataRequest.h.

◆ SetEndTime() [2/2]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetEndTime ( const Aws::Utils::DateTime value)
inline

The timestamp indicating the latest data to be returned.

Definition at line 242 of file GetBucketMetricDataRequest.h.

◆ SetMetricName() [1/2]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetMetricName ( BucketMetricName &&  value)
inline

The metric for which you want to return information.

Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

These bucket metrics are reported once per day.

  • BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated by summing the size of all objects in the bucket (including object versions), including the size of all parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Maximum.

    Unit: The published unit is Bytes.

  • NumberOfObjects - The total number of objects stored in a bucket. This value is calculated by counting all objects in the bucket (including object versions) and the total number of parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Count.

Definition at line 157 of file GetBucketMetricDataRequest.h.

◆ SetMetricName() [2/2]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetMetricName ( const BucketMetricName value)
inline

The metric for which you want to return information.

Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

These bucket metrics are reported once per day.

  • BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated by summing the size of all objects in the bucket (including object versions), including the size of all parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Maximum.

    Unit: The published unit is Bytes.

  • NumberOfObjects - The total number of objects stored in a bucket. This value is calculated by counting all objects in the bucket (including object versions) and the total number of parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Count.

Definition at line 138 of file GetBucketMetricDataRequest.h.

◆ SetPeriod()

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetPeriod ( int  value)
inline

The granularity, in seconds, of the returned data points.

Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.

Definition at line 282 of file GetBucketMetricDataRequest.h.

◆ SetStartTime() [1/2]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

The timestamp indicating the earliest data to be returned.

Definition at line 216 of file GetBucketMetricDataRequest.h.

◆ SetStartTime() [2/2]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetStartTime ( const Aws::Utils::DateTime value)
inline

The timestamp indicating the earliest data to be returned.

Definition at line 211 of file GetBucketMetricDataRequest.h.

◆ SetStatistics() [1/2]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetStatistics ( Aws::Vector< MetricStatistic > &&  value)
inline

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount

    • The count, or number, of data points used for the statistical calculation.

Definition at line 371 of file GetBucketMetricDataRequest.h.

◆ SetStatistics() [2/2]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetStatistics ( const Aws::Vector< MetricStatistic > &  value)
inline

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount

    • The count, or number, of data points used for the statistical calculation.

Definition at line 351 of file GetBucketMetricDataRequest.h.

◆ SetUnit() [1/2]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetUnit ( const MetricUnit value)
inline

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Definition at line 473 of file GetBucketMetricDataRequest.h.

◆ SetUnit() [2/2]

void Aws::Lightsail::Model::GetBucketMetricDataRequest::SetUnit ( MetricUnit &&  value)
inline

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Definition at line 480 of file GetBucketMetricDataRequest.h.

◆ StartTimeHasBeenSet()

bool Aws::Lightsail::Model::GetBucketMetricDataRequest::StartTimeHasBeenSet ( ) const
inline

The timestamp indicating the earliest data to be returned.

Definition at line 206 of file GetBucketMetricDataRequest.h.

◆ StatisticsHasBeenSet()

bool Aws::Lightsail::Model::GetBucketMetricDataRequest::StatisticsHasBeenSet ( ) const
inline

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount

    • The count, or number, of data points used for the statistical calculation.

Definition at line 331 of file GetBucketMetricDataRequest.h.

◆ UnitHasBeenSet()

bool Aws::Lightsail::Model::GetBucketMetricDataRequest::UnitHasBeenSet ( ) const
inline

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Definition at line 466 of file GetBucketMetricDataRequest.h.

◆ WithBucketName() [1/3]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithBucketName ( Aws::String &&  value)
inline

The name of the bucket for which to get metric data.

Definition at line 75 of file GetBucketMetricDataRequest.h.

◆ WithBucketName() [2/3]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithBucketName ( const Aws::String value)
inline

The name of the bucket for which to get metric data.

Definition at line 70 of file GetBucketMetricDataRequest.h.

◆ WithBucketName() [3/3]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithBucketName ( const char *  value)
inline

The name of the bucket for which to get metric data.

Definition at line 80 of file GetBucketMetricDataRequest.h.

◆ WithEndTime() [1/2]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

The timestamp indicating the latest data to be returned.

Definition at line 257 of file GetBucketMetricDataRequest.h.

◆ WithEndTime() [2/2]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithEndTime ( const Aws::Utils::DateTime value)
inline

The timestamp indicating the latest data to be returned.

Definition at line 252 of file GetBucketMetricDataRequest.h.

◆ WithMetricName() [1/2]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithMetricName ( BucketMetricName &&  value)
inline

The metric for which you want to return information.

Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

These bucket metrics are reported once per day.

  • BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated by summing the size of all objects in the bucket (including object versions), including the size of all parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Maximum.

    Unit: The published unit is Bytes.

  • NumberOfObjects - The total number of objects stored in a bucket. This value is calculated by counting all objects in the bucket (including object versions) and the total number of parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Count.

Definition at line 195 of file GetBucketMetricDataRequest.h.

◆ WithMetricName() [2/2]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithMetricName ( const BucketMetricName value)
inline

The metric for which you want to return information.

Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

These bucket metrics are reported once per day.

  • BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated by summing the size of all objects in the bucket (including object versions), including the size of all parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Maximum.

    Unit: The published unit is Bytes.

  • NumberOfObjects - The total number of objects stored in a bucket. This value is calculated by counting all objects in the bucket (including object versions) and the total number of parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Count.

Definition at line 176 of file GetBucketMetricDataRequest.h.

◆ WithPeriod()

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithPeriod ( int  value)
inline

The granularity, in seconds, of the returned data points.

Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.

Definition at line 290 of file GetBucketMetricDataRequest.h.

◆ WithStartTime() [1/2]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

The timestamp indicating the earliest data to be returned.

Definition at line 226 of file GetBucketMetricDataRequest.h.

◆ WithStartTime() [2/2]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithStartTime ( const Aws::Utils::DateTime value)
inline

The timestamp indicating the earliest data to be returned.

Definition at line 221 of file GetBucketMetricDataRequest.h.

◆ WithStatistics() [1/2]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithStatistics ( Aws::Vector< MetricStatistic > &&  value)
inline

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount

    • The count, or number, of data points used for the statistical calculation.

Definition at line 411 of file GetBucketMetricDataRequest.h.

◆ WithStatistics() [2/2]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithStatistics ( const Aws::Vector< MetricStatistic > &  value)
inline

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount

    • The count, or number, of data points used for the statistical calculation.

Definition at line 391 of file GetBucketMetricDataRequest.h.

◆ WithUnit() [1/2]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithUnit ( const MetricUnit value)
inline

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Definition at line 487 of file GetBucketMetricDataRequest.h.

◆ WithUnit() [2/2]

GetBucketMetricDataRequest& Aws::Lightsail::Model::GetBucketMetricDataRequest::WithUnit ( MetricUnit &&  value)
inline

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Definition at line 494 of file GetBucketMetricDataRequest.h.


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