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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
[#next-free-field: 27]static final class
Custom health check.static interface
static final class
`grpc.health.v1.Health <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto>`_-based healthcheck.static interface
static enum
static final class
[#next-free-field: 15]static interface
static final class
Describes the encoding of the payload bytes in the payload.static interface
static final class
Protobuf typeenvoy.config.core.v3.HealthCheck.RedisHealthCheck
static interface
static final class
Protobuf typeenvoy.config.core.v3.HealthCheck.TcpHealthCheck
static interface
static final class
Health checks occur over the transport socket specified for the cluster.static interface
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
private com.google.protobuf.UInt32Value
static final int
static final int
private boolean
private boolean
private int
static final int
private static final HealthCheck
static final int
static final int
static final int
private List
<TypedExtensionConfig> private Object
private EventServiceConfig
static final int
private Object
private int
static final int
static final int
private com.google.protobuf.Duration
private com.google.protobuf.UInt32Value
static final int
static final int
private com.google.protobuf.Duration
private com.google.protobuf.Duration
static final int
static final int
static final int
private com.google.protobuf.Duration
private int
private byte
static final int
static final int
private com.google.protobuf.Duration
private com.google.protobuf.Duration
private static final com.google.protobuf.Parser
<HealthCheck> static final int
private com.google.protobuf.BoolValue
private static final long
static final int
private com.google.protobuf.Duration
static final int
static final int
private HealthCheck.TlsOptions
static final int
private com.google.protobuf.Struct
static final int
static final int
static final int
private com.google.protobuf.Duration
private com.google.protobuf.Duration
private com.google.protobuf.UInt32Value
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
HealthCheck
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
com.google.protobuf.UInt32Value
[#not-implemented-hide:] Non-serving port for health checking.com.google.protobuf.UInt32ValueOrBuilder
[#not-implemented-hide:] Non-serving port for health checking.boolean
If set to true, health check failure events will always be logged.boolean
If set to true, health check success events will always be logged.Custom health check.Custom health check.static HealthCheck
static final com.google.protobuf.Descriptors.Descriptor
getEventLogger
(int index) A list of event log sinks to process the health check event.int
A list of event log sinks to process the health check event.A list of event log sinks to process the health check event.getEventLoggerOrBuilder
(int index) A list of event log sinks to process the health check event.List
<? extends TypedExtensionConfigOrBuilder> A list of event log sinks to process the health check event.Deprecated.envoy.config.core.v3.HealthCheck.event_log_path is deprecated.com.google.protobuf.ByteString
Deprecated.envoy.config.core.v3.HealthCheck.event_log_path is deprecated.[#not-implemented-hide:] The gRPC service for the health check event service.[#not-implemented-hide:] The gRPC service for the health check event service.gRPC health check.gRPC health check.com.google.protobuf.Duration
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
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
The number of healthy health checks required before a host is marked healthy.com.google.protobuf.UInt32ValueOrBuilder
The number of healthy health checks required before a host is marked healthy.HTTP health check.HTTP health check.com.google.protobuf.Duration
An optional jitter amount in milliseconds.com.google.protobuf.DurationOrBuilder
An optional jitter amount in milliseconds.com.google.protobuf.Duration
The interval between health checks.com.google.protobuf.Duration
An optional jitter amount in milliseconds.com.google.protobuf.DurationOrBuilder
An optional jitter amount in milliseconds.int
An optional jitter amount as a percentage of interval_ms.com.google.protobuf.DurationOrBuilder
The interval between health checks.com.google.protobuf.Duration
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
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
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
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> com.google.protobuf.BoolValue
Reuse health check connection between health checks.com.google.protobuf.BoolValueOrBuilder
Reuse health check connection between health checks.int
TCP health check.TCP health check.com.google.protobuf.Duration
The time to wait for a health check response.com.google.protobuf.DurationOrBuilder
The time to wait for a health check response.This allows overriding the cluster TLS settings, just for health check connections.This allows overriding the cluster TLS settings, just for health check connections.com.google.protobuf.Struct
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>`.com.google.protobuf.StructOrBuilder
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>`.com.google.protobuf.Duration
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
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
The "unhealthy interval" is a health check interval that is used for hosts that are marked as unhealthy.com.google.protobuf.DurationOrBuilder
The "unhealthy interval" is a health check interval that is used for hosts that are marked as unhealthy.com.google.protobuf.UInt32Value
The number of unhealthy health checks required before a host is marked unhealthy.com.google.protobuf.UInt32ValueOrBuilder
The number of unhealthy health checks required before a host is marked unhealthy.boolean
[#not-implemented-hide:] Non-serving port for health checking.boolean
Custom health check.boolean
[#not-implemented-hide:] The gRPC service for the health check event service.boolean
gRPC health check.int
hashCode()
boolean
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
The number of healthy health checks required before a host is marked healthy.boolean
HTTP health check.boolean
An optional jitter amount in milliseconds.boolean
The interval between health checks.boolean
An optional jitter amount in milliseconds.boolean
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
The "no traffic interval" is a special health check interval that is used when a cluster has never had traffic routed to it.boolean
Reuse health check connection between health checks.boolean
TCP health check.boolean
The time to wait for a health check response.boolean
This allows overriding the cluster TLS settings, just for health check connections.boolean
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>`.boolean
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
The "unhealthy interval" is a health check interval that is used for hosts that are marked as unhealthy.boolean
The number of unhealthy health checks required before a host is marked unhealthy.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static HealthCheck.Builder
static HealthCheck.Builder
newBuilder
(HealthCheck prototype) protected HealthCheck.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) 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
(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 HealthCheck
parseFrom
(ByteBuffer data) static HealthCheck
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<HealthCheck> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
healthCheckerCase_
private int healthCheckerCase_ -
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_
-
EVENT_LOGGER_FIELD_NUMBER
public static final int EVENT_LOGGER_FIELD_NUMBER- See Also:
-
eventLogger_
-
EVENT_SERVICE_FIELD_NUMBER
public static final int EVENT_SERVICE_FIELD_NUMBER- See Also:
-
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_
-
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
-
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 classcom.google.protobuf.GeneratedMessage
-
getHealthCheckerCase
- Specified by:
getHealthCheckerCase
in interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
hasInterval
public boolean hasInterval()The interval between health checks.
.google.protobuf.Duration interval = 2 [(.validate.rules) = { ... }
- Specified by:
hasInterval
in interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
hasAltPort
public boolean hasAltPort()[#not-implemented-hide:] Non-serving port for health checking.
.google.protobuf.UInt32Value alt_port = 6;
- Specified by:
hasAltPort
in interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
hasReuseConnection
public boolean hasReuseConnection()Reuse health check connection between health checks. Default is true.
.google.protobuf.BoolValue reuse_connection = 7;
- Specified by:
hasReuseConnection
in interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
hasHttpHealthCheck
public boolean hasHttpHealthCheck()HTTP health check.
.envoy.config.core.v3.HealthCheck.HttpHealthCheck http_health_check = 8;
- Specified by:
hasHttpHealthCheck
in interfaceHealthCheckOrBuilder
- Returns:
- Whether the httpHealthCheck field is set.
-
getHttpHealthCheck
HTTP health check.
.envoy.config.core.v3.HealthCheck.HttpHealthCheck http_health_check = 8;
- Specified by:
getHttpHealthCheck
in interfaceHealthCheckOrBuilder
- Returns:
- The httpHealthCheck.
-
getHttpHealthCheckOrBuilder
HTTP health check.
.envoy.config.core.v3.HealthCheck.HttpHealthCheck http_health_check = 8;
- Specified by:
getHttpHealthCheckOrBuilder
in interfaceHealthCheckOrBuilder
-
hasTcpHealthCheck
public boolean hasTcpHealthCheck()TCP health check.
.envoy.config.core.v3.HealthCheck.TcpHealthCheck tcp_health_check = 9;
- Specified by:
hasTcpHealthCheck
in interfaceHealthCheckOrBuilder
- Returns:
- Whether the tcpHealthCheck field is set.
-
getTcpHealthCheck
TCP health check.
.envoy.config.core.v3.HealthCheck.TcpHealthCheck tcp_health_check = 9;
- Specified by:
getTcpHealthCheck
in interfaceHealthCheckOrBuilder
- Returns:
- The tcpHealthCheck.
-
getTcpHealthCheckOrBuilder
TCP health check.
.envoy.config.core.v3.HealthCheck.TcpHealthCheck tcp_health_check = 9;
- Specified by:
getTcpHealthCheckOrBuilder
in interfaceHealthCheckOrBuilder
-
hasGrpcHealthCheck
public boolean hasGrpcHealthCheck()gRPC health check.
.envoy.config.core.v3.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
- Specified by:
hasGrpcHealthCheck
in interfaceHealthCheckOrBuilder
- Returns:
- Whether the grpcHealthCheck field is set.
-
getGrpcHealthCheck
gRPC health check.
.envoy.config.core.v3.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
- Specified by:
getGrpcHealthCheck
in interfaceHealthCheckOrBuilder
- Returns:
- The grpcHealthCheck.
-
getGrpcHealthCheckOrBuilder
gRPC health check.
.envoy.config.core.v3.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
- Specified by:
getGrpcHealthCheckOrBuilder
in interfaceHealthCheckOrBuilder
-
hasCustomHealthCheck
public boolean hasCustomHealthCheck()Custom health check.
.envoy.config.core.v3.HealthCheck.CustomHealthCheck custom_health_check = 13;
- Specified by:
hasCustomHealthCheck
in interfaceHealthCheckOrBuilder
- Returns:
- Whether the customHealthCheck field is set.
-
getCustomHealthCheck
Custom health check.
.envoy.config.core.v3.HealthCheck.CustomHealthCheck custom_health_check = 13;
- Specified by:
getCustomHealthCheck
in interfaceHealthCheckOrBuilder
- Returns:
- The customHealthCheck.
-
getCustomHealthCheckOrBuilder
Custom health check.
.envoy.config.core.v3.HealthCheck.CustomHealthCheck custom_health_check = 13;
- Specified by:
getCustomHealthCheckOrBuilder
in interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- Returns:
- The eventLogPath.
-
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 interfaceHealthCheckOrBuilder
- Returns:
- The bytes for eventLogPath.
-
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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
-
getEventLogger
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 interfaceHealthCheckOrBuilder
-
getEventLoggerOrBuilder
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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- Returns:
- Whether the eventService field is set.
-
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 interfaceHealthCheckOrBuilder
- Returns:
- The eventService.
-
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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- Returns:
- Whether the tlsOptions field is set.
-
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 interfaceHealthCheckOrBuilder
- Returns:
- The tlsOptions.
-
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 interfaceHealthCheckOrBuilder
-
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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
- 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 interfaceHealthCheckOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.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
- Throws:
IOException
-
parseFrom
public static HealthCheck parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static HealthCheck parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static HealthCheck parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected HealthCheck.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-