Class HealthCheck
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- 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.GeneratedMessageV3 implements HealthCheckOrBuilder
[#next-free-field: 26]
Protobuf typeenvoy.config.core.v3.HealthCheck
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HealthCheck.Builder
[#next-free-field: 26]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: 15]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 typeenvoy.config.core.v3.HealthCheck.RedisHealthCheck
static interface
HealthCheck.RedisHealthCheckOrBuilder
static class
HealthCheck.TcpHealthCheck
Protobuf typeenvoy.config.core.v3.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
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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()
TypedExtensionConfig
getEventLogger(int index)
A list of event log sinks to process the health check event.int
getEventLoggerCount()
A list of event log sinks to process the health check event.List<TypedExtensionConfig>
getEventLoggerList()
A list of event log sinks to process the health check event.TypedExtensionConfigOrBuilder
getEventLoggerOrBuilder(int index)
A list of event log sinks to process the health check event.List<? extends TypedExtensionConfigOrBuilder>
getEventLoggerOrBuilderList()
A list of event log sinks to process the health check event.String
getEventLogPath()
Deprecated.envoy.config.core.v3.HealthCheck.event_log_path is deprecated.com.google.protobuf.ByteString
getEventLogPathBytes()
Deprecated.envoy.config.core.v3.HealthCheck.event_log_path is deprecated.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_v3_api_field_config.cluster.v3.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_v3_api_field_config.cluster.v3.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_v3_api_field_config.cluster.v3.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(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()
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, isStringEmpty, 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
-
-
-
-
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_LOGGER_FIELD_NUMBER
public static final int EVENT_LOGGER_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 classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFields
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getUnknownFields
in classcom.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 classcom.google.protobuf.GeneratedMessageV3
-
getHealthCheckerCase
public HealthCheck.HealthCheckerCase 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
public HealthCheck.HttpHealthCheck getHttpHealthCheck()
HTTP health check.
.envoy.config.core.v3.HealthCheck.HttpHealthCheck http_health_check = 8;
- Specified by:
getHttpHealthCheck
in interfaceHealthCheckOrBuilder
- Returns:
- The httpHealthCheck.
-
getHttpHealthCheckOrBuilder
public HealthCheck.HttpHealthCheckOrBuilder getHttpHealthCheckOrBuilder()
HTTP health check.
.envoy.config.core.v3.HealthCheck.HttpHealthCheck http_health_check = 8;
- Specified by:
getHttpHealthCheckOrBuilder
in 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
public HealthCheck.TcpHealthCheck getTcpHealthCheck()
TCP health check.
.envoy.config.core.v3.HealthCheck.TcpHealthCheck tcp_health_check = 9;
- Specified by:
getTcpHealthCheck
in interfaceHealthCheckOrBuilder
- Returns:
- The tcpHealthCheck.
-
getTcpHealthCheckOrBuilder
public HealthCheck.TcpHealthCheckOrBuilder getTcpHealthCheckOrBuilder()
TCP health check.
.envoy.config.core.v3.HealthCheck.TcpHealthCheck tcp_health_check = 9;
- Specified by:
getTcpHealthCheckOrBuilder
in 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
public HealthCheck.GrpcHealthCheck getGrpcHealthCheck()
gRPC health check.
.envoy.config.core.v3.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
- Specified by:
getGrpcHealthCheck
in interfaceHealthCheckOrBuilder
- Returns:
- The grpcHealthCheck.
-
getGrpcHealthCheckOrBuilder
public HealthCheck.GrpcHealthCheckOrBuilder getGrpcHealthCheckOrBuilder()
gRPC health check.
.envoy.config.core.v3.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
- Specified by:
getGrpcHealthCheckOrBuilder
in 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
public HealthCheck.CustomHealthCheck getCustomHealthCheck()
Custom health check.
.envoy.config.core.v3.HealthCheck.CustomHealthCheck custom_health_check = 13;
- Specified by:
getCustomHealthCheck
in interfaceHealthCheckOrBuilder
- Returns:
- The customHealthCheck.
-
getCustomHealthCheckOrBuilder
public HealthCheck.CustomHealthCheckOrBuilder getCustomHealthCheckOrBuilder()
Custom health check.
.envoy.config.core.v3.HealthCheck.CustomHealthCheck custom_health_check = 13;
- Specified by:
getCustomHealthCheckOrBuilder
in 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 public String getEventLogPath()
Deprecated.envoy.config.core.v3.HealthCheck.event_log_path is deprecated. See envoy/config/core/v3/health_check.proto;l=377.. 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 public com.google.protobuf.ByteString getEventLogPathBytes()
Deprecated.envoy.config.core.v3.HealthCheck.event_log_path is deprecated. See envoy/config/core/v3/health_check.proto;l=377.. 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
public List<TypedExtensionConfig> getEventLoggerList()
A list of event log sinks to process the health check event. [#extension-category: envoy.health_check.event_sinks]
repeated .envoy.config.core.v3.TypedExtensionConfig event_logger = 25;
- Specified by:
getEventLoggerList
in interfaceHealthCheckOrBuilder
-
getEventLoggerOrBuilderList
public List<? extends TypedExtensionConfigOrBuilder> getEventLoggerOrBuilderList()
A list of event log sinks to process the health check event. [#extension-category: envoy.health_check.event_sinks]
repeated .envoy.config.core.v3.TypedExtensionConfig event_logger = 25;
- Specified by:
getEventLoggerOrBuilderList
in 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
public TypedExtensionConfig getEventLogger(int index)
A list of event log sinks to process the health check event. [#extension-category: envoy.health_check.event_sinks]
repeated .envoy.config.core.v3.TypedExtensionConfig event_logger = 25;
- Specified by:
getEventLogger
in interfaceHealthCheckOrBuilder
-
getEventLoggerOrBuilder
public TypedExtensionConfigOrBuilder getEventLoggerOrBuilder(int index)
A list of event log sinks to process the health check event. [#extension-category: envoy.health_check.event_sinks]
repeated .envoy.config.core.v3.TypedExtensionConfig event_logger = 25;
- Specified by:
getEventLoggerOrBuilder
in 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
public EventServiceConfig getEventService()
[#not-implemented-hide:] The gRPC service for the health check event service. If empty, health check events won't be sent to a remote endpoint.
.envoy.config.core.v3.EventServiceConfig event_service = 22;
- Specified by:
getEventService
in interfaceHealthCheckOrBuilder
- Returns:
- The eventService.
-
getEventServiceOrBuilder
public EventServiceConfigOrBuilder getEventServiceOrBuilder()
[#not-implemented-hide:] The gRPC service for the health check event service. If empty, health check events won't be sent to a remote endpoint.
.envoy.config.core.v3.EventServiceConfig event_service = 22;
- Specified by:
getEventServiceOrBuilder
in 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.
-
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
public HealthCheck.TlsOptions getTlsOptions()
This allows overriding the cluster TLS settings, just for health check connections.
.envoy.config.core.v3.HealthCheck.TlsOptions tls_options = 21;
- Specified by:
getTlsOptions
in interfaceHealthCheckOrBuilder
- Returns:
- The tlsOptions.
-
getTlsOptionsOrBuilder
public HealthCheck.TlsOptionsOrBuilder getTlsOptionsOrBuilder()
This allows overriding the cluster TLS settings, just for health check connections.
.envoy.config.core.v3.HealthCheck.TlsOptions tls_options = 21;
- Specified by:
getTlsOptionsOrBuilder
in 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.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- 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
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 interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.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 interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected HealthCheck.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.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 interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public HealthCheck getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-