Struct aws_sdk_lightsail::operation::get_load_balancer_metric_data::builders::GetLoadBalancerMetricDataInputBuilder
source · #[non_exhaustive]pub struct GetLoadBalancerMetricDataInputBuilder { /* private fields */ }
Expand description
A builder for GetLoadBalancerMetricDataInput
.
Implementations§
source§impl GetLoadBalancerMetricDataInputBuilder
impl GetLoadBalancerMetricDataInputBuilder
sourcepub fn load_balancer_name(self, input: impl Into<String>) -> Self
pub fn load_balancer_name(self, input: impl Into<String>) -> Self
The name of the load balancer.
This field is required.sourcepub fn set_load_balancer_name(self, input: Option<String>) -> Self
pub fn set_load_balancer_name(self, input: Option<String>) -> Self
The name of the load balancer.
sourcepub fn get_load_balancer_name(&self) -> &Option<String>
pub fn get_load_balancer_name(&self) -> &Option<String>
The name of the load balancer.
sourcepub fn metric_name(self, input: LoadBalancerMetricName) -> Self
pub fn metric_name(self, input: LoadBalancerMetricName) -> Self
The metric for which you want to return information.
Valid load balancer metric names are listed below, along with the most useful statistics
to include in your request, and the published unit
value.
-
ClientTLSNegotiationErrorCount
- The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
. -
HealthyHostCount
- The number of target instances that are considered healthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
.Unit
: The published unit isCount
. -
HTTPCode_Instance_2XX_Count
- The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_Instance_3XX_Count
- The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_Instance_4XX_Count
- The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_Instance_5XX_Count
- The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_LB_4XX_Count
- The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_LB_5XX_Count
- The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
InstanceResponseTime
- The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isSeconds
. -
RejectedConnectionCount
- The number of connections that were rejected because the load balancer had reached its maximum number of connections.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
. -
RequestCount
- The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
UnhealthyHostCount
- The number of target instances that are considered unhealthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
.Unit
: The published unit isCount
.
sourcepub fn set_metric_name(self, input: Option<LoadBalancerMetricName>) -> Self
pub fn set_metric_name(self, input: Option<LoadBalancerMetricName>) -> Self
The metric for which you want to return information.
Valid load balancer metric names are listed below, along with the most useful statistics
to include in your request, and the published unit
value.
-
ClientTLSNegotiationErrorCount
- The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
. -
HealthyHostCount
- The number of target instances that are considered healthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
.Unit
: The published unit isCount
. -
HTTPCode_Instance_2XX_Count
- The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_Instance_3XX_Count
- The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_Instance_4XX_Count
- The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_Instance_5XX_Count
- The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_LB_4XX_Count
- The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_LB_5XX_Count
- The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
InstanceResponseTime
- The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isSeconds
. -
RejectedConnectionCount
- The number of connections that were rejected because the load balancer had reached its maximum number of connections.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
. -
RequestCount
- The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
UnhealthyHostCount
- The number of target instances that are considered unhealthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
.Unit
: The published unit isCount
.
sourcepub fn get_metric_name(&self) -> &Option<LoadBalancerMetricName>
pub fn get_metric_name(&self) -> &Option<LoadBalancerMetricName>
The metric for which you want to return information.
Valid load balancer metric names are listed below, along with the most useful statistics
to include in your request, and the published unit
value.
-
ClientTLSNegotiationErrorCount
- The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
. -
HealthyHostCount
- The number of target instances that are considered healthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
.Unit
: The published unit isCount
. -
HTTPCode_Instance_2XX_Count
- The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_Instance_3XX_Count
- The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_Instance_4XX_Count
- The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_Instance_5XX_Count
- The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_LB_4XX_Count
- The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
HTTPCode_LB_5XX_Count
- The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
InstanceResponseTime
- The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isSeconds
. -
RejectedConnectionCount
- The number of connections that were rejected because the load balancer had reached its maximum number of connections.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
. -
RequestCount
- The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
. -
UnhealthyHostCount
- The number of target instances that are considered unhealthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
.Unit
: The published unit isCount
.
sourcepub fn period(self, input: i32) -> Self
pub fn period(self, input: i32) -> Self
The granularity, in seconds, of the returned data points.
This field is required.sourcepub fn set_period(self, input: Option<i32>) -> Self
pub fn set_period(self, input: Option<i32>) -> Self
The granularity, in seconds, of the returned data points.
sourcepub fn get_period(&self) -> &Option<i32>
pub fn get_period(&self) -> &Option<i32>
The granularity, in seconds, of the returned data points.
sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The start time of the period.
This field is required.sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The start time of the period.
sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
The start time of the period.
sourcepub fn end_time(self, input: DateTime) -> Self
pub fn end_time(self, input: DateTime) -> Self
The end time of the period.
This field is required.sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
The end time of the period.
sourcepub fn get_end_time(&self) -> &Option<DateTime>
pub fn get_end_time(&self) -> &Option<DateTime>
The end time of the period.
sourcepub fn unit(self, input: MetricUnit) -> Self
pub fn unit(self, input: MetricUnit) -> Self
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.
sourcepub fn set_unit(self, input: Option<MetricUnit>) -> Self
pub fn set_unit(self, input: Option<MetricUnit>) -> Self
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.
sourcepub fn get_unit(&self) -> &Option<MetricUnit>
pub fn get_unit(&self) -> &Option<MetricUnit>
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.
sourcepub fn statistics(self, input: MetricStatistic) -> Self
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.
sourcepub fn set_statistics(self, input: Option<Vec<MetricStatistic>>) -> Self
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.
sourcepub fn get_statistics(&self) -> &Option<Vec<MetricStatistic>>
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.
sourcepub fn build(self) -> Result<GetLoadBalancerMetricDataInput, BuildError>
pub fn build(self) -> Result<GetLoadBalancerMetricDataInput, BuildError>
Consumes the builder and constructs a GetLoadBalancerMetricDataInput
.
source§impl GetLoadBalancerMetricDataInputBuilder
impl GetLoadBalancerMetricDataInputBuilder
sourcepub async fn send_with(
self,
client: &Client
) -> Result<GetLoadBalancerMetricDataOutput, SdkError<GetLoadBalancerMetricDataError, HttpResponse>>
pub async fn send_with( self, client: &Client ) -> Result<GetLoadBalancerMetricDataOutput, SdkError<GetLoadBalancerMetricDataError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for GetLoadBalancerMetricDataInputBuilder
impl Clone for GetLoadBalancerMetricDataInputBuilder
source§fn clone(&self) -> GetLoadBalancerMetricDataInputBuilder
fn clone(&self) -> GetLoadBalancerMetricDataInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for GetLoadBalancerMetricDataInputBuilder
impl Default for GetLoadBalancerMetricDataInputBuilder
source§fn default() -> GetLoadBalancerMetricDataInputBuilder
fn default() -> GetLoadBalancerMetricDataInputBuilder
source§impl PartialEq for GetLoadBalancerMetricDataInputBuilder
impl PartialEq for GetLoadBalancerMetricDataInputBuilder
source§fn eq(&self, other: &GetLoadBalancerMetricDataInputBuilder) -> bool
fn eq(&self, other: &GetLoadBalancerMetricDataInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for GetLoadBalancerMetricDataInputBuilder
Auto Trait Implementations§
impl Freeze for GetLoadBalancerMetricDataInputBuilder
impl RefUnwindSafe for GetLoadBalancerMetricDataInputBuilder
impl Send for GetLoadBalancerMetricDataInputBuilder
impl Sync for GetLoadBalancerMetricDataInputBuilder
impl Unpin for GetLoadBalancerMetricDataInputBuilder
impl UnwindSafe for GetLoadBalancerMetricDataInputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more