Package io.envoyproxy.envoy.config.core.v3

Class HealthCheck

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.core.v3.HealthCheck
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HealthCheckOrBuilder, Serializable
public final class HealthCheck extends com.google.protobuf.GeneratedMessage implements HealthCheckOrBuilder
 [#next-free-field: 27]
Protobuf type envoy.config.core.v3.HealthCheck
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • healthCheckerCase_

      private int healthCheckerCase_

    • healthChecker_

      private Object healthChecker_

    • TIMEOUT_FIELD_NUMBER

      public static final int TIMEOUT_FIELD_NUMBER
      See Also:

    • timeout_

      private com.google.protobuf.Duration timeout_

    • INTERVAL_FIELD_NUMBER

      public static final int INTERVAL_FIELD_NUMBER
      See Also:

    • interval_

      private com.google.protobuf.Duration interval_

    • INITIAL_JITTER_FIELD_NUMBER

      public static final int INITIAL_JITTER_FIELD_NUMBER
      See Also:

    • initialJitter_

      private com.google.protobuf.Duration initialJitter_

    • INTERVAL_JITTER_FIELD_NUMBER

      public static final int INTERVAL_JITTER_FIELD_NUMBER
      See Also:

    • intervalJitter_

      private com.google.protobuf.Duration intervalJitter_

    • INTERVAL_JITTER_PERCENT_FIELD_NUMBER

      public static final int INTERVAL_JITTER_PERCENT_FIELD_NUMBER
      See Also:

    • intervalJitterPercent_

      private int intervalJitterPercent_

    • UNHEALTHY_THRESHOLD_FIELD_NUMBER

      public static final int UNHEALTHY_THRESHOLD_FIELD_NUMBER
      See Also:

    • unhealthyThreshold_

      private com.google.protobuf.UInt32Value unhealthyThreshold_

    • HEALTHY_THRESHOLD_FIELD_NUMBER

      public static final int HEALTHY_THRESHOLD_FIELD_NUMBER
      See Also:

    • healthyThreshold_

      private com.google.protobuf.UInt32Value healthyThreshold_

    • ALT_PORT_FIELD_NUMBER

      public static final int ALT_PORT_FIELD_NUMBER
      See Also:

    • altPort_

      private com.google.protobuf.UInt32Value altPort_

    • REUSE_CONNECTION_FIELD_NUMBER

      public static final int REUSE_CONNECTION_FIELD_NUMBER
      See Also:

    • reuseConnection_

      private com.google.protobuf.BoolValue reuseConnection_

    • HTTP_HEALTH_CHECK_FIELD_NUMBER

      public static final int HTTP_HEALTH_CHECK_FIELD_NUMBER
      See Also:

    • TCP_HEALTH_CHECK_FIELD_NUMBER

      public static final int TCP_HEALTH_CHECK_FIELD_NUMBER
      See Also:

    • GRPC_HEALTH_CHECK_FIELD_NUMBER

      public static final int GRPC_HEALTH_CHECK_FIELD_NUMBER
      See Also:

    • CUSTOM_HEALTH_CHECK_FIELD_NUMBER

      public static final int CUSTOM_HEALTH_CHECK_FIELD_NUMBER
      See Also:

    • NO_TRAFFIC_INTERVAL_FIELD_NUMBER

      public static final int NO_TRAFFIC_INTERVAL_FIELD_NUMBER
      See Also:

    • noTrafficInterval_

      private com.google.protobuf.Duration noTrafficInterval_

    • NO_TRAFFIC_HEALTHY_INTERVAL_FIELD_NUMBER

      public static final int NO_TRAFFIC_HEALTHY_INTERVAL_FIELD_NUMBER
      See Also:

    • noTrafficHealthyInterval_

      private com.google.protobuf.Duration noTrafficHealthyInterval_

    • UNHEALTHY_INTERVAL_FIELD_NUMBER

      public static final int UNHEALTHY_INTERVAL_FIELD_NUMBER
      See Also:

    • unhealthyInterval_

      private com.google.protobuf.Duration unhealthyInterval_

    • UNHEALTHY_EDGE_INTERVAL_FIELD_NUMBER

      public static final int UNHEALTHY_EDGE_INTERVAL_FIELD_NUMBER
      See Also:

    • unhealthyEdgeInterval_

      private com.google.protobuf.Duration unhealthyEdgeInterval_

    • HEALTHY_EDGE_INTERVAL_FIELD_NUMBER

      public static final int HEALTHY_EDGE_INTERVAL_FIELD_NUMBER
      See Also:

    • healthyEdgeInterval_

      private com.google.protobuf.Duration healthyEdgeInterval_

    • EVENT_LOG_PATH_FIELD_NUMBER

      public static final int EVENT_LOG_PATH_FIELD_NUMBER
      See Also:

    • eventLogPath_

      private volatile Object eventLogPath_

    • EVENT_LOGGER_FIELD_NUMBER

      public static final int EVENT_LOGGER_FIELD_NUMBER
      See Also:

    • eventLogger_

      private List<TypedExtensionConfig> eventLogger_

    • EVENT_SERVICE_FIELD_NUMBER

      public static final int EVENT_SERVICE_FIELD_NUMBER
      See Also:

    • eventService_

      private EventServiceConfig eventService_

    • ALWAYS_LOG_HEALTH_CHECK_FAILURES_FIELD_NUMBER

      public static final int ALWAYS_LOG_HEALTH_CHECK_FAILURES_FIELD_NUMBER
      See Also:

    • alwaysLogHealthCheckFailures_

      private boolean alwaysLogHealthCheckFailures_

    • ALWAYS_LOG_HEALTH_CHECK_SUCCESS_FIELD_NUMBER

      public static final int ALWAYS_LOG_HEALTH_CHECK_SUCCESS_FIELD_NUMBER
      See Also:

    • alwaysLogHealthCheckSuccess_

      private boolean alwaysLogHealthCheckSuccess_

    • TLS_OPTIONS_FIELD_NUMBER

      public static final int TLS_OPTIONS_FIELD_NUMBER
      See Also:

    • tlsOptions_

      private HealthCheck.TlsOptions tlsOptions_

    • TRANSPORT_SOCKET_MATCH_CRITERIA_FIELD_NUMBER

      public static final int TRANSPORT_SOCKET_MATCH_CRITERIA_FIELD_NUMBER
      See Also:

    • transportSocketMatchCriteria_

      private com.google.protobuf.Struct transportSocketMatchCriteria_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final HealthCheck DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<HealthCheck> PARSER

  • Constructor Details

    • HealthCheck

      private HealthCheck(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • HealthCheck

      private HealthCheck()

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getHealthCheckerCase

      public HealthCheck.HealthCheckerCase getHealthCheckerCase()
      Specified by:
      getHealthCheckerCase in interface HealthCheckOrBuilder

    • hasTimeout

      public boolean hasTimeout()
       The time to wait for a health check response. If the timeout is reached the
 health check attempt will be considered a failure.
      .google.protobuf.Duration timeout = 1 [(.validate.rules) = { ... }
      Specified by:
      hasTimeout in interface HealthCheckOrBuilder
      Returns:
      Whether the timeout field is set.

    • getTimeout

      public com.google.protobuf.Duration getTimeout()
       The time to wait for a health check response. If the timeout is reached the
 health check attempt will be considered a failure.
      .google.protobuf.Duration timeout = 1 [(.validate.rules) = { ... }
      Specified by:
      getTimeout in interface HealthCheckOrBuilder
      Returns:
      The timeout.

    • getTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
       The time to wait for a health check response. If the timeout is reached the
 health check attempt will be considered a failure.
      .google.protobuf.Duration timeout = 1 [(.validate.rules) = { ... }
      Specified by:
      getTimeoutOrBuilder in interface HealthCheckOrBuilder

    • hasInterval

      public boolean hasInterval()
       The interval between health checks.
      .google.protobuf.Duration interval = 2 [(.validate.rules) = { ... }
      Specified by:
      hasInterval in interface HealthCheckOrBuilder
      Returns:
      Whether the interval field is set.

    • getInterval

      public com.google.protobuf.Duration getInterval()
       The interval between health checks.
      .google.protobuf.Duration interval = 2 [(.validate.rules) = { ... }
      Specified by:
      getInterval in interface HealthCheckOrBuilder
      Returns:
      The interval.

    • getIntervalOrBuilder

      public com.google.protobuf.DurationOrBuilder getIntervalOrBuilder()
       The interval between health checks.
      .google.protobuf.Duration interval = 2 [(.validate.rules) = { ... }
      Specified by:
      getIntervalOrBuilder in interface HealthCheckOrBuilder

    • hasInitialJitter

      public boolean hasInitialJitter()
       An optional jitter amount in milliseconds. If specified, Envoy will start health
 checking after for a random time in ms between 0 and initial_jitter. This only
 applies to the first health check.
      .google.protobuf.Duration initial_jitter = 20;
      Specified by:
      hasInitialJitter in interface HealthCheckOrBuilder
      Returns:
      Whether the initialJitter field is set.

    • getInitialJitter

      public com.google.protobuf.Duration getInitialJitter()
       An optional jitter amount in milliseconds. If specified, Envoy will start health
 checking after for a random time in ms between 0 and initial_jitter. This only
 applies to the first health check.
      .google.protobuf.Duration initial_jitter = 20;
      Specified by:
      getInitialJitter in interface HealthCheckOrBuilder
      Returns:
      The initialJitter.

    • getInitialJitterOrBuilder

      public com.google.protobuf.DurationOrBuilder getInitialJitterOrBuilder()
       An optional jitter amount in milliseconds. If specified, Envoy will start health
 checking after for a random time in ms between 0 and initial_jitter. This only
 applies to the first health check.
      .google.protobuf.Duration initial_jitter = 20;
      Specified by:
      getInitialJitterOrBuilder in interface HealthCheckOrBuilder

    • hasIntervalJitter

      public boolean hasIntervalJitter()
       An optional jitter amount in milliseconds. If specified, during every
 interval Envoy will add interval_jitter to the wait time.
      .google.protobuf.Duration interval_jitter = 3;
      Specified by:
      hasIntervalJitter in interface HealthCheckOrBuilder
      Returns:
      Whether the intervalJitter field is set.

    • getIntervalJitter

      public com.google.protobuf.Duration getIntervalJitter()
       An optional jitter amount in milliseconds. If specified, during every
 interval Envoy will add interval_jitter to the wait time.
      .google.protobuf.Duration interval_jitter = 3;
      Specified by:
      getIntervalJitter in interface HealthCheckOrBuilder
      Returns:
      The intervalJitter.

    • getIntervalJitterOrBuilder

      public com.google.protobuf.DurationOrBuilder getIntervalJitterOrBuilder()
       An optional jitter amount in milliseconds. If specified, during every
 interval Envoy will add interval_jitter to the wait time.
      .google.protobuf.Duration interval_jitter = 3;
      Specified by:
      getIntervalJitterOrBuilder in interface HealthCheckOrBuilder

    • getIntervalJitterPercent

      public int getIntervalJitterPercent()
       An optional jitter amount as a percentage of interval_ms. If specified,
 during every interval Envoy will add ``interval_ms`` *
 ``interval_jitter_percent`` / 100 to the wait time.

 If interval_jitter_ms and interval_jitter_percent are both set, both of
 them will be used to increase the wait time.
      uint32 interval_jitter_percent = 18;
      Specified by:
      getIntervalJitterPercent in interface HealthCheckOrBuilder
      Returns:
      The intervalJitterPercent.

    • hasUnhealthyThreshold

      public boolean hasUnhealthyThreshold()
       The number of unhealthy health checks required before a host is marked
 unhealthy. Note that for ``http`` health checking if a host responds with a code not in
 :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>`
 or :ref:`retriable_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.retriable_statuses>`,
 this threshold is ignored and the host is considered immediately unhealthy.
      .google.protobuf.UInt32Value unhealthy_threshold = 4 [(.validate.rules) = { ... }
      Specified by:
      hasUnhealthyThreshold in interface HealthCheckOrBuilder
      Returns:
      Whether the unhealthyThreshold field is set.

    • getUnhealthyThreshold

      public com.google.protobuf.UInt32Value getUnhealthyThreshold()
       The number of unhealthy health checks required before a host is marked
 unhealthy. Note that for ``http`` health checking if a host responds with a code not in
 :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>`
 or :ref:`retriable_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.retriable_statuses>`,
 this threshold is ignored and the host is considered immediately unhealthy.
      .google.protobuf.UInt32Value unhealthy_threshold = 4 [(.validate.rules) = { ... }
      Specified by:
      getUnhealthyThreshold in interface HealthCheckOrBuilder
      Returns:
      The unhealthyThreshold.

    • getUnhealthyThresholdOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getUnhealthyThresholdOrBuilder()
       The number of unhealthy health checks required before a host is marked
 unhealthy. Note that for ``http`` health checking if a host responds with a code not in
 :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>`
 or :ref:`retriable_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.retriable_statuses>`,
 this threshold is ignored and the host is considered immediately unhealthy.
      .google.protobuf.UInt32Value unhealthy_threshold = 4 [(.validate.rules) = { ... }
      Specified by:
      getUnhealthyThresholdOrBuilder in interface HealthCheckOrBuilder

    • hasHealthyThreshold

      public boolean hasHealthyThreshold()
       The number of healthy health checks required before a host is marked
 healthy. Note that during startup, only a single successful health check is
 required to mark a host healthy.
      .google.protobuf.UInt32Value healthy_threshold = 5 [(.validate.rules) = { ... }
      Specified by:
      hasHealthyThreshold in interface HealthCheckOrBuilder
      Returns:
      Whether the healthyThreshold field is set.

    • getHealthyThreshold

      public com.google.protobuf.UInt32Value getHealthyThreshold()
       The number of healthy health checks required before a host is marked
 healthy. Note that during startup, only a single successful health check is
 required to mark a host healthy.
      .google.protobuf.UInt32Value healthy_threshold = 5 [(.validate.rules) = { ... }
      Specified by:
      getHealthyThreshold in interface HealthCheckOrBuilder
      Returns:
      The healthyThreshold.

    • getHealthyThresholdOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getHealthyThresholdOrBuilder()
       The number of healthy health checks required before a host is marked
 healthy. Note that during startup, only a single successful health check is
 required to mark a host healthy.
      .google.protobuf.UInt32Value healthy_threshold = 5 [(.validate.rules) = { ... }
      Specified by:
      getHealthyThresholdOrBuilder in interface HealthCheckOrBuilder

    • hasAltPort

      public boolean hasAltPort()
       [#not-implemented-hide:] Non-serving port for health checking.
      .google.protobuf.UInt32Value alt_port = 6;
      Specified by:
      hasAltPort in interface HealthCheckOrBuilder
      Returns:
      Whether the altPort field is set.

    • getAltPort

      public com.google.protobuf.UInt32Value getAltPort()
       [#not-implemented-hide:] Non-serving port for health checking.
      .google.protobuf.UInt32Value alt_port = 6;
      Specified by:
      getAltPort in interface HealthCheckOrBuilder
      Returns:
      The altPort.

    • getAltPortOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getAltPortOrBuilder()
       [#not-implemented-hide:] Non-serving port for health checking.
      .google.protobuf.UInt32Value alt_port = 6;
      Specified by:
      getAltPortOrBuilder in interface HealthCheckOrBuilder

    • hasReuseConnection

      public boolean hasReuseConnection()
       Reuse health check connection between health checks. Default is true.
      .google.protobuf.BoolValue reuse_connection = 7;
      Specified by:
      hasReuseConnection in interface HealthCheckOrBuilder
      Returns:
      Whether the reuseConnection field is set.

    • getReuseConnection

      public com.google.protobuf.BoolValue getReuseConnection()
       Reuse health check connection between health checks. Default is true.
      .google.protobuf.BoolValue reuse_connection = 7;
      Specified by:
      getReuseConnection in interface HealthCheckOrBuilder
      Returns:
      The reuseConnection.

    • getReuseConnectionOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getReuseConnectionOrBuilder()
       Reuse health check connection between health checks. Default is true.
      .google.protobuf.BoolValue reuse_connection = 7;
      Specified by:
      getReuseConnectionOrBuilder in interface HealthCheckOrBuilder

    • hasHttpHealthCheck

      public boolean hasHttpHealthCheck()
       HTTP health check.
      .envoy.config.core.v3.HealthCheck.HttpHealthCheck http_health_check = 8;
      Specified by:
      hasHttpHealthCheck in interface HealthCheckOrBuilder
      Returns:
      Whether the httpHealthCheck field is set.

    • getHttpHealthCheck

      public HealthCheck.HttpHealthCheck getHttpHealthCheck()
       HTTP health check.
      .envoy.config.core.v3.HealthCheck.HttpHealthCheck http_health_check = 8;
      Specified by:
      getHttpHealthCheck in interface HealthCheckOrBuilder
      Returns:
      The httpHealthCheck.

    • getHttpHealthCheckOrBuilder

      public HealthCheck.HttpHealthCheckOrBuilder getHttpHealthCheckOrBuilder()
       HTTP health check.
      .envoy.config.core.v3.HealthCheck.HttpHealthCheck http_health_check = 8;
      Specified by:
      getHttpHealthCheckOrBuilder in interface HealthCheckOrBuilder

    • hasTcpHealthCheck

      public boolean hasTcpHealthCheck()
       TCP health check.
      .envoy.config.core.v3.HealthCheck.TcpHealthCheck tcp_health_check = 9;
      Specified by:
      hasTcpHealthCheck in interface HealthCheckOrBuilder
      Returns:
      Whether the tcpHealthCheck field is set.

    • getTcpHealthCheck

      public HealthCheck.TcpHealthCheck getTcpHealthCheck()
       TCP health check.
      .envoy.config.core.v3.HealthCheck.TcpHealthCheck tcp_health_check = 9;
      Specified by:
      getTcpHealthCheck in interface HealthCheckOrBuilder
      Returns:
      The tcpHealthCheck.

    • getTcpHealthCheckOrBuilder

      public HealthCheck.TcpHealthCheckOrBuilder getTcpHealthCheckOrBuilder()
       TCP health check.
      .envoy.config.core.v3.HealthCheck.TcpHealthCheck tcp_health_check = 9;
      Specified by:
      getTcpHealthCheckOrBuilder in interface HealthCheckOrBuilder

    • hasGrpcHealthCheck

      public boolean hasGrpcHealthCheck()
       gRPC health check.
      .envoy.config.core.v3.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
      Specified by:
      hasGrpcHealthCheck in interface HealthCheckOrBuilder
      Returns:
      Whether the grpcHealthCheck field is set.

    • getGrpcHealthCheck

      public HealthCheck.GrpcHealthCheck getGrpcHealthCheck()
       gRPC health check.
      .envoy.config.core.v3.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
      Specified by:
      getGrpcHealthCheck in interface HealthCheckOrBuilder
      Returns:
      The grpcHealthCheck.

    • getGrpcHealthCheckOrBuilder

      public HealthCheck.GrpcHealthCheckOrBuilder getGrpcHealthCheckOrBuilder()
       gRPC health check.
      .envoy.config.core.v3.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
      Specified by:
      getGrpcHealthCheckOrBuilder in interface HealthCheckOrBuilder

    • hasCustomHealthCheck

      public boolean hasCustomHealthCheck()
       Custom health check.
      .envoy.config.core.v3.HealthCheck.CustomHealthCheck custom_health_check = 13;
      Specified by:
      hasCustomHealthCheck in interface HealthCheckOrBuilder
      Returns:
      Whether the customHealthCheck field is set.

    • getCustomHealthCheck

      public HealthCheck.CustomHealthCheck getCustomHealthCheck()
       Custom health check.
      .envoy.config.core.v3.HealthCheck.CustomHealthCheck custom_health_check = 13;
      Specified by:
      getCustomHealthCheck in interface HealthCheckOrBuilder
      Returns:
      The customHealthCheck.

    • getCustomHealthCheckOrBuilder

      public HealthCheck.CustomHealthCheckOrBuilder getCustomHealthCheckOrBuilder()
       Custom health check.
      .envoy.config.core.v3.HealthCheck.CustomHealthCheck custom_health_check = 13;
      Specified by:
      getCustomHealthCheckOrBuilder in interface HealthCheckOrBuilder

    • hasNoTrafficInterval

      public boolean hasNoTrafficInterval()
       The "no traffic interval" is a special health check interval that is used when a cluster has
 never had traffic routed to it. This lower interval allows cluster information to be kept up to
 date, without sending a potentially large amount of active health checking traffic for no
 reason. Once a cluster has been used for traffic routing, Envoy will shift back to using the
 standard health check interval that is defined. Note that this interval takes precedence over
 any other.

 The default value for "no traffic interval" is 60 seconds.
      .google.protobuf.Duration no_traffic_interval = 12 [(.validate.rules) = { ... }
      Specified by:
      hasNoTrafficInterval in interface HealthCheckOrBuilder
      Returns:
      Whether the noTrafficInterval field is set.

    • getNoTrafficInterval

      public com.google.protobuf.Duration getNoTrafficInterval()
       The "no traffic interval" is a special health check interval that is used when a cluster has
 never had traffic routed to it. This lower interval allows cluster information to be kept up to
 date, without sending a potentially large amount of active health checking traffic for no
 reason. Once a cluster has been used for traffic routing, Envoy will shift back to using the
 standard health check interval that is defined. Note that this interval takes precedence over
 any other.

 The default value for "no traffic interval" is 60 seconds.
      .google.protobuf.Duration no_traffic_interval = 12 [(.validate.rules) = { ... }
      Specified by:
      getNoTrafficInterval in interface HealthCheckOrBuilder
      Returns:
      The noTrafficInterval.

    • getNoTrafficIntervalOrBuilder

      public com.google.protobuf.DurationOrBuilder getNoTrafficIntervalOrBuilder()
       The "no traffic interval" is a special health check interval that is used when a cluster has
 never had traffic routed to it. This lower interval allows cluster information to be kept up to
 date, without sending a potentially large amount of active health checking traffic for no
 reason. Once a cluster has been used for traffic routing, Envoy will shift back to using the
 standard health check interval that is defined. Note that this interval takes precedence over
 any other.

 The default value for "no traffic interval" is 60 seconds.
      .google.protobuf.Duration no_traffic_interval = 12 [(.validate.rules) = { ... }
      Specified by:
      getNoTrafficIntervalOrBuilder in interface HealthCheckOrBuilder

    • hasNoTrafficHealthyInterval

      public boolean hasNoTrafficHealthyInterval()
       The "no traffic healthy interval" is a special health check interval that
 is used for hosts that are currently passing active health checking
 (including new hosts) when the cluster has received no traffic.

 This is useful for when we want to send frequent health checks with
 ``no_traffic_interval`` but then revert to lower frequency ``no_traffic_healthy_interval`` once
 a host in the cluster is marked as healthy.

 Once a cluster has been used for traffic routing, Envoy will shift back to using the
 standard health check interval that is defined.

 If no_traffic_healthy_interval is not set, it will default to the
 no traffic interval and send that interval regardless of health state.
      .google.protobuf.Duration no_traffic_healthy_interval = 24 [(.validate.rules) = { ... }
      Specified by:
      hasNoTrafficHealthyInterval in interface HealthCheckOrBuilder
      Returns:
      Whether the noTrafficHealthyInterval field is set.

    • getNoTrafficHealthyInterval

      public com.google.protobuf.Duration getNoTrafficHealthyInterval()
       The "no traffic healthy interval" is a special health check interval that
 is used for hosts that are currently passing active health checking
 (including new hosts) when the cluster has received no traffic.

 This is useful for when we want to send frequent health checks with
 ``no_traffic_interval`` but then revert to lower frequency ``no_traffic_healthy_interval`` once
 a host in the cluster is marked as healthy.

 Once a cluster has been used for traffic routing, Envoy will shift back to using the
 standard health check interval that is defined.

 If no_traffic_healthy_interval is not set, it will default to the
 no traffic interval and send that interval regardless of health state.
      .google.protobuf.Duration no_traffic_healthy_interval = 24 [(.validate.rules) = { ... }
      Specified by:
      getNoTrafficHealthyInterval in interface HealthCheckOrBuilder
      Returns:
      The noTrafficHealthyInterval.

    • getNoTrafficHealthyIntervalOrBuilder

      public com.google.protobuf.DurationOrBuilder getNoTrafficHealthyIntervalOrBuilder()
       The "no traffic healthy interval" is a special health check interval that
 is used for hosts that are currently passing active health checking
 (including new hosts) when the cluster has received no traffic.

 This is useful for when we want to send frequent health checks with
 ``no_traffic_interval`` but then revert to lower frequency ``no_traffic_healthy_interval`` once
 a host in the cluster is marked as healthy.

 Once a cluster has been used for traffic routing, Envoy will shift back to using the
 standard health check interval that is defined.

 If no_traffic_healthy_interval is not set, it will default to the
 no traffic interval and send that interval regardless of health state.
      .google.protobuf.Duration no_traffic_healthy_interval = 24 [(.validate.rules) = { ... }
      Specified by:
      getNoTrafficHealthyIntervalOrBuilder in interface HealthCheckOrBuilder

    • hasUnhealthyInterval

      public boolean hasUnhealthyInterval()
       The "unhealthy interval" is a health check interval that is used for hosts that are marked as
 unhealthy. As soon as the host is marked as healthy, Envoy will shift back to using the
 standard health check interval that is defined.

 The default value for "unhealthy interval" is the same as "interval".
      .google.protobuf.Duration unhealthy_interval = 14 [(.validate.rules) = { ... }
      Specified by:
      hasUnhealthyInterval in interface HealthCheckOrBuilder
      Returns:
      Whether the unhealthyInterval field is set.

    • getUnhealthyInterval

      public com.google.protobuf.Duration getUnhealthyInterval()
       The "unhealthy interval" is a health check interval that is used for hosts that are marked as
 unhealthy. As soon as the host is marked as healthy, Envoy will shift back to using the
 standard health check interval that is defined.

 The default value for "unhealthy interval" is the same as "interval".
      .google.protobuf.Duration unhealthy_interval = 14 [(.validate.rules) = { ... }
      Specified by:
      getUnhealthyInterval in interface HealthCheckOrBuilder
      Returns:
      The unhealthyInterval.

    • getUnhealthyIntervalOrBuilder

      public com.google.protobuf.DurationOrBuilder getUnhealthyIntervalOrBuilder()
       The "unhealthy interval" is a health check interval that is used for hosts that are marked as
 unhealthy. As soon as the host is marked as healthy, Envoy will shift back to using the
 standard health check interval that is defined.

 The default value for "unhealthy interval" is the same as "interval".
      .google.protobuf.Duration unhealthy_interval = 14 [(.validate.rules) = { ... }
      Specified by:
      getUnhealthyIntervalOrBuilder in interface HealthCheckOrBuilder

    • hasUnhealthyEdgeInterval

      public boolean hasUnhealthyEdgeInterval()
       The "unhealthy edge interval" is a special health check interval that is used for the first
 health check right after a host is marked as unhealthy. For subsequent health checks
 Envoy will shift back to using either "unhealthy interval" if present or the standard health
 check interval that is defined.

 The default value for "unhealthy edge interval" is the same as "unhealthy interval".
      .google.protobuf.Duration unhealthy_edge_interval = 15 [(.validate.rules) = { ... }
      Specified by:
      hasUnhealthyEdgeInterval in interface HealthCheckOrBuilder
      Returns:
      Whether the unhealthyEdgeInterval field is set.

    • getUnhealthyEdgeInterval

      public com.google.protobuf.Duration getUnhealthyEdgeInterval()
       The "unhealthy edge interval" is a special health check interval that is used for the first
 health check right after a host is marked as unhealthy. For subsequent health checks
 Envoy will shift back to using either "unhealthy interval" if present or the standard health
 check interval that is defined.

 The default value for "unhealthy edge interval" is the same as "unhealthy interval".
      .google.protobuf.Duration unhealthy_edge_interval = 15 [(.validate.rules) = { ... }
      Specified by:
      getUnhealthyEdgeInterval in interface HealthCheckOrBuilder
      Returns:
      The unhealthyEdgeInterval.

    • getUnhealthyEdgeIntervalOrBuilder

      public com.google.protobuf.DurationOrBuilder getUnhealthyEdgeIntervalOrBuilder()
       The "unhealthy edge interval" is a special health check interval that is used for the first
 health check right after a host is marked as unhealthy. For subsequent health checks
 Envoy will shift back to using either "unhealthy interval" if present or the standard health
 check interval that is defined.

 The default value for "unhealthy edge interval" is the same as "unhealthy interval".
      .google.protobuf.Duration unhealthy_edge_interval = 15 [(.validate.rules) = { ... }
      Specified by:
      getUnhealthyEdgeIntervalOrBuilder in interface HealthCheckOrBuilder

    • hasHealthyEdgeInterval

      public boolean hasHealthyEdgeInterval()
       The "healthy edge interval" is a special health check interval that is used for the first
 health check right after a host is marked as healthy. For subsequent health checks
 Envoy will shift back to using the standard health check interval that is defined.

 The default value for "healthy edge interval" is the same as the default interval.
      .google.protobuf.Duration healthy_edge_interval = 16 [(.validate.rules) = { ... }
      Specified by:
      hasHealthyEdgeInterval in interface HealthCheckOrBuilder
      Returns:
      Whether the healthyEdgeInterval field is set.

    • getHealthyEdgeInterval

      public com.google.protobuf.Duration getHealthyEdgeInterval()
       The "healthy edge interval" is a special health check interval that is used for the first
 health check right after a host is marked as healthy. For subsequent health checks
 Envoy will shift back to using the standard health check interval that is defined.

 The default value for "healthy edge interval" is the same as the default interval.
      .google.protobuf.Duration healthy_edge_interval = 16 [(.validate.rules) = { ... }
      Specified by:
      getHealthyEdgeInterval in interface HealthCheckOrBuilder
      Returns:
      The healthyEdgeInterval.

    • getHealthyEdgeIntervalOrBuilder

      public com.google.protobuf.DurationOrBuilder getHealthyEdgeIntervalOrBuilder()
       The "healthy edge interval" is a special health check interval that is used for the first
 health check right after a host is marked as healthy. For subsequent health checks
 Envoy will shift back to using the standard health check interval that is defined.

 The default value for "healthy edge interval" is the same as the default interval.
      .google.protobuf.Duration healthy_edge_interval = 16 [(.validate.rules) = { ... }
      Specified by:
      getHealthyEdgeIntervalOrBuilder in interface HealthCheckOrBuilder

    • getEventLogPath

      @Deprecated public String getEventLogPath()
      Deprecated.
      envoy.config.core.v3.HealthCheck.event_log_path is deprecated. See envoy/config/core/v3/health_check.proto;l=384
       .. attention::
 This field is deprecated in favor of the extension
 :ref:`event_logger <envoy_v3_api_field_config.core.v3.HealthCheck.event_logger>` and
 :ref:`event_log_path <envoy_v3_api_field_extensions.health_check.event_sinks.file.v3.HealthCheckEventFileSink.event_log_path>`
 in the file sink extension.

 Specifies the path to the :ref:`health check event log <arch_overview_health_check_logging>`.
      string event_log_path = 17 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getEventLogPath in interface HealthCheckOrBuilder
      Returns:
      The eventLogPath.

    • getEventLogPathBytes

      @Deprecated public com.google.protobuf.ByteString getEventLogPathBytes()
      Deprecated.
      envoy.config.core.v3.HealthCheck.event_log_path is deprecated. See envoy/config/core/v3/health_check.proto;l=384
       .. attention::
 This field is deprecated in favor of the extension
 :ref:`event_logger <envoy_v3_api_field_config.core.v3.HealthCheck.event_logger>` and
 :ref:`event_log_path <envoy_v3_api_field_extensions.health_check.event_sinks.file.v3.HealthCheckEventFileSink.event_log_path>`
 in the file sink extension.

 Specifies the path to the :ref:`health check event log <arch_overview_health_check_logging>`.
      string event_log_path = 17 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getEventLogPathBytes in interface HealthCheckOrBuilder
      Returns:
      The bytes for eventLogPath.

    • getEventLoggerList

      public List<TypedExtensionConfig> getEventLoggerList()
       A list of event log sinks to process the health check event.
 [#extension-category: envoy.health_check.event_sinks]
      repeated .envoy.config.core.v3.TypedExtensionConfig event_logger = 25;
      Specified by:
      getEventLoggerList in interface HealthCheckOrBuilder

    • getEventLoggerOrBuilderList

      public List<? extends TypedExtensionConfigOrBuilder> getEventLoggerOrBuilderList()
       A list of event log sinks to process the health check event.
 [#extension-category: envoy.health_check.event_sinks]
      repeated .envoy.config.core.v3.TypedExtensionConfig event_logger = 25;
      Specified by:
      getEventLoggerOrBuilderList in interface HealthCheckOrBuilder

    • getEventLoggerCount

      public int getEventLoggerCount()
       A list of event log sinks to process the health check event.
 [#extension-category: envoy.health_check.event_sinks]
      repeated .envoy.config.core.v3.TypedExtensionConfig event_logger = 25;
      Specified by:
      getEventLoggerCount in interface HealthCheckOrBuilder

    • getEventLogger

      public TypedExtensionConfig getEventLogger(int index)
       A list of event log sinks to process the health check event.
 [#extension-category: envoy.health_check.event_sinks]
      repeated .envoy.config.core.v3.TypedExtensionConfig event_logger = 25;
      Specified by:
      getEventLogger in interface HealthCheckOrBuilder

    • getEventLoggerOrBuilder

      public TypedExtensionConfigOrBuilder getEventLoggerOrBuilder(int index)
       A list of event log sinks to process the health check event.
 [#extension-category: envoy.health_check.event_sinks]
      repeated .envoy.config.core.v3.TypedExtensionConfig event_logger = 25;
      Specified by:
      getEventLoggerOrBuilder in interface HealthCheckOrBuilder

    • hasEventService

      public boolean hasEventService()
       [#not-implemented-hide:]
 The gRPC service for the health check event service.
 If empty, health check events won't be sent to a remote endpoint.
      .envoy.config.core.v3.EventServiceConfig event_service = 22;
      Specified by:
      hasEventService in interface HealthCheckOrBuilder
      Returns:
      Whether the eventService field is set.

    • getEventService

      public EventServiceConfig getEventService()
       [#not-implemented-hide:]
 The gRPC service for the health check event service.
 If empty, health check events won't be sent to a remote endpoint.
      .envoy.config.core.v3.EventServiceConfig event_service = 22;
      Specified by:
      getEventService in interface HealthCheckOrBuilder
      Returns:
      The eventService.

    • getEventServiceOrBuilder

      public EventServiceConfigOrBuilder getEventServiceOrBuilder()
       [#not-implemented-hide:]
 The gRPC service for the health check event service.
 If empty, health check events won't be sent to a remote endpoint.
      .envoy.config.core.v3.EventServiceConfig event_service = 22;
      Specified by:
      getEventServiceOrBuilder in interface HealthCheckOrBuilder

    • getAlwaysLogHealthCheckFailures

      public boolean getAlwaysLogHealthCheckFailures()
       If set to true, health check failure events will always be logged. If set to false, only the
 initial health check failure event will be logged.
 The default value is false.
      bool always_log_health_check_failures = 19;
      Specified by:
      getAlwaysLogHealthCheckFailures in interface HealthCheckOrBuilder
      Returns:
      The alwaysLogHealthCheckFailures.

    • getAlwaysLogHealthCheckSuccess

      public boolean getAlwaysLogHealthCheckSuccess()
       If set to true, health check success events will always be logged. If set to false, only host addition event will be logged
 if it is the first successful health check, or if the healthy threshold is reached.
 The default value is false.
      bool always_log_health_check_success = 26;
      Specified by:
      getAlwaysLogHealthCheckSuccess in interface HealthCheckOrBuilder
      Returns:
      The alwaysLogHealthCheckSuccess.

    • hasTlsOptions

      public boolean hasTlsOptions()
       This allows overriding the cluster TLS settings, just for health check connections.
      .envoy.config.core.v3.HealthCheck.TlsOptions tls_options = 21;
      Specified by:
      hasTlsOptions in interface HealthCheckOrBuilder
      Returns:
      Whether the tlsOptions field is set.

    • getTlsOptions

      public HealthCheck.TlsOptions getTlsOptions()
       This allows overriding the cluster TLS settings, just for health check connections.
      .envoy.config.core.v3.HealthCheck.TlsOptions tls_options = 21;
      Specified by:
      getTlsOptions in interface HealthCheckOrBuilder
      Returns:
      The tlsOptions.

    • getTlsOptionsOrBuilder

      public HealthCheck.TlsOptionsOrBuilder getTlsOptionsOrBuilder()
       This allows overriding the cluster TLS settings, just for health check connections.
      .envoy.config.core.v3.HealthCheck.TlsOptions tls_options = 21;
      Specified by:
      getTlsOptionsOrBuilder in interface HealthCheckOrBuilder

    • hasTransportSocketMatchCriteria

      public boolean hasTransportSocketMatchCriteria()
       Optional key/value pairs that will be used to match a transport socket from those specified in the cluster's
 :ref:`tranport socket matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`.
 For example, the following match criteria

 .. code-block:: yaml

 transport_socket_match_criteria:
 useMTLS: true

 Will match the following :ref:`cluster socket match <envoy_v3_api_msg_config.cluster.v3.Cluster.TransportSocketMatch>`

 .. code-block:: yaml

 transport_socket_matches:
 - name: "useMTLS"
 match:
 useMTLS: true
 transport_socket:
 name: envoy.transport_sockets.tls
 config: { ... } # tls socket configuration

 If this field is set, then for health checks it will supersede an entry of ``envoy.transport_socket`` in the
 :ref:`LbEndpoint.Metadata <envoy_v3_api_field_config.endpoint.v3.LbEndpoint.metadata>`.
 This allows using different transport socket capabilities for health checking versus proxying to the
 endpoint.

 If the key/values pairs specified do not match any
 :ref:`transport socket matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`,
 the cluster's :ref:`transport socket <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket>`
 will be used for health check socket configuration.
      .google.protobuf.Struct transport_socket_match_criteria = 23;
      Specified by:
      hasTransportSocketMatchCriteria in interface HealthCheckOrBuilder
      Returns:
      Whether the transportSocketMatchCriteria field is set.

    • getTransportSocketMatchCriteria

      public com.google.protobuf.Struct getTransportSocketMatchCriteria()
       Optional key/value pairs that will be used to match a transport socket from those specified in the cluster's
 :ref:`tranport socket matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`.
 For example, the following match criteria

 .. code-block:: yaml

 transport_socket_match_criteria:
 useMTLS: true

 Will match the following :ref:`cluster socket match <envoy_v3_api_msg_config.cluster.v3.Cluster.TransportSocketMatch>`

 .. code-block:: yaml

 transport_socket_matches:
 - name: "useMTLS"
 match:
 useMTLS: true
 transport_socket:
 name: envoy.transport_sockets.tls
 config: { ... } # tls socket configuration

 If this field is set, then for health checks it will supersede an entry of ``envoy.transport_socket`` in the
 :ref:`LbEndpoint.Metadata <envoy_v3_api_field_config.endpoint.v3.LbEndpoint.metadata>`.
 This allows using different transport socket capabilities for health checking versus proxying to the
 endpoint.

 If the key/values pairs specified do not match any
 :ref:`transport socket matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`,
 the cluster's :ref:`transport socket <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket>`
 will be used for health check socket configuration.
      .google.protobuf.Struct transport_socket_match_criteria = 23;
      Specified by:
      getTransportSocketMatchCriteria in interface HealthCheckOrBuilder
      Returns:
      The transportSocketMatchCriteria.

    • getTransportSocketMatchCriteriaOrBuilder

      public com.google.protobuf.StructOrBuilder getTransportSocketMatchCriteriaOrBuilder()
       Optional key/value pairs that will be used to match a transport socket from those specified in the cluster's
 :ref:`tranport socket matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`.
 For example, the following match criteria

 .. code-block:: yaml

 transport_socket_match_criteria:
 useMTLS: true

 Will match the following :ref:`cluster socket match <envoy_v3_api_msg_config.cluster.v3.Cluster.TransportSocketMatch>`

 .. code-block:: yaml

 transport_socket_matches:
 - name: "useMTLS"
 match:
 useMTLS: true
 transport_socket:
 name: envoy.transport_sockets.tls
 config: { ... } # tls socket configuration

 If this field is set, then for health checks it will supersede an entry of ``envoy.transport_socket`` in the
 :ref:`LbEndpoint.Metadata <envoy_v3_api_field_config.endpoint.v3.LbEndpoint.metadata>`.
 This allows using different transport socket capabilities for health checking versus proxying to the
 endpoint.

 If the key/values pairs specified do not match any
 :ref:`transport socket matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`,
 the cluster's :ref:`transport socket <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket>`
 will be used for health check socket configuration.
      .google.protobuf.Struct transport_socket_match_criteria = 23;
      Specified by:
      getTransportSocketMatchCriteriaOrBuilder in interface HealthCheckOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static HealthCheck parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthCheck parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthCheck parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthCheck parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthCheck parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthCheck parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthCheck parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HealthCheck parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HealthCheck parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HealthCheck parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HealthCheck parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HealthCheck parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public HealthCheck.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static HealthCheck.Builder newBuilder()

    • newBuilder

      public static HealthCheck.Builder newBuilder(HealthCheck prototype)

    • toBuilder

      public HealthCheck.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected HealthCheck.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static HealthCheck getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<HealthCheck> parser()

    • getParserForType

      public com.google.protobuf.Parser<HealthCheck> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public HealthCheck getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder