Struct aws_sdk_lightsail::operation::get_container_service_metric_data::builders::GetContainerServiceMetricDataInputBuilder

#[non_exhaustive]
pub struct GetContainerServiceMetricDataInputBuilder { /* private fields */ }

A builder for GetContainerServiceMetricDataInput.

Implementations

impl GetContainerServiceMetricDataInputBuilder

pub fn service_name(self, input: impl Into<String>) -> Self

The name of the container service for which to get metric data.

This field is required.

pub fn set_service_name(self, input: Option<String>) -> Self

The name of the container service for which to get metric data.

pub fn get_service_name(&self) -> &Option<String>

The name of the container service for which to get metric data.

pub fn metric_name(self, input: ContainerServiceMetricName) -> Self

The metric for which you want to return information.

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

• CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

• MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

This field is required.

pub fn set_metric_name(self, input: Option<ContainerServiceMetricName>) -> Self

The metric for which you want to return information.

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

• CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

• MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

pub fn get_metric_name(&self) -> &Option<ContainerServiceMetricName>

The metric for which you want to return information.

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

• CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

• MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

pub fn start_time(self, input: DateTime) -> Self

The start time of the time period.

This field is required.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The start time of the time period.

pub fn get_start_time(&self) -> &Option<DateTime>

The start time of the time period.

pub fn end_time(self, input: DateTime) -> Self

The end time of the time period.

This field is required.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The end time of the time period.

pub fn get_end_time(&self) -> &Option<DateTime>

The end time of the time period.

pub fn period(self, input: i32) -> Self

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

All container service metric data is available in 5-minute (300 seconds) granularity.

This field is required.

pub fn set_period(self, input: Option<i32>) -> Self

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

All container service metric data is available in 5-minute (300 seconds) granularity.

pub fn get_period(&self) -> &Option<i32>

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

All container service metric data is available in 5-minute (300 seconds) granularity.

pub fn statistics(self, input: MetricStatistic) -> Self

Appends an item to statistics.

To override the contents of this collection use set_statistics.

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 - All values submitted for the matching metric added together. 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.

pub fn set_statistics(self, input: Option<Vec<MetricStatistic>>) -> Self

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 - All values submitted for the matching metric added together. 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.

pub fn get_statistics(&self) -> &Option<Vec<MetricStatistic>>

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 - All values submitted for the matching metric added together. 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.

pub fn build(self) -> Result<GetContainerServiceMetricDataInput, BuildError>

Consumes the builder and constructs a GetContainerServiceMetricDataInput.

impl GetContainerServiceMetricDataInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<GetContainerServiceMetricDataOutput, SdkError<GetContainerServiceMetricDataError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for GetContainerServiceMetricDataInputBuilder

fn clone(&self) -> GetContainerServiceMetricDataInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetContainerServiceMetricDataInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetContainerServiceMetricDataInputBuilder

fn default() -> GetContainerServiceMetricDataInputBuilder

Returns the “default value” for a type.

impl PartialEq for GetContainerServiceMetricDataInputBuilder

fn eq(&self, other: &GetContainerServiceMetricDataInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetContainerServiceMetricDataInputBuilder