Class HealthCheck

java.lang.Object
software.amazon.awssdk.services.elasticloadbalancing.model.HealthCheck
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HealthCheck.Builder,HealthCheck>
@Generated("software.amazon.awssdk:codegen") public final class HealthCheck extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HealthCheck.Builder,HealthCheck>

Information about a health check.

See Also:

  • Method Details

    • target

      public final String target()

      The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

      TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

      SSL is also specified as SSL: port pair, for example, SSL:5000.

      For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

      The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

      Returns:
      The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

      TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

      SSL is also specified as SSL: port pair, for example, SSL:5000.

      For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

      The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

    • interval

      public final Integer interval()

      The approximate interval, in seconds, between health checks of an individual instance.

      Returns:
      The approximate interval, in seconds, between health checks of an individual instance.

    • timeout

      public final Integer timeout()

      The amount of time, in seconds, during which no response means a failed health check.

      This value must be less than the Interval value.

      Returns:
      The amount of time, in seconds, during which no response means a failed health check.

      This value must be less than the Interval value.

    • unhealthyThreshold

      public final Integer unhealthyThreshold()

      The number of consecutive health check failures required before moving the instance to the Unhealthy state.

      Returns:
      The number of consecutive health check failures required before moving the instance to the Unhealthy state.

    • healthyThreshold

      public final Integer healthyThreshold()

      The number of consecutive health checks successes required before moving the instance to the Healthy state.

      Returns:
      The number of consecutive health checks successes required before moving the instance to the Healthy state.

    • toBuilder

      public HealthCheck.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<HealthCheck.Builder,HealthCheck>
      Returns:
      a builder for type T

    • builder

      public static HealthCheck.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

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

    • sdkFields

      public final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.