Interface HealthCheckOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
HealthCheck
,HealthCheck.Builder
public interface HealthCheckOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description 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.boolean
getAlwaysLogHealthCheckSuccess()
If set to true, health check success events will always be logged.HealthCheck.CustomHealthCheck
getCustomHealthCheck()
Custom health check.HealthCheck.CustomHealthCheckOrBuilder
getCustomHealthCheckOrBuilder()
Custom health check.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.java.util.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.java.util.List<? extends TypedExtensionConfigOrBuilder>
getEventLoggerOrBuilderList()
A list of event log sinks to process the health check event.java.lang.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.BoolValue
getReuseConnection()
Reuse health check connection between health checks.com.google.protobuf.BoolValueOrBuilder
getReuseConnectionOrBuilder()
Reuse health check connection between health checks.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.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.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.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
hasTimeout
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) = { ... }
- Returns:
- Whether the timeout field is set.
-
getTimeout
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) = { ... }
- Returns:
- The timeout.
-
getTimeoutOrBuilder
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) = { ... }
-
hasInterval
boolean hasInterval()
The interval between health checks.
.google.protobuf.Duration interval = 2 [(.validate.rules) = { ... }
- Returns:
- Whether the interval field is set.
-
getInterval
com.google.protobuf.Duration getInterval()
The interval between health checks.
.google.protobuf.Duration interval = 2 [(.validate.rules) = { ... }
- Returns:
- The interval.
-
getIntervalOrBuilder
com.google.protobuf.DurationOrBuilder getIntervalOrBuilder()
The interval between health checks.
.google.protobuf.Duration interval = 2 [(.validate.rules) = { ... }
-
hasInitialJitter
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;
- Returns:
- Whether the initialJitter field is set.
-
getInitialJitter
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;
- Returns:
- The initialJitter.
-
getInitialJitterOrBuilder
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;
-
hasIntervalJitter
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;
- Returns:
- Whether the intervalJitter field is set.
-
getIntervalJitter
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;
- Returns:
- The intervalJitter.
-
getIntervalJitterOrBuilder
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;
-
getIntervalJitterPercent
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;
- Returns:
- The intervalJitterPercent.
-
hasUnhealthyThreshold
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) = { ... }
- Returns:
- Whether the unhealthyThreshold field is set.
-
getUnhealthyThreshold
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) = { ... }
- Returns:
- The unhealthyThreshold.
-
getUnhealthyThresholdOrBuilder
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) = { ... }
-
hasHealthyThreshold
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) = { ... }
- Returns:
- Whether the healthyThreshold field is set.
-
getHealthyThreshold
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) = { ... }
- Returns:
- The healthyThreshold.
-
getHealthyThresholdOrBuilder
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) = { ... }
-
hasAltPort
boolean hasAltPort()
[#not-implemented-hide:] Non-serving port for health checking.
.google.protobuf.UInt32Value alt_port = 6;
- Returns:
- Whether the altPort field is set.
-
getAltPort
com.google.protobuf.UInt32Value getAltPort()
[#not-implemented-hide:] Non-serving port for health checking.
.google.protobuf.UInt32Value alt_port = 6;
- Returns:
- The altPort.
-
getAltPortOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getAltPortOrBuilder()
[#not-implemented-hide:] Non-serving port for health checking.
.google.protobuf.UInt32Value alt_port = 6;
-
hasReuseConnection
boolean hasReuseConnection()
Reuse health check connection between health checks. Default is true.
.google.protobuf.BoolValue reuse_connection = 7;
- Returns:
- Whether the reuseConnection field is set.
-
getReuseConnection
com.google.protobuf.BoolValue getReuseConnection()
Reuse health check connection between health checks. Default is true.
.google.protobuf.BoolValue reuse_connection = 7;
- Returns:
- The reuseConnection.
-
getReuseConnectionOrBuilder
com.google.protobuf.BoolValueOrBuilder getReuseConnectionOrBuilder()
Reuse health check connection between health checks. Default is true.
.google.protobuf.BoolValue reuse_connection = 7;
-
hasHttpHealthCheck
boolean hasHttpHealthCheck()
HTTP health check.
.envoy.config.core.v3.HealthCheck.HttpHealthCheck http_health_check = 8;
- Returns:
- Whether the httpHealthCheck field is set.
-
getHttpHealthCheck
HealthCheck.HttpHealthCheck getHttpHealthCheck()
HTTP health check.
.envoy.config.core.v3.HealthCheck.HttpHealthCheck http_health_check = 8;
- Returns:
- The httpHealthCheck.
-
getHttpHealthCheckOrBuilder
HealthCheck.HttpHealthCheckOrBuilder getHttpHealthCheckOrBuilder()
HTTP health check.
.envoy.config.core.v3.HealthCheck.HttpHealthCheck http_health_check = 8;
-
hasTcpHealthCheck
boolean hasTcpHealthCheck()
TCP health check.
.envoy.config.core.v3.HealthCheck.TcpHealthCheck tcp_health_check = 9;
- Returns:
- Whether the tcpHealthCheck field is set.
-
getTcpHealthCheck
HealthCheck.TcpHealthCheck getTcpHealthCheck()
TCP health check.
.envoy.config.core.v3.HealthCheck.TcpHealthCheck tcp_health_check = 9;
- Returns:
- The tcpHealthCheck.
-
getTcpHealthCheckOrBuilder
HealthCheck.TcpHealthCheckOrBuilder getTcpHealthCheckOrBuilder()
TCP health check.
.envoy.config.core.v3.HealthCheck.TcpHealthCheck tcp_health_check = 9;
-
hasGrpcHealthCheck
boolean hasGrpcHealthCheck()
gRPC health check.
.envoy.config.core.v3.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
- Returns:
- Whether the grpcHealthCheck field is set.
-
getGrpcHealthCheck
HealthCheck.GrpcHealthCheck getGrpcHealthCheck()
gRPC health check.
.envoy.config.core.v3.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
- Returns:
- The grpcHealthCheck.
-
getGrpcHealthCheckOrBuilder
HealthCheck.GrpcHealthCheckOrBuilder getGrpcHealthCheckOrBuilder()
gRPC health check.
.envoy.config.core.v3.HealthCheck.GrpcHealthCheck grpc_health_check = 11;
-
hasCustomHealthCheck
boolean hasCustomHealthCheck()
Custom health check.
.envoy.config.core.v3.HealthCheck.CustomHealthCheck custom_health_check = 13;
- Returns:
- Whether the customHealthCheck field is set.
-
getCustomHealthCheck
HealthCheck.CustomHealthCheck getCustomHealthCheck()
Custom health check.
.envoy.config.core.v3.HealthCheck.CustomHealthCheck custom_health_check = 13;
- Returns:
- The customHealthCheck.
-
getCustomHealthCheckOrBuilder
HealthCheck.CustomHealthCheckOrBuilder getCustomHealthCheckOrBuilder()
Custom health check.
.envoy.config.core.v3.HealthCheck.CustomHealthCheck custom_health_check = 13;
-
hasNoTrafficInterval
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) = { ... }
- Returns:
- Whether the noTrafficInterval field is set.
-
getNoTrafficInterval
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) = { ... }
- Returns:
- The noTrafficInterval.
-
getNoTrafficIntervalOrBuilder
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) = { ... }
-
hasNoTrafficHealthyInterval
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) = { ... }
- Returns:
- Whether the noTrafficHealthyInterval field is set.
-
getNoTrafficHealthyInterval
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) = { ... }
- Returns:
- The noTrafficHealthyInterval.
-
getNoTrafficHealthyIntervalOrBuilder
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) = { ... }
-
hasUnhealthyInterval
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) = { ... }
- Returns:
- Whether the unhealthyInterval field is set.
-
getUnhealthyInterval
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) = { ... }
- Returns:
- The unhealthyInterval.
-
getUnhealthyIntervalOrBuilder
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) = { ... }
-
hasUnhealthyEdgeInterval
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) = { ... }
- Returns:
- Whether the unhealthyEdgeInterval field is set.
-
getUnhealthyEdgeInterval
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) = { ... }
- Returns:
- The unhealthyEdgeInterval.
-
getUnhealthyEdgeIntervalOrBuilder
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) = { ... }
-
hasHealthyEdgeInterval
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) = { ... }
- Returns:
- Whether the healthyEdgeInterval field is set.
-
getHealthyEdgeInterval
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) = { ... }
- Returns:
- The healthyEdgeInterval.
-
getHealthyEdgeIntervalOrBuilder
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) = { ... }
-
getEventLogPath
@Deprecated java.lang.String getEventLogPath()
Deprecated.envoy.config.core.v3.HealthCheck.event_log_path is deprecated. See envoy/config/core/v3/health_check.proto;l=384.. attention:: This field is deprecated in favor of the extension :ref:`event_logger <envoy_v3_api_field_config.core.v3.HealthCheck.event_logger>` and :ref:`event_log_path <envoy_v3_api_field_extensions.health_check.event_sinks.file.v3.HealthCheckEventFileSink.event_log_path>` in the file sink extension. Specifies the path to the :ref:`health check event log <arch_overview_health_check_logging>`.
string event_log_path = 17 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The eventLogPath.
-
getEventLogPathBytes
@Deprecated com.google.protobuf.ByteString getEventLogPathBytes()
Deprecated.envoy.config.core.v3.HealthCheck.event_log_path is deprecated. See envoy/config/core/v3/health_check.proto;l=384.. attention:: This field is deprecated in favor of the extension :ref:`event_logger <envoy_v3_api_field_config.core.v3.HealthCheck.event_logger>` and :ref:`event_log_path <envoy_v3_api_field_extensions.health_check.event_sinks.file.v3.HealthCheckEventFileSink.event_log_path>` in the file sink extension. Specifies the path to the :ref:`health check event log <arch_overview_health_check_logging>`.
string event_log_path = 17 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The bytes for eventLogPath.
-
getEventLoggerList
java.util.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;
-
getEventLogger
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;
-
getEventLoggerCount
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;
-
getEventLoggerOrBuilderList
java.util.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;
-
getEventLoggerOrBuilder
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;
-
hasEventService
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;
- Returns:
- Whether the eventService field is set.
-
getEventService
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;
- Returns:
- The eventService.
-
getEventServiceOrBuilder
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;
-
getAlwaysLogHealthCheckFailures
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;
- Returns:
- The alwaysLogHealthCheckFailures.
-
getAlwaysLogHealthCheckSuccess
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;
- Returns:
- The alwaysLogHealthCheckSuccess.
-
hasTlsOptions
boolean hasTlsOptions()
This allows overriding the cluster TLS settings, just for health check connections.
.envoy.config.core.v3.HealthCheck.TlsOptions tls_options = 21;
- Returns:
- Whether the tlsOptions field is set.
-
getTlsOptions
HealthCheck.TlsOptions getTlsOptions()
This allows overriding the cluster TLS settings, just for health check connections.
.envoy.config.core.v3.HealthCheck.TlsOptions tls_options = 21;
- Returns:
- The tlsOptions.
-
getTlsOptionsOrBuilder
HealthCheck.TlsOptionsOrBuilder getTlsOptionsOrBuilder()
This allows overriding the cluster TLS settings, just for health check connections.
.envoy.config.core.v3.HealthCheck.TlsOptions tls_options = 21;
-
hasTransportSocketMatchCriteria
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;
- Returns:
- Whether the transportSocketMatchCriteria field is set.
-
getTransportSocketMatchCriteria
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;
- Returns:
- The transportSocketMatchCriteria.
-
getTransportSocketMatchCriteriaOrBuilder
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;
-
getHealthCheckerCase
HealthCheck.HealthCheckerCase getHealthCheckerCase()
-
-