Package io.envoyproxy.envoy.extensions.filters.http.health_check.v3

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

    Modifier and Type
    Method
    Description
    boolean
    containsClusterMinHealthyPercentages(String key)
    If operating in non-pass-through mode, specifies a set of upstream cluster names and the minimum percentage of servers in each of those clusters that must be healthy or degraded in order for the filter to return a 200.
    com.google.protobuf.Duration
    getCacheTime()
    If operating in pass through mode, the amount of time in milliseconds that the filter should cache the upstream response.
    com.google.protobuf.DurationOrBuilder
    getCacheTimeOrBuilder()
    If operating in pass through mode, the amount of time in milliseconds that the filter should cache the upstream response.
    Map<String,Percent>
    getClusterMinHealthyPercentages()
    Deprecated.
    int
    getClusterMinHealthyPercentagesCount()
    If operating in non-pass-through mode, specifies a set of upstream cluster names and the minimum percentage of servers in each of those clusters that must be healthy or degraded in order for the filter to return a 200.
    Map<String,Percent>
    getClusterMinHealthyPercentagesMap()
    If operating in non-pass-through mode, specifies a set of upstream cluster names and the minimum percentage of servers in each of those clusters that must be healthy or degraded in order for the filter to return a 200.
    Percent
    getClusterMinHealthyPercentagesOrDefault(String key, Percent defaultValue)
    If operating in non-pass-through mode, specifies a set of upstream cluster names and the minimum percentage of servers in each of those clusters that must be healthy or degraded in order for the filter to return a 200.
    Percent
    getClusterMinHealthyPercentagesOrThrow(String key)
    If operating in non-pass-through mode, specifies a set of upstream cluster names and the minimum percentage of servers in each of those clusters that must be healthy or degraded in order for the filter to return a 200.
    HeaderMatcher
    getHeaders(int index)
    Specifies a set of health check request headers to match on.
    int
    getHeadersCount()
    Specifies a set of health check request headers to match on.
    List<HeaderMatcher>
    getHeadersList()
    Specifies a set of health check request headers to match on.
    HeaderMatcherOrBuilder
    getHeadersOrBuilder(int index)
    Specifies a set of health check request headers to match on.
    List<? extends HeaderMatcherOrBuilder>
    getHeadersOrBuilderList()
    Specifies a set of health check request headers to match on.
    com.google.protobuf.BoolValue
    getPassThroughMode()
    Specifies whether the filter operates in pass through mode or not.
    com.google.protobuf.BoolValueOrBuilder
    getPassThroughModeOrBuilder()
    Specifies whether the filter operates in pass through mode or not.
    boolean
    hasCacheTime()
    If operating in pass through mode, the amount of time in milliseconds that the filter should cache the upstream response.
    boolean
    hasPassThroughMode()
    Specifies whether the filter operates in pass through mode or not.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasPassThroughMode

      boolean hasPassThroughMode()
       Specifies whether the filter operates in pass through mode or not.
      .google.protobuf.BoolValue pass_through_mode = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the passThroughMode field is set.

    • getPassThroughMode

      com.google.protobuf.BoolValue getPassThroughMode()
       Specifies whether the filter operates in pass through mode or not.
      .google.protobuf.BoolValue pass_through_mode = 1 [(.validate.rules) = { ... }
      Returns:
      The passThroughMode.

    • getPassThroughModeOrBuilder

      com.google.protobuf.BoolValueOrBuilder getPassThroughModeOrBuilder()
       Specifies whether the filter operates in pass through mode or not.
      .google.protobuf.BoolValue pass_through_mode = 1 [(.validate.rules) = { ... }

    • hasCacheTime

      boolean hasCacheTime()
       If operating in pass through mode, the amount of time in milliseconds
 that the filter should cache the upstream response.
      .google.protobuf.Duration cache_time = 3;
      Returns:
      Whether the cacheTime field is set.

    • getCacheTime

      com.google.protobuf.Duration getCacheTime()
       If operating in pass through mode, the amount of time in milliseconds
 that the filter should cache the upstream response.
      .google.protobuf.Duration cache_time = 3;
      Returns:
      The cacheTime.

    • getCacheTimeOrBuilder

      com.google.protobuf.DurationOrBuilder getCacheTimeOrBuilder()
       If operating in pass through mode, the amount of time in milliseconds
 that the filter should cache the upstream response.
      .google.protobuf.Duration cache_time = 3;

    • getClusterMinHealthyPercentagesCount

      int getClusterMinHealthyPercentagesCount()
       If operating in non-pass-through mode, specifies a set of upstream cluster
 names and the minimum percentage of servers in each of those clusters that
 must be healthy or degraded in order for the filter to return a 200. If any of
 the clusters configured here does not exist, the filter will not return a 200.

 .. note::

    This value is interpreted as an integer by truncating, so 12.50% will be calculated
    as if it were 12%.
      map<string, .envoy.type.v3.Percent> cluster_min_healthy_percentages = 4;

    • containsClusterMinHealthyPercentages

      boolean containsClusterMinHealthyPercentages(String key)
       If operating in non-pass-through mode, specifies a set of upstream cluster
 names and the minimum percentage of servers in each of those clusters that
 must be healthy or degraded in order for the filter to return a 200. If any of
 the clusters configured here does not exist, the filter will not return a 200.

 .. note::

    This value is interpreted as an integer by truncating, so 12.50% will be calculated
    as if it were 12%.
      map<string, .envoy.type.v3.Percent> cluster_min_healthy_percentages = 4;

    • getClusterMinHealthyPercentages

      @Deprecated Map<String,Percent> getClusterMinHealthyPercentages()
      Deprecated.
      Use getClusterMinHealthyPercentagesMap() instead.

    • getClusterMinHealthyPercentagesMap

      Map<String,Percent> getClusterMinHealthyPercentagesMap()
       If operating in non-pass-through mode, specifies a set of upstream cluster
 names and the minimum percentage of servers in each of those clusters that
 must be healthy or degraded in order for the filter to return a 200. If any of
 the clusters configured here does not exist, the filter will not return a 200.

 .. note::

    This value is interpreted as an integer by truncating, so 12.50% will be calculated
    as if it were 12%.
      map<string, .envoy.type.v3.Percent> cluster_min_healthy_percentages = 4;

    • getClusterMinHealthyPercentagesOrDefault

      Percent getClusterMinHealthyPercentagesOrDefault(String key, Percent defaultValue)
       If operating in non-pass-through mode, specifies a set of upstream cluster
 names and the minimum percentage of servers in each of those clusters that
 must be healthy or degraded in order for the filter to return a 200. If any of
 the clusters configured here does not exist, the filter will not return a 200.

 .. note::

    This value is interpreted as an integer by truncating, so 12.50% will be calculated
    as if it were 12%.
      map<string, .envoy.type.v3.Percent> cluster_min_healthy_percentages = 4;

    • getClusterMinHealthyPercentagesOrThrow

      Percent getClusterMinHealthyPercentagesOrThrow(String key)
       If operating in non-pass-through mode, specifies a set of upstream cluster
 names and the minimum percentage of servers in each of those clusters that
 must be healthy or degraded in order for the filter to return a 200. If any of
 the clusters configured here does not exist, the filter will not return a 200.

 .. note::

    This value is interpreted as an integer by truncating, so 12.50% will be calculated
    as if it were 12%.
      map<string, .envoy.type.v3.Percent> cluster_min_healthy_percentages = 4;

    • getHeadersList

      List<HeaderMatcher> getHeadersList()
       Specifies a set of health check request headers to match on. The health check filter will
 check a request’s headers against all the specified headers. To specify the health check
 endpoint, set the ``:path`` header to match on.
      repeated .envoy.config.route.v3.HeaderMatcher headers = 5;

    • getHeaders

      HeaderMatcher getHeaders(int index)
       Specifies a set of health check request headers to match on. The health check filter will
 check a request’s headers against all the specified headers. To specify the health check
 endpoint, set the ``:path`` header to match on.
      repeated .envoy.config.route.v3.HeaderMatcher headers = 5;

    • getHeadersCount

      int getHeadersCount()
       Specifies a set of health check request headers to match on. The health check filter will
 check a request’s headers against all the specified headers. To specify the health check
 endpoint, set the ``:path`` header to match on.
      repeated .envoy.config.route.v3.HeaderMatcher headers = 5;

    • getHeadersOrBuilderList

      List<? extends HeaderMatcherOrBuilder> getHeadersOrBuilderList()
       Specifies a set of health check request headers to match on. The health check filter will
 check a request’s headers against all the specified headers. To specify the health check
 endpoint, set the ``:path`` header to match on.
      repeated .envoy.config.route.v3.HeaderMatcher headers = 5;

    • getHeadersOrBuilder

      HeaderMatcherOrBuilder getHeadersOrBuilder(int index)
       Specifies a set of health check request headers to match on. The health check filter will
 check a request’s headers against all the specified headers. To specify the health check
 endpoint, set the ``:path`` header to match on.
      repeated .envoy.config.route.v3.HeaderMatcher headers = 5;