Class GatewayConnectorHealthCheck

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

The health check configuration that a gateway uses to evaluate the targets associated with a gateway connector.

See Also:

  • Method Details

    • healthCheckProtocol

      public final GatewayConnectorHealthCheckProtocol healthCheckProtocol()

      The protocol that the gateway uses to perform health checks.

      Valid values:

      • HTTP - Health checks are performed over HTTP.

      • HTTPS - Health checks are performed over HTTPS.

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

      Returns:
      The protocol that the gateway uses to perform health checks.

      Valid values:

      • HTTP - Health checks are performed over HTTP.

      • HTTPS - Health checks are performed over HTTPS.

      See Also:

    • healthCheckProtocolAsString

      public final String healthCheckProtocolAsString()

      The protocol that the gateway uses to perform health checks.

      Valid values:

      • HTTP - Health checks are performed over HTTP.

      • HTTPS - Health checks are performed over HTTPS.

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

      Returns:
      The protocol that the gateway uses to perform health checks.

      Valid values:

      • HTTP - Health checks are performed over HTTP.

      • HTTPS - Health checks are performed over HTTPS.

      See Also:

    • healthCheckPort

      public final Integer healthCheckPort()

      The port that the gateway uses to perform health checks on the targets.

      Returns:
      The port that the gateway uses to perform health checks on the targets.

    • healthCheckPath

      public final String healthCheckPath()

      The destination path for health check requests.

      Returns:
      The destination path for health check requests.

    • healthCheckTimeoutSeconds

      public final Integer healthCheckTimeoutSeconds()

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

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

    • healthCheckIntervalSeconds

      public final Integer healthCheckIntervalSeconds()

      The approximate amount of time, in seconds, between health checks of an individual target.

      Returns:
      The approximate amount of time, in seconds, between health checks of an individual target.

    • healthyThresholdCount

      public final Integer healthyThresholdCount()

      The number of consecutive successful health checks that a target must pass before the gateway considers it healthy.

      Returns:
      The number of consecutive successful health checks that a target must pass before the gateway considers it healthy.

    • unhealthyThresholdCount

      public final Integer unhealthyThresholdCount()

      The number of consecutive failed health checks that a target must fail before the gateway considers it unhealthy.

      Returns:
      The number of consecutive failed health checks that a target must fail before the gateway considers it unhealthy.

    • matcher

      public final GatewayConnectorHealthCheckMatcher matcher()

      The HTTP or gRPC codes that indicate a successful health check response from a target.

      Returns:
      The HTTP or gRPC codes that indicate a successful health check response from a target.

    • toBuilder

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

    • builder

      public static GatewayConnectorHealthCheck.Builder builder()

    • serializableBuilderClass

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