HealthCheck (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.config.core.v4alpha.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.GeneratedMessageV3
implements HealthCheckOrBuilder
```
```
 [#next-free-field: 25]
 
```
Protobuf type envoy.config.core.v4alpha.HealthCheck
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HealthCheck.Builder` [#next-free-field: 25] Protobuf type `envoy.config.core.v4alpha.HealthCheck`
`static class`	`HealthCheck.CustomHealthCheck` Custom health check.
`static interface`	`HealthCheck.CustomHealthCheckOrBuilder`
`static class`	`HealthCheck.GrpcHealthCheck` `grpc.health.v1.Health <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto>`_-based healthcheck.
`static interface`	`HealthCheck.GrpcHealthCheckOrBuilder`
`static class`	`HealthCheck.HealthCheckerCase`
`static class`	`HealthCheck.HttpHealthCheck` [#next-free-field: 12] Protobuf type `envoy.config.core.v4alpha.HealthCheck.HttpHealthCheck`
`static interface`	`HealthCheck.HttpHealthCheckOrBuilder`
`static class`	`HealthCheck.Payload` Describes the encoding of the payload bytes in the payload.
`static interface`	`HealthCheck.PayloadOrBuilder`
`static class`	`HealthCheck.RedisHealthCheck` Protobuf type `envoy.config.core.v4alpha.HealthCheck.RedisHealthCheck`
`static interface`	`HealthCheck.RedisHealthCheckOrBuilder`
`static class`	`HealthCheck.TcpHealthCheck` Protobuf type `envoy.config.core.v4alpha.HealthCheck.TcpHealthCheck`
`static interface`	`HealthCheck.TcpHealthCheckOrBuilder`
`static class`	`HealthCheck.TlsOptions` Health checks occur over the transport socket specified for the cluster.
`static interface`	`HealthCheck.TlsOptionsOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALT_PORT_FIELD_NUMBER`
`static int`	`ALWAYS_LOG_HEALTH_CHECK_FAILURES_FIELD_NUMBER`
`static int`	`CUSTOM_HEALTH_CHECK_FIELD_NUMBER`
`static int`	`EVENT_LOG_PATH_FIELD_NUMBER`
`static int`	`EVENT_SERVICE_FIELD_NUMBER`
`static int`	`GRPC_HEALTH_CHECK_FIELD_NUMBER`
`static int`	`HEALTHY_EDGE_INTERVAL_FIELD_NUMBER`
`static int`	`HEALTHY_THRESHOLD_FIELD_NUMBER`
`static int`	`HTTP_HEALTH_CHECK_FIELD_NUMBER`
`static int`	`INITIAL_JITTER_FIELD_NUMBER`
`static int`	`INTERVAL_FIELD_NUMBER`
`static int`	`INTERVAL_JITTER_FIELD_NUMBER`
`static int`	`INTERVAL_JITTER_PERCENT_FIELD_NUMBER`
`static int`	`NO_TRAFFIC_HEALTHY_INTERVAL_FIELD_NUMBER`
`static int`	`NO_TRAFFIC_INTERVAL_FIELD_NUMBER`
`static int`	`REUSE_CONNECTION_FIELD_NUMBER`
`static int`	`TCP_HEALTH_CHECK_FIELD_NUMBER`
`static int`	`TIMEOUT_FIELD_NUMBER`
`static int`	`TLS_OPTIONS_FIELD_NUMBER`
`static int`	`TRANSPORT_SOCKET_MATCH_CRITERIA_FIELD_NUMBER`
`static int`	`UNHEALTHY_EDGE_INTERVAL_FIELD_NUMBER`
`static int`	`UNHEALTHY_INTERVAL_FIELD_NUMBER`
`static int`	`UNHEALTHY_THRESHOLD_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`com.google.protobuf.UInt32Value`	`getAltPort()` [#not-implemented-hide:] Non-serving port for health checking.
`com.google.protobuf.UInt32ValueOrBuilder`	`getAltPortOrBuilder()` [#not-implemented-hide:] Non-serving port for health checking.
`boolean`	`getAlwaysLogHealthCheckFailures()` If set to true, health check failure events will always be logged.
`HealthCheck.CustomHealthCheck`	`getCustomHealthCheck()` Custom health check.
`HealthCheck.CustomHealthCheckOrBuilder`	`getCustomHealthCheckOrBuilder()` Custom health check.
`static HealthCheck`	`getDefaultInstance()`
`HealthCheck`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getEventLogPath()` Specifies the path to the :ref:`health check event log <arch_overview_health_check_logging>`.
`com.google.protobuf.ByteString`	`getEventLogPathBytes()` Specifies the path to the :ref:`health check event log <arch_overview_health_check_logging>`.
`EventServiceConfig`	`getEventService()` [#not-implemented-hide:] The gRPC service for the health check event service.
`EventServiceConfigOrBuilder`	`getEventServiceOrBuilder()` [#not-implemented-hide:] The gRPC service for the health check event service.
`HealthCheck.GrpcHealthCheck`	`getGrpcHealthCheck()` gRPC health check.
`HealthCheck.GrpcHealthCheckOrBuilder`	`getGrpcHealthCheckOrBuilder()` gRPC health check.
`HealthCheck.HealthCheckerCase`	`getHealthCheckerCase()`
`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.
`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.
`com.google.protobuf.UInt32Value`	`getHealthyThreshold()` The number of healthy health checks required before a host is marked healthy.
`com.google.protobuf.UInt32ValueOrBuilder`	`getHealthyThresholdOrBuilder()` The number of healthy health checks required before a host is marked healthy.
`HealthCheck.HttpHealthCheck`	`getHttpHealthCheck()` HTTP health check.
`HealthCheck.HttpHealthCheckOrBuilder`	`getHttpHealthCheckOrBuilder()` HTTP health check.
`com.google.protobuf.Duration`	`getInitialJitter()` An optional jitter amount in milliseconds.
`com.google.protobuf.DurationOrBuilder`	`getInitialJitterOrBuilder()` An optional jitter amount in milliseconds.
`com.google.protobuf.Duration`	`getInterval()` The interval between health checks.
`com.google.protobuf.Duration`	`getIntervalJitter()` An optional jitter amount in milliseconds.
`com.google.protobuf.DurationOrBuilder`	`getIntervalJitterOrBuilder()` An optional jitter amount in milliseconds.
`int`	`getIntervalJitterPercent()` An optional jitter amount as a percentage of interval_ms.
`com.google.protobuf.DurationOrBuilder`	`getIntervalOrBuilder()` The interval between health checks.
`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.
`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.
`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.
`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.
`com.google.protobuf.Parser<HealthCheck>`	`getParserForType()`
`com.google.protobuf.BoolValue`	`getReuseConnection()` Reuse health check connection between health checks.
`com.google.protobuf.BoolValueOrBuilder`	`getReuseConnectionOrBuilder()` Reuse health check connection between health checks.
`int`	`getSerializedSize()`
`HealthCheck.TcpHealthCheck`	`getTcpHealthCheck()` TCP health check.
`HealthCheck.TcpHealthCheckOrBuilder`	`getTcpHealthCheckOrBuilder()` TCP health check.
`com.google.protobuf.Duration`	`getTimeout()` The time to wait for a health check response.
`com.google.protobuf.DurationOrBuilder`	`getTimeoutOrBuilder()` The time to wait for a health check response.
`HealthCheck.TlsOptions`	`getTlsOptions()` This allows overriding the cluster TLS settings, just for health check connections.
`HealthCheck.TlsOptionsOrBuilder`	`getTlsOptionsOrBuilder()` This allows overriding the cluster TLS settings, just for health check connections.
`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_api_field_config.cluster.v4alpha.Cluster.transport_socket_matches>`.
`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_api_field_config.cluster.v4alpha.Cluster.transport_socket_matches>`.
`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.
`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.
`com.google.protobuf.Duration`	`getUnhealthyInterval()` The "unhealthy interval" is a health check interval that is used for hosts that are marked as unhealthy.
`com.google.protobuf.DurationOrBuilder`	`getUnhealthyIntervalOrBuilder()` The "unhealthy interval" is a health check interval that is used for hosts that are marked as unhealthy.
`com.google.protobuf.UInt32Value`	`getUnhealthyThreshold()` The number of unhealthy health checks required before a host is marked unhealthy.
`com.google.protobuf.UInt32ValueOrBuilder`	`getUnhealthyThresholdOrBuilder()` The number of unhealthy health checks required before a host is marked unhealthy.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasAltPort()` [#not-implemented-hide:] Non-serving port for health checking.
`boolean`	`hasCustomHealthCheck()` Custom health check.
`boolean`	`hasEventService()` [#not-implemented-hide:] The gRPC service for the health check event service.
`boolean`	`hasGrpcHealthCheck()` gRPC health check.
`int`	`hashCode()`
`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.
`boolean`	`hasHealthyThreshold()` The number of healthy health checks required before a host is marked healthy.
`boolean`	`hasHttpHealthCheck()` HTTP health check.
`boolean`	`hasInitialJitter()` An optional jitter amount in milliseconds.
`boolean`	`hasInterval()` The interval between health checks.
`boolean`	`hasIntervalJitter()` An optional jitter amount in milliseconds.
`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.
`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.
`boolean`	`hasReuseConnection()` Reuse health check connection between health checks.
`boolean`	`hasTcpHealthCheck()` TCP health check.
`boolean`	`hasTimeout()` The time to wait for a health check response.
`boolean`	`hasTlsOptions()` This allows overriding the cluster TLS settings, just for health check connections.
`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_api_field_config.cluster.v4alpha.Cluster.transport_socket_matches>`.
`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.
`boolean`	`hasUnhealthyInterval()` The "unhealthy interval" is a health check interval that is used for hosts that are marked as unhealthy.
`boolean`	`hasUnhealthyThreshold()` The number of unhealthy health checks required before a host is marked unhealthy.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static HealthCheck.Builder`	`newBuilder()`
`static HealthCheck.Builder`	`newBuilder(HealthCheck prototype)`
`HealthCheck.Builder`	`newBuilderForType()`
`protected HealthCheck.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static HealthCheck`	`parseDelimitedFrom(InputStream input)`
`static HealthCheck`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static HealthCheck`	`parseFrom(byte[] data)`
`static HealthCheck`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static HealthCheck`	`parseFrom(ByteBuffer data)`
`static HealthCheck`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static HealthCheck`	`parseFrom(com.google.protobuf.ByteString data)`
`static HealthCheck`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static HealthCheck`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static HealthCheck`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static HealthCheck`	`parseFrom(InputStream input)`
`static HealthCheck`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<HealthCheck>`	`parser()`
`HealthCheck.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- TIMEOUT_FIELD_NUMBER
```
public static final int TIMEOUT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INTERVAL_FIELD_NUMBER
```
public static final int INTERVAL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INITIAL_JITTER_FIELD_NUMBER
```
public static final int INITIAL_JITTER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INTERVAL_JITTER_FIELD_NUMBER
```
public static final int INTERVAL_JITTER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INTERVAL_JITTER_PERCENT_FIELD_NUMBER
```
public static final int INTERVAL_JITTER_PERCENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UNHEALTHY_THRESHOLD_FIELD_NUMBER
```
public static final int UNHEALTHY_THRESHOLD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HEALTHY_THRESHOLD_FIELD_NUMBER
```
public static final int HEALTHY_THRESHOLD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ALT_PORT_FIELD_NUMBER
```
public static final int ALT_PORT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REUSE_CONNECTION_FIELD_NUMBER
```
public static final int REUSE_CONNECTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HTTP_HEALTH_CHECK_FIELD_NUMBER
```
public static final int HTTP_HEALTH_CHECK_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TCP_HEALTH_CHECK_FIELD_NUMBER
```
public static final int TCP_HEALTH_CHECK_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- GRPC_HEALTH_CHECK_FIELD_NUMBER
```
public static final int GRPC_HEALTH_CHECK_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CUSTOM_HEALTH_CHECK_FIELD_NUMBER
```
public static final int CUSTOM_HEALTH_CHECK_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NO_TRAFFIC_INTERVAL_FIELD_NUMBER
```
public static final int NO_TRAFFIC_INTERVAL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NO_TRAFFIC_HEALTHY_INTERVAL_FIELD_NUMBER
```
public static final int NO_TRAFFIC_HEALTHY_INTERVAL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UNHEALTHY_INTERVAL_FIELD_NUMBER
```
public static final int UNHEALTHY_INTERVAL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UNHEALTHY_EDGE_INTERVAL_FIELD_NUMBER
```
public static final int UNHEALTHY_EDGE_INTERVAL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HEALTHY_EDGE_INTERVAL_FIELD_NUMBER
```
public static final int HEALTHY_EDGE_INTERVAL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EVENT_LOG_PATH_FIELD_NUMBER
```
public static final int EVENT_LOG_PATH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EVENT_SERVICE_FIELD_NUMBER
```
public static final int EVENT_SERVICE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ALWAYS_LOG_HEALTH_CHECK_FAILURES_FIELD_NUMBER
```
public static final int ALWAYS_LOG_HEALTH_CHECK_FAILURES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TLS_OPTIONS_FIELD_NUMBER
```
public static final int TLS_OPTIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TRANSPORT_SOCKET_MATCH_CRITERIA_FIELD_NUMBER
```
public static final int TRANSPORT_SOCKET_MATCH_CRITERIA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

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

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

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

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

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

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

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

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

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 503
 this threshold is ignored and the host is considered unhealthy immediately.

.google.protobuf.UInt32Value unhealthy_threshold = 4 [(.validate.rules) = { ... }

Specified by:: hasUnhealthyThreshold in interface HealthCheckOrBuilder

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 503
 this threshold is ignored and the host is considered unhealthy immediately.

.google.protobuf.UInt32Value unhealthy_threshold = 4 [(.validate.rules) = { ... }

Specified by:: getUnhealthyThreshold in interface HealthCheckOrBuilder

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 503
 this threshold is ignored and the host is considered unhealthy immediately.

.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

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

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

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

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

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

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.v4alpha.HealthCheck.HttpHealthCheck http_health_check = 8;
Specified by:

hasHttpHealthCheck in interface HealthCheckOrBuilder

getHttpHealthCheck
```
public HealthCheck.HttpHealthCheck getHttpHealthCheck()
```
```
 HTTP health check.
 
```
.envoy.config.core.v4alpha.HealthCheck.HttpHealthCheck http_health_check = 8;
Specified by:

getHttpHealthCheck in interface HealthCheckOrBuilder

getHttpHealthCheckOrBuilder
```
public HealthCheck.HttpHealthCheckOrBuilder getHttpHealthCheckOrBuilder()
```
```
 HTTP health check.
 
```
.envoy.config.core.v4alpha.HealthCheck.HttpHealthCheck http_health_check = 8;
Specified by:

getHttpHealthCheckOrBuilder in interface HealthCheckOrBuilder

hasTcpHealthCheck
```
public boolean hasTcpHealthCheck()
```
```
 TCP health check.
 
```
.envoy.config.core.v4alpha.HealthCheck.TcpHealthCheck tcp_health_check = 9;
Specified by:

hasTcpHealthCheck in interface HealthCheckOrBuilder

getTcpHealthCheck
```
public HealthCheck.TcpHealthCheck getTcpHealthCheck()
```
```
 TCP health check.
 
```
.envoy.config.core.v4alpha.HealthCheck.TcpHealthCheck tcp_health_check = 9;
Specified by:

getTcpHealthCheck in interface HealthCheckOrBuilder

getTcpHealthCheckOrBuilder
```
public HealthCheck.TcpHealthCheckOrBuilder getTcpHealthCheckOrBuilder()
```
```
 TCP health check.
 
```
.envoy.config.core.v4alpha.HealthCheck.TcpHealthCheck tcp_health_check = 9;
Specified by:

getTcpHealthCheckOrBuilder in interface HealthCheckOrBuilder

hasGrpcHealthCheck
```
public boolean hasGrpcHealthCheck()
```
```
 gRPC health check.
 
```
.envoy.config.core.v4alpha.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
Specified by:

hasGrpcHealthCheck in interface HealthCheckOrBuilder

getGrpcHealthCheck
```
public HealthCheck.GrpcHealthCheck getGrpcHealthCheck()
```
```
 gRPC health check.
 
```
.envoy.config.core.v4alpha.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
Specified by:

getGrpcHealthCheck in interface HealthCheckOrBuilder

getGrpcHealthCheckOrBuilder
```
public HealthCheck.GrpcHealthCheckOrBuilder getGrpcHealthCheckOrBuilder()
```
```
 gRPC health check.
 
```
.envoy.config.core.v4alpha.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
Specified by:

getGrpcHealthCheckOrBuilder in interface HealthCheckOrBuilder

hasCustomHealthCheck
```
public boolean hasCustomHealthCheck()
```
```
 Custom health check.
 
```
.envoy.config.core.v4alpha.HealthCheck.CustomHealthCheck custom_health_check = 13;
Specified by:

hasCustomHealthCheck in interface HealthCheckOrBuilder

getCustomHealthCheck
```
public HealthCheck.CustomHealthCheck getCustomHealthCheck()
```
```
 Custom health check.
 
```
.envoy.config.core.v4alpha.HealthCheck.CustomHealthCheck custom_health_check = 13;
Specified by:

getCustomHealthCheck in interface HealthCheckOrBuilder

getCustomHealthCheckOrBuilder
```
public HealthCheck.CustomHealthCheckOrBuilder getCustomHealthCheckOrBuilder()
```
```
 Custom health check.
 
```
.envoy.config.core.v4alpha.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

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

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

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

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

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

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

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

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

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

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

public String getEventLogPath()

 Specifies the path to the :ref:`health check event log <arch_overview_health_check_logging>`.
 If empty, no event log will be written.

string event_log_path = 17;

Specified by:: getEventLogPath in interface HealthCheckOrBuilder

getEventLogPathBytes

public com.google.protobuf.ByteString getEventLogPathBytes()

 Specifies the path to the :ref:`health check event log <arch_overview_health_check_logging>`.
 If empty, no event log will be written.

string event_log_path = 17;

Specified by:: getEventLogPathBytes 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.v4alpha.EventServiceConfig event_service = 22;

Specified by:: hasEventService in interface HealthCheckOrBuilder

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.v4alpha.EventServiceConfig event_service = 22;

Specified by:: getEventService in interface HealthCheckOrBuilder

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.v4alpha.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

hasTlsOptions
```
public boolean hasTlsOptions()
```
```
 This allows overriding the cluster TLS settings, just for health check connections.
 
```
.envoy.config.core.v4alpha.HealthCheck.TlsOptions tls_options = 21;
Specified by:

hasTlsOptions in interface HealthCheckOrBuilder

getTlsOptions

public HealthCheck.TlsOptions getTlsOptions()

 This allows overriding the cluster TLS settings, just for health check connections.

.envoy.config.core.v4alpha.HealthCheck.TlsOptions tls_options = 21;

Specified by:: getTlsOptions in interface HealthCheckOrBuilder

getTlsOptionsOrBuilder

public HealthCheck.TlsOptionsOrBuilder getTlsOptionsOrBuilder()

 This allows overriding the cluster TLS settings, just for health check connections.

.envoy.config.core.v4alpha.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_api_field_config.cluster.v4alpha.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_api_msg_config.cluster.v4alpha.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_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_api_field_config.cluster.v4alpha.Cluster.transport_socket_matches>`,
 the cluster's :ref:`transport socket <envoy_api_field_config.cluster.v4alpha.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

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_api_field_config.cluster.v4alpha.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_api_msg_config.cluster.v4alpha.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_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_api_field_config.cluster.v4alpha.Cluster.transport_socket_matches>`,
 the cluster's :ref:`transport socket <envoy_api_field_config.cluster.v4alpha.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

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_api_field_config.cluster.v4alpha.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_api_msg_config.cluster.v4alpha.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_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_api_field_config.cluster.v4alpha.Cluster.transport_socket_matches>`,
 the cluster's :ref:`transport socket <envoy_api_field_config.cluster.v4alpha.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.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize
```
public int getSerializedSize()
```
Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3.BuilderParent parent)

Specified by:: newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

getDefaultInstanceForType
```
public HealthCheck getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class HealthCheck

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

TIMEOUT_FIELD_NUMBER

INTERVAL_FIELD_NUMBER

INITIAL_JITTER_FIELD_NUMBER

INTERVAL_JITTER_FIELD_NUMBER

INTERVAL_JITTER_PERCENT_FIELD_NUMBER

UNHEALTHY_THRESHOLD_FIELD_NUMBER

HEALTHY_THRESHOLD_FIELD_NUMBER

ALT_PORT_FIELD_NUMBER

REUSE_CONNECTION_FIELD_NUMBER

HTTP_HEALTH_CHECK_FIELD_NUMBER

TCP_HEALTH_CHECK_FIELD_NUMBER

GRPC_HEALTH_CHECK_FIELD_NUMBER

CUSTOM_HEALTH_CHECK_FIELD_NUMBER

NO_TRAFFIC_INTERVAL_FIELD_NUMBER

NO_TRAFFIC_HEALTHY_INTERVAL_FIELD_NUMBER

UNHEALTHY_INTERVAL_FIELD_NUMBER

UNHEALTHY_EDGE_INTERVAL_FIELD_NUMBER

HEALTHY_EDGE_INTERVAL_FIELD_NUMBER

EVENT_LOG_PATH_FIELD_NUMBER

EVENT_SERVICE_FIELD_NUMBER

ALWAYS_LOG_HEALTH_CHECK_FAILURES_FIELD_NUMBER

TLS_OPTIONS_FIELD_NUMBER

TRANSPORT_SOCKET_MATCH_CRITERIA_FIELD_NUMBER

Method Detail

newInstance

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

getHealthCheckerCase

hasTimeout

getTimeout

getTimeoutOrBuilder

hasInterval

getInterval

getIntervalOrBuilder

hasInitialJitter

getInitialJitter

getInitialJitterOrBuilder

hasIntervalJitter

getIntervalJitter

getIntervalJitterOrBuilder

getIntervalJitterPercent

hasUnhealthyThreshold

getUnhealthyThreshold

getUnhealthyThresholdOrBuilder

hasHealthyThreshold

getHealthyThreshold

getHealthyThresholdOrBuilder

hasAltPort

getAltPort

getAltPortOrBuilder

hasReuseConnection

getReuseConnection

getReuseConnectionOrBuilder

hasHttpHealthCheck

getHttpHealthCheck

getHttpHealthCheckOrBuilder

hasTcpHealthCheck

getTcpHealthCheck

getTcpHealthCheckOrBuilder

hasGrpcHealthCheck

getGrpcHealthCheck

getGrpcHealthCheckOrBuilder

hasCustomHealthCheck

getCustomHealthCheck