software.amazon.awssdk.services.lightsail.model

Class GetLoadBalancerMetricDataResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.lightsail.model.LightsailResponse

software.amazon.awssdk.services.lightsail.model.GetLoadBalancerMetricDataResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetLoadBalancerMetricDataResponse.Builder,GetLoadBalancerMetricDataResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetLoadBalancerMetricDataResponse
extends LightsailResponse
implements ToCopyableBuilder<GetLoadBalancerMetricDataResponse.Builder,GetLoadBalancerMetricDataResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetLoadBalancerMetricDataResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetLoadBalancerMetricDataResponse.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
List<MetricDatapoint>	metricData() An array of metric datapoint objects.
LoadBalancerMetricName	metricName() The metric about which you are receiving information.
String	metricNameAsString() The metric about which you are receiving information.
List<SdkField<?>>	sdkFields()
static Class<? extends GetLoadBalancerMetricDataResponse.Builder>	serializableBuilderClass()
GetLoadBalancerMetricDataResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.services.lightsail.model.LightsailResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

metricName

public LoadBalancerMetricName metricName()

The metric about which you are receiving information. Valid values are listed below, along with the most useful statistics to include in your request.

• ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.

  Statistics: The most useful statistic is Sum.

• HealthyHostCount - The number of target instances that are considered healthy.

  Statistics: The most useful statistic are Average, Minimum, and Maximum.

• UnhealthyHostCount - The number of target instances that are considered unhealthy.

  Statistics: The most useful statistic are Average, Minimum, and Maximum.

• HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_Instance_2XX_Count - The number of HTTP 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.

• HTTPCode_Instance_3XX_Count - The number of HTTP 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.

• HTTPCode_Instance_4XX_Count - The number of HTTP 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.

• HTTPCode_Instance_5XX_Count - The number of HTTP 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.

• 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.

• 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.

• 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.

If the service returns an enum value that is not available in the current SDK version, metricName will return LoadBalancerMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

Returns:

The metric about which you are receiving information. Valid values are listed below, along with the most useful statistics to include in your request.

• ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.

  Statistics: The most useful statistic is Sum.

• HealthyHostCount - The number of target instances that are considered healthy.

  Statistics: The most useful statistic are Average, Minimum, and Maximum.

• UnhealthyHostCount - The number of target instances that are considered unhealthy.

  Statistics: The most useful statistic are Average, Minimum, and Maximum.

• HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_Instance_2XX_Count - The number of HTTP 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.

• HTTPCode_Instance_3XX_Count - The number of HTTP 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.

• HTTPCode_Instance_4XX_Count - The number of HTTP 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.

• HTTPCode_Instance_5XX_Count - The number of HTTP 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.

• 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.

• 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.

• 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.

See Also:

LoadBalancerMetricName

metricNameAsString

public String metricNameAsString()

The metric about which you are receiving information. Valid values are listed below, along with the most useful statistics to include in your request.

• ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.

  Statistics: The most useful statistic is Sum.

• HealthyHostCount - The number of target instances that are considered healthy.

  Statistics: The most useful statistic are Average, Minimum, and Maximum.

• UnhealthyHostCount - The number of target instances that are considered unhealthy.

  Statistics: The most useful statistic are Average, Minimum, and Maximum.

• HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_Instance_2XX_Count - The number of HTTP 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.

• HTTPCode_Instance_3XX_Count - The number of HTTP 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.

• HTTPCode_Instance_4XX_Count - The number of HTTP 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.

• HTTPCode_Instance_5XX_Count - The number of HTTP 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.

• 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.

• 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.

• 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.

If the service returns an enum value that is not available in the current SDK version, metricName will return LoadBalancerMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

Returns:

The metric about which you are receiving information. Valid values are listed below, along with the most useful statistics to include in your request.

• ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.

  Statistics: The most useful statistic is Sum.

• HealthyHostCount - The number of target instances that are considered healthy.

  Statistics: The most useful statistic are Average, Minimum, and Maximum.

• UnhealthyHostCount - The number of target instances that are considered unhealthy.

  Statistics: The most useful statistic are Average, Minimum, and Maximum.

• HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_Instance_2XX_Count - The number of HTTP 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.

• HTTPCode_Instance_3XX_Count - The number of HTTP 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.

• HTTPCode_Instance_4XX_Count - The number of HTTP 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.

• HTTPCode_Instance_5XX_Count - The number of HTTP 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.

• 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.

• 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.

• 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.

See Also:

LoadBalancerMetricName

metricData

public List<MetricDatapoint> metricData()

An array of metric datapoint objects.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

An array of metric datapoint objects.

toBuilder

public GetLoadBalancerMetricDataResponse.Builder 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 interface ToCopyableBuilder<GetLoadBalancerMetricDataResponse.Builder,GetLoadBalancerMetricDataResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetLoadBalancerMetricDataResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetLoadBalancerMetricDataResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.