Class HealthCheckConfig

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

The health check configuration for a managed endpoint. Defines how the service probes instances in the Auto Scaling group to determine their health status.

See Also:

  • Method Details

    • port

      public final Integer port()

      The port to use for health check probes. Valid range is 80 to 65535.

      Returns:
      The port to use for health check probes. Valid range is 80 to 65535.

    • path

      public final String path()

      The destination path for the health check request. Must start with /.

      Returns:
      The destination path for the health check request. Must start with /.

    • protocol

      public final Protocol protocol()

      The protocol to use for health check probes.

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

      Returns:
      The protocol to use for health check probes.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The protocol to use for health check probes.

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

      Returns:
      The protocol to use for health check probes.
      See Also:

    • timeoutMs

      public final Integer timeoutMs()

      The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.

      Returns:
      The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.

    • intervalSeconds

      public final Integer intervalSeconds()

      The interval between health check probes, in seconds. Valid range is 5 to 60.

      Returns:
      The interval between health check probes, in seconds. Valid range is 5 to 60.

    • statusCodeMatcher

      public final String statusCodeMatcher()

      The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).

      Returns:
      The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).

    • healthyThresholdCount

      public final Integer healthyThresholdCount()

      The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.

      Returns:
      The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.

    • unhealthyThresholdCount

      public final Integer unhealthyThresholdCount()

      The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.

      Returns:
      The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.

    • toBuilder

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

    • builder

      public static HealthCheckConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HealthCheckConfig.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.