Class HealthCheckPolicy

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

An object that represents the health check policy for a virtual node's listener.

See Also:

  • Method Details

    • healthyThreshold

      public final Integer healthyThreshold()

      The number of consecutive successful health checks that must occur before declaring listener healthy.

      Returns:
      The number of consecutive successful health checks that must occur before declaring listener healthy.

    • intervalMillis

      public final Long intervalMillis()

      The time period in milliseconds between each health check execution.

      Returns:
      The time period in milliseconds between each health check execution.

    • path

      public final String path()

      The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

      Returns:
      The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

    • port

      public final Integer port()

      The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

      Returns:
      The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

    • protocol

      public final PortProtocol protocol()

      The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

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

      Returns:
      The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

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

      Returns:
      The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
      See Also:

    • timeoutMillis

      public final Long timeoutMillis()

      The amount of time to wait when receiving a response from the health check, in milliseconds.

      Returns:
      The amount of time to wait when receiving a response from the health check, in milliseconds.

    • unhealthyThreshold

      public final Integer unhealthyThreshold()

      The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

      Returns:
      The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

    • toBuilder

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

    • builder

      public static HealthCheckPolicy.Builder builder()

    • serializableBuilderClass

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