envoy.api.v2.core

Interface HealthCheckOuterClass.HealthCheckOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

HealthCheckOuterClass.HealthCheck, HealthCheckOuterClass.HealthCheck.Builder

Enclosing class:

HealthCheckOuterClass

public static interface HealthCheckOuterClass.HealthCheckOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and 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.
HealthCheckOuterClass.HealthCheck.CustomHealthCheck	getCustomHealthCheck() Custom health check.
HealthCheckOuterClass.HealthCheck.CustomHealthCheckOrBuilder	getCustomHealthCheckOrBuilder() Custom health check.
String	getEventLogPath() Specifies the path to the :ref:`health check event log <arch_overview_health_check_logging>`.
com.google.protobuf.ByteString	getEventLogPathBytes() Specifies the path to the :ref:`health check event log <arch_overview_health_check_logging>`.
HealthCheckOuterClass.HealthCheck.GrpcHealthCheck	getGrpcHealthCheck() gRPC health check.
HealthCheckOuterClass.HealthCheck.GrpcHealthCheckOrBuilder	getGrpcHealthCheckOrBuilder() gRPC health check.
HealthCheckOuterClass.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.
HealthCheckOuterClass.HealthCheck.HttpHealthCheck	getHttpHealthCheck() HTTP health check.
HealthCheckOuterClass.HealthCheck.HttpHealthCheckOrBuilder	getHttpHealthCheckOrBuilder() HTTP health check.
com.google.protobuf.Duration	getInterval() The interval between health checks.
com.google.protobuf.Duration	getIntervalJitter() An optional jitter amount in millseconds.
com.google.protobuf.DurationOrBuilder	getIntervalJitterOrBuilder() An optional jitter amount in millseconds.
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	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.
HealthCheckOuterClass.HealthCheck.TcpHealthCheck	getTcpHealthCheck() TCP health check.
HealthCheckOuterClass.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.
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	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	hasInterval() The interval between health checks.
boolean	hasIntervalJitter() An optional jitter amount in millseconds.
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	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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

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 [(.gogoproto.stdduration) = true, (.validate.rules) = { ... }

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 [(.gogoproto.stdduration) = true, (.validate.rules) = { ... }

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 [(.gogoproto.stdduration) = true, (.validate.rules) = { ... }

hasInterval

boolean hasInterval()

 The interval between health checks.
 

.google.protobuf.Duration interval = 2 [(.gogoproto.stdduration) = true, (.validate.rules) = { ... }

getInterval

com.google.protobuf.Duration getInterval()

 The interval between health checks.
 

.google.protobuf.Duration interval = 2 [(.gogoproto.stdduration) = true, (.validate.rules) = { ... }

getIntervalOrBuilder

com.google.protobuf.DurationOrBuilder getIntervalOrBuilder()

 The interval between health checks.
 

.google.protobuf.Duration interval = 2 [(.gogoproto.stdduration) = true, (.validate.rules) = { ... }

hasIntervalJitter

boolean hasIntervalJitter()

 An optional jitter amount in millseconds. If specified, during every
 interval Envoy will add 0 to interval_jitter to the wait time.
 

.google.protobuf.Duration interval_jitter = 3;

getIntervalJitter

com.google.protobuf.Duration getIntervalJitter()

 An optional jitter amount in millseconds. If specified, during every
 interval Envoy will add 0 to interval_jitter to the wait time.
 

.google.protobuf.Duration interval_jitter = 3;

getIntervalJitterOrBuilder

com.google.protobuf.DurationOrBuilder getIntervalJitterOrBuilder()

 An optional jitter amount in millseconds. If specified, during every
 interval Envoy will add 0 to 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 0 to 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;

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

.google.protobuf.UInt32Value unhealthy_threshold = 4;

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

.google.protobuf.UInt32Value unhealthy_threshold = 4;

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

.google.protobuf.UInt32Value unhealthy_threshold = 4;

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;

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;

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;

hasAltPort

boolean hasAltPort()

 [#not-implemented-hide:] Non-serving port for health checking.
 

.google.protobuf.UInt32Value alt_port = 6;

getAltPort

com.google.protobuf.UInt32Value getAltPort()

 [#not-implemented-hide:] Non-serving port for health checking.
 

.google.protobuf.UInt32Value alt_port = 6;

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;

getReuseConnection

com.google.protobuf.BoolValue getReuseConnection()

 Reuse health check connection between health checks. Default is true.
 

.google.protobuf.BoolValue reuse_connection = 7;

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.api.v2.core.HealthCheck.HttpHealthCheck http_health_check = 8;

getHttpHealthCheck

HealthCheckOuterClass.HealthCheck.HttpHealthCheck getHttpHealthCheck()

 HTTP health check.
 

.envoy.api.v2.core.HealthCheck.HttpHealthCheck http_health_check = 8;

getHttpHealthCheckOrBuilder

HealthCheckOuterClass.HealthCheck.HttpHealthCheckOrBuilder getHttpHealthCheckOrBuilder()

 HTTP health check.
 

.envoy.api.v2.core.HealthCheck.HttpHealthCheck http_health_check = 8;

hasTcpHealthCheck

boolean hasTcpHealthCheck()

 TCP health check.
 

.envoy.api.v2.core.HealthCheck.TcpHealthCheck tcp_health_check = 9;

getTcpHealthCheck

HealthCheckOuterClass.HealthCheck.TcpHealthCheck getTcpHealthCheck()

 TCP health check.
 

.envoy.api.v2.core.HealthCheck.TcpHealthCheck tcp_health_check = 9;

getTcpHealthCheckOrBuilder

HealthCheckOuterClass.HealthCheck.TcpHealthCheckOrBuilder getTcpHealthCheckOrBuilder()

 TCP health check.
 

.envoy.api.v2.core.HealthCheck.TcpHealthCheck tcp_health_check = 9;

hasGrpcHealthCheck

boolean hasGrpcHealthCheck()

 gRPC health check.
 

.envoy.api.v2.core.HealthCheck.GrpcHealthCheck grpc_health_check = 11;

getGrpcHealthCheck

HealthCheckOuterClass.HealthCheck.GrpcHealthCheck getGrpcHealthCheck()

 gRPC health check.
 

.envoy.api.v2.core.HealthCheck.GrpcHealthCheck grpc_health_check = 11;

getGrpcHealthCheckOrBuilder

HealthCheckOuterClass.HealthCheck.GrpcHealthCheckOrBuilder getGrpcHealthCheckOrBuilder()

 gRPC health check.
 

.envoy.api.v2.core.HealthCheck.GrpcHealthCheck grpc_health_check = 11;

hasCustomHealthCheck

boolean hasCustomHealthCheck()

 Custom health check.
 

.envoy.api.v2.core.HealthCheck.CustomHealthCheck custom_health_check = 13;

getCustomHealthCheck

HealthCheckOuterClass.HealthCheck.CustomHealthCheck getCustomHealthCheck()

 Custom health check.
 

.envoy.api.v2.core.HealthCheck.CustomHealthCheck custom_health_check = 13;

getCustomHealthCheckOrBuilder

HealthCheckOuterClass.HealthCheck.CustomHealthCheckOrBuilder getCustomHealthCheckOrBuilder()

 Custom health check.
 

.envoy.api.v2.core.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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

getEventLogPath

String getEventLogPath()

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

string event_log_path = 17;

getEventLogPathBytes

com.google.protobuf.ByteString getEventLogPathBytes()

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

string event_log_path = 17;

getHealthCheckerCase

HealthCheckOuterClass.HealthCheck.HealthCheckerCase getHealthCheckerCase()