GetLoadBalancerMetricDataRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.lightsail.model.LightsailRequest
    - - software.amazon.awssdk.services.lightsail.model.GetLoadBalancerMetricDataRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetLoadBalancerMetricDataRequest.Builder,GetLoadBalancerMetricDataRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetLoadBalancerMetricDataRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetLoadBalancerMetricDataRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetLoadBalancerMetricDataRequest.Builder`	`builder()`
`Instant`	`endTime()` The end time of the period.
`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 `SdkRequest`.
`int`	`hashCode()`
`String`	`loadBalancerName()` The name of the load balancer.
`LoadBalancerMetricName`	`metricName()` The metric about which you want to return information.
`String`	`metricNameAsString()` The metric about which you want to return information.
`Integer`	`period()` The granularity, in seconds, of the returned data points.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetLoadBalancerMetricDataRequest.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The start time of the period.
`List<MetricStatistic>`	`statistics()` An array of statistics that you want to request metrics for.
`List<String>`	`statisticsAsStrings()` An array of statistics that you want to request metrics for.
`GetLoadBalancerMetricDataRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`MetricUnit`	`unit()` The unit for the time period request.
`String`	`unitAsString()` The unit for the time period request.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - loadBalancerName
```
public String loadBalancerName()
```
    The name of the load balancer.
    
    Returns:
    
    The name of the load balancer.
  - metricName
```
public LoadBalancerMetricName metricName()
```
    The metric about which you want to return 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 want to return 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 want to return 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 want to return 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
  - period
```
public Integer period()
```
    The granularity, in seconds, of the returned data points.
    
    Returns:
    
    The granularity, in seconds, of the returned data points.
  - startTime
```
public Instant startTime()
```
    The start time of the period.
    
    Returns:
    
    The start time of the period.
  - endTime
```
public Instant endTime()
```
    The end time of the period.
    
    Returns:
    
    The end time of the period.
  - unit
```
public MetricUnit unit()
```
    The unit for the time period request. Valid values are listed below.
    
    If the service returns an enum value that is not available in the current SDK version, unit will return MetricUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().
    
    Returns:
    
    The unit for the time period request. Valid values are listed below.
    
    See Also:
    
    MetricUnit
  - unitAsString
```
public String unitAsString()
```
    The unit for the time period request. Valid values are listed below.
    
    If the service returns an enum value that is not available in the current SDK version, unit will return MetricUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().
    
    Returns:
    
    The unit for the time period request. Valid values are listed below.
    
    See Also:
    
    MetricUnit
  - statistics
```
public List<MetricStatistic> statistics()
```
    An array of statistics that you want to request metrics for. Valid values are listed below.
    - SampleCount - The count (number) of data points used for the statistical calculation.
    - Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed.
    - Sum - All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.
    - Minimum - The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.
    - Maximum - The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    An array of statistics that you want to request metrics for. Valid values are listed below.
    
    SampleCount - The count (number) of data points used for the statistical calculation.
    
    Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed.
    
    Sum - All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.
    
    Minimum - The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.
    
    Maximum - The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.
  - statisticsAsStrings
```
public List<String> statisticsAsStrings()
```
    An array of statistics that you want to request metrics for. Valid values are listed below.
    - SampleCount - The count (number) of data points used for the statistical calculation.
    - Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed.
    - Sum - All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.
    - Minimum - The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.
    - Maximum - The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    An array of statistics that you want to request metrics for. Valid values are listed below.
    
    SampleCount - The count (number) of data points used for the statistical calculation.
    
    Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed.
    
    Sum - All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.
    
    Minimum - The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.
    
    Maximum - The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.
  - toBuilder
```
public GetLoadBalancerMetricDataRequest.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<GetLoadBalancerMetricDataRequest.Builder,GetLoadBalancerMetricDataRequest>
    
    Specified by:
    
    toBuilder in class LightsailRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetLoadBalancerMetricDataRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetLoadBalancerMetricDataRequest.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: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    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.

Class GetLoadBalancerMetricDataRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

loadBalancerName

metricName

metricNameAsString

period

startTime

endTime

unit

unitAsString

statistics

statisticsAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields