/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.lightsail.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetLoadBalancerMetricDataRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name of the load balancer. *
*/ private String loadBalancerName; /** ** 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 is Sum
.
*
* Unit
: The published unit is Count
.
*
* HealthyHostCount
- The number of target instances that are considered healthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Average
.
*
* Unit
: The published unit is Seconds
.
*
* RejectedConnectionCount
- The number of connections that were rejected because the load
* balancer had reached its maximum number of connections.
*
* Statistics
: The most useful statistic is Sum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* UnhealthyHostCount
- The number of target instances that are considered unhealthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* The granularity, in seconds, of the returned data points. *
*/ private Integer period; /** ** The start time of the period. *
*/ private java.util.Date startTime; /** ** The end time of the period. *
*/ private java.util.Date endTime; /** *
* 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.
*
* 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.
*
* The name of the load balancer. *
* * @param loadBalancerName * The name of the load balancer. */ public void setLoadBalancerName(String loadBalancerName) { this.loadBalancerName = loadBalancerName; } /** ** The name of the load balancer. *
* * @return The name of the load balancer. */ public String getLoadBalancerName() { return this.loadBalancerName; } /** ** The name of the load balancer. *
* * @param loadBalancerName * The name of the load balancer. * @return Returns a reference to this object so that method calls can be chained together. */ public GetLoadBalancerMetricDataRequest withLoadBalancerName(String loadBalancerName) { setLoadBalancerName(loadBalancerName); return this; } /** ** 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 is Sum
.
*
* Unit
: The published unit is Count
.
*
* HealthyHostCount
- The number of target instances that are considered healthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Average
.
*
* Unit
: The published unit is Seconds
.
*
* RejectedConnectionCount
- The number of connections that were rejected because the load
* balancer had reached its maximum number of connections.
*
* Statistics
: The most useful statistic is Sum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* UnhealthyHostCount
- The number of target instances that are considered unhealthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
.
*
* Unit
: The published unit is Count
.
*
* HealthyHostCount
- The number of target instances that are considered healthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Average
.
*
* Unit
: The published unit is Seconds
.
*
* RejectedConnectionCount
- The number of connections that were rejected because the
* load balancer had reached its maximum number of connections.
*
* Statistics
: The most useful statistic is Sum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* UnhealthyHostCount
- The number of target instances that are considered unhealthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
.
*
* Unit
: The published unit is Count
.
*
* HealthyHostCount
- The number of target instances that are considered healthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Average
.
*
* Unit
: The published unit is Seconds
.
*
* RejectedConnectionCount
- The number of connections that were rejected because the load
* balancer had reached its maximum number of connections.
*
* Statistics
: The most useful statistic is Sum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* UnhealthyHostCount
- The number of target instances that are considered unhealthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
.
*
* Unit
: The published unit is Count
.
*
* HealthyHostCount
- The number of target instances that are considered healthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Average
.
*
* Unit
: The published unit is Seconds
.
*
* RejectedConnectionCount
- The number of connections that were rejected because the
* load balancer had reached its maximum number of connections.
*
* Statistics
: The most useful statistic is Sum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* UnhealthyHostCount
- The number of target instances that are considered unhealthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
.
*
* Unit
: The published unit is Count
.
*
* HealthyHostCount
- The number of target instances that are considered healthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Average
.
*
* Unit
: The published unit is Seconds
.
*
* RejectedConnectionCount
- The number of connections that were rejected because the load
* balancer had reached its maximum number of connections.
*
* Statistics
: The most useful statistic is Sum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* UnhealthyHostCount
- The number of target instances that are considered unhealthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
.
*
* Unit
: The published unit is Count
.
*
* HealthyHostCount
- The number of target instances that are considered healthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Average
.
*
* Unit
: The published unit is Seconds
.
*
* RejectedConnectionCount
- The number of connections that were rejected because the
* load balancer had reached its maximum number of connections.
*
* Statistics
: The most useful statistic is Sum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* UnhealthyHostCount
- The number of target instances that are considered unhealthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
.
*
* Unit
: The published unit is Count
.
*
* HealthyHostCount
- The number of target instances that are considered healthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Average
.
*
* Unit
: The published unit is Seconds
.
*
* RejectedConnectionCount
- The number of connections that were rejected because the load
* balancer had reached its maximum number of connections.
*
* Statistics
: The most useful statistic is Sum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* UnhealthyHostCount
- The number of target instances that are considered unhealthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
.
*
* Unit
: The published unit is Count
.
*
* HealthyHostCount
- The number of target instances that are considered healthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* 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 is Average
.
*
* Unit
: The published unit is Seconds
.
*
* RejectedConnectionCount
- The number of connections that were rejected because the
* load balancer had reached its maximum number of connections.
*
* Statistics
: The most useful statistic is Sum
.
*
* Unit
: The published unit is Count
.
*
* 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 is Sum
. Note that Minimum
,
* Maximum
, and Average
all return 1
.
*
* Unit
: The published unit is Count
.
*
* UnhealthyHostCount
- The number of target instances that are considered unhealthy.
*
* Statistics
: The most useful statistic are Average
, Minimum
, and
* Maximum
.
*
* Unit
: The published unit is Count
.
*
* The granularity, in seconds, of the returned data points. *
* * @param period * The granularity, in seconds, of the returned data points. */ public void setPeriod(Integer period) { this.period = period; } /** ** The granularity, in seconds, of the returned data points. *
* * @return The granularity, in seconds, of the returned data points. */ public Integer getPeriod() { return this.period; } /** ** The granularity, in seconds, of the returned data points. *
* * @param period * The granularity, in seconds, of the returned data points. * @return Returns a reference to this object so that method calls can be chained together. */ public GetLoadBalancerMetricDataRequest withPeriod(Integer period) { setPeriod(period); return this; } /** ** The start time of the period. *
* * @param startTime * The start time of the period. */ public void setStartTime(java.util.Date startTime) { this.startTime = startTime; } /** ** The start time of the period. *
* * @return The start time of the period. */ public java.util.Date getStartTime() { return this.startTime; } /** ** The start time of the period. *
* * @param startTime * The start time of the period. * @return Returns a reference to this object so that method calls can be chained together. */ public GetLoadBalancerMetricDataRequest withStartTime(java.util.Date startTime) { setStartTime(startTime); return this; } /** ** The end time of the period. *
* * @param endTime * The end time of the period. */ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** ** The end time of the period. *
* * @return The end time of the period. */ public java.util.Date getEndTime() { return this.endTime; } /** ** The end time of the period. *
* * @param endTime * The end time of the period. * @return Returns a reference to this object so that method calls can be chained together. */ public GetLoadBalancerMetricDataRequest withEndTime(java.util.Date endTime) { setEndTime(endTime); return this; } /** *
* 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.
*
metricName
parameter.
* @see MetricUnit
*/
public void setUnit(String unit) {
this.unit = unit;
}
/**
*
* 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.
*
metricName
parameter.
* @see MetricUnit
*/
public String getUnit() {
return this.unit;
}
/**
*
* 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.
*
metricName
parameter.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricUnit
*/
public GetLoadBalancerMetricDataRequest withUnit(String unit) {
setUnit(unit);
return this;
}
/**
*
* 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.
*
metricName
parameter.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricUnit
*/
public GetLoadBalancerMetricDataRequest withUnit(MetricUnit unit) {
this.unit = unit.toString();
return this;
}
/**
* * 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setStatistics(java.util.Collection)} or {@link #withStatistics(java.util.Collection)} if you want to * override the existing values. *
* * @param 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*