Class GetLoadBalancerMetricDataRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetLoadBalancerMetricDataRequest.Builder,
GetLoadBalancerMetricDataRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
endTime()
The end time of the period.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Statistics property.final String
The name of the load balancer.final LoadBalancerMetricName
The metric for which you want to return information.final String
The metric for which you want to return information.final Integer
period()
The granularity, in seconds, of the returned data points.static Class
<? extends GetLoadBalancerMetricDataRequest.Builder> final Instant
The start time of the period.final List
<MetricStatistic> The statistic for the metric.The statistic for the metric.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final MetricUnit
unit()
The unit for the metric data request.final String
The unit for the metric data request.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
loadBalancerName
The name of the load balancer.
- Returns:
- The name of the load balancer.
-
metricName
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 publishedunit
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
.
If the service returns an enum value that is not available in the current SDK version,
metricName
will returnLoadBalancerMetricName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricNameAsString()
.- Returns:
- 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 publishedunit
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
.
-
- See Also:
-
-
metricNameAsString
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 publishedunit
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
.
If the service returns an enum value that is not available in the current SDK version,
metricName
will returnLoadBalancerMetricName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricNameAsString()
.- Returns:
- 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 publishedunit
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
.
-
- See Also:
-
-
period
The granularity, in seconds, of the returned data points.
- Returns:
- The granularity, in seconds, of the returned data points.
-
startTime
The start time of the period.
- Returns:
- The start time of the period.
-
endTime
The end time of the period.
- Returns:
- The end time of the period.
-
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.If the service returns an enum value that is not available in the current SDK version,
unit
will returnMetricUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- 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. - See Also:
-
unitAsString
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.If the service returns an enum value that is not available in the current SDK version,
unit
will returnMetricUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- 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. - See Also:
-
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStatistics()
method.- Returns:
- 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.
-
-
-
hasStatistics
public final boolean hasStatistics()For responses, this returns true if the service returned a value for the Statistics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
statisticsAsStrings
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStatistics()
method.- Returns:
- 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.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetLoadBalancerMetricDataRequest.Builder,
GetLoadBalancerMetricDataRequest> - Specified by:
toBuilder
in classLightsailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-