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

Class HealthCheck.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>
io.envoyproxy.envoy.extensions.filters.http.health_check.v3.HealthCheck.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HealthCheckOrBuilder, Cloneable
Enclosing class:
HealthCheck
public static final class HealthCheck.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder> implements HealthCheckOrBuilder
 [#next-free-field: 6]
Protobuf type envoy.extensions.filters.http.health_check.v3.HealthCheck

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • clear

      public HealthCheck.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • getDefaultInstanceForType

      public HealthCheck getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public HealthCheck build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public HealthCheck buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public HealthCheck.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • setField

      public HealthCheck.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • clearField

      public HealthCheck.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • clearOneof

      public HealthCheck.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • setRepeatedField

      public HealthCheck.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • addRepeatedField

      public HealthCheck.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • mergeFrom

      public HealthCheck.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HealthCheck.Builder>

    • mergeFrom

      public HealthCheck.Builder mergeFrom(HealthCheck other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • mergeFrom

      public HealthCheck.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HealthCheck.Builder>
      Throws:
      IOException

    • hasPassThroughMode

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

    • getPassThroughMode

      public 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) = { ... }
      Specified by:
      getPassThroughMode in interface HealthCheckOrBuilder
      Returns:
      The passThroughMode.

    • setPassThroughMode

      public HealthCheck.Builder setPassThroughMode(com.google.protobuf.BoolValue value)
       Specifies whether the filter operates in pass through mode or not.
      .google.protobuf.BoolValue pass_through_mode = 1 [(.validate.rules) = { ... }

    • setPassThroughMode

      public HealthCheck.Builder setPassThroughMode(com.google.protobuf.BoolValue.Builder builderForValue)
       Specifies whether the filter operates in pass through mode or not.
      .google.protobuf.BoolValue pass_through_mode = 1 [(.validate.rules) = { ... }

    • mergePassThroughMode

      public HealthCheck.Builder mergePassThroughMode(com.google.protobuf.BoolValue value)
       Specifies whether the filter operates in pass through mode or not.
      .google.protobuf.BoolValue pass_through_mode = 1 [(.validate.rules) = { ... }

    • clearPassThroughMode

      public HealthCheck.Builder clearPassThroughMode()
       Specifies whether the filter operates in pass through mode or not.
      .google.protobuf.BoolValue pass_through_mode = 1 [(.validate.rules) = { ... }

    • getPassThroughModeBuilder

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

    • getPassThroughModeOrBuilder

      public 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) = { ... }
      Specified by:
      getPassThroughModeOrBuilder in interface HealthCheckOrBuilder

    • hasCacheTime

      public 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;
      Specified by:
      hasCacheTime in interface HealthCheckOrBuilder
      Returns:
      Whether the cacheTime field is set.

    • getCacheTime

      public 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;
      Specified by:
      getCacheTime in interface HealthCheckOrBuilder
      Returns:
      The cacheTime.

    • setCacheTime

      public HealthCheck.Builder setCacheTime(com.google.protobuf.Duration value)
       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;

    • setCacheTime

      public HealthCheck.Builder setCacheTime(com.google.protobuf.Duration.Builder builderForValue)
       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;

    • mergeCacheTime

      public HealthCheck.Builder mergeCacheTime(com.google.protobuf.Duration value)
       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;

    • clearCacheTime

      public HealthCheck.Builder clearCacheTime()
       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;

    • getCacheTimeBuilder

      public com.google.protobuf.Duration.Builder getCacheTimeBuilder()
       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;

    • getCacheTimeOrBuilder

      public 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;
      Specified by:
      getCacheTimeOrBuilder in interface HealthCheckOrBuilder

    • getClusterMinHealthyPercentagesCount

      public int getClusterMinHealthyPercentagesCount()
      Description copied from interface: HealthCheckOrBuilder
       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;
      Specified by:
      getClusterMinHealthyPercentagesCount in interface HealthCheckOrBuilder

    • containsClusterMinHealthyPercentages

      public 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;
      Specified by:
      containsClusterMinHealthyPercentages in interface HealthCheckOrBuilder

    • getClusterMinHealthyPercentages

      @Deprecated public Map<String,Percent> getClusterMinHealthyPercentages()
      Deprecated.
      Use getClusterMinHealthyPercentagesMap() instead.
      Specified by:
      getClusterMinHealthyPercentages in interface HealthCheckOrBuilder

    • getClusterMinHealthyPercentagesMap

      public 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;
      Specified by:
      getClusterMinHealthyPercentagesMap in interface HealthCheckOrBuilder

    • getClusterMinHealthyPercentagesOrDefault

      public 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;
      Specified by:
      getClusterMinHealthyPercentagesOrDefault in interface HealthCheckOrBuilder

    • getClusterMinHealthyPercentagesOrThrow

      public 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;
      Specified by:
      getClusterMinHealthyPercentagesOrThrow in interface HealthCheckOrBuilder

    • clearClusterMinHealthyPercentages

      public HealthCheck.Builder clearClusterMinHealthyPercentages()

    • removeClusterMinHealthyPercentages

      public HealthCheck.Builder removeClusterMinHealthyPercentages(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;

    • getMutableClusterMinHealthyPercentages

      @Deprecated public Map<String,Percent> getMutableClusterMinHealthyPercentages()
      Deprecated.
      Use alternate mutation accessors instead.

    • putClusterMinHealthyPercentages

      public HealthCheck.Builder putClusterMinHealthyPercentages(String key, Percent value)
       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;

    • putAllClusterMinHealthyPercentages

      public HealthCheck.Builder putAllClusterMinHealthyPercentages(Map<String,Percent> values)
       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;

    • putClusterMinHealthyPercentagesBuilderIfAbsent

      public Percent.Builder putClusterMinHealthyPercentagesBuilderIfAbsent(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

      public 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;
      Specified by:
      getHeadersList in interface HealthCheckOrBuilder

    • getHeadersCount

      public 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;
      Specified by:
      getHeadersCount in interface HealthCheckOrBuilder

    • getHeaders

      public 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;
      Specified by:
      getHeaders in interface HealthCheckOrBuilder

    • setHeaders

      public HealthCheck.Builder setHeaders(int index, HeaderMatcher value)
       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;

    • setHeaders

      public HealthCheck.Builder setHeaders(int index, HeaderMatcher.Builder builderForValue)
       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;

    • addHeaders

      public HealthCheck.Builder addHeaders(HeaderMatcher value)
       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;

    • addHeaders

      public HealthCheck.Builder addHeaders(int index, HeaderMatcher value)
       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;

    • addHeaders

      public HealthCheck.Builder addHeaders(HeaderMatcher.Builder builderForValue)
       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;

    • addHeaders

      public HealthCheck.Builder addHeaders(int index, HeaderMatcher.Builder builderForValue)
       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;

    • addAllHeaders

      public HealthCheck.Builder addAllHeaders(Iterable<? extends HeaderMatcher> values)
       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;

    • clearHeaders

      public HealthCheck.Builder clearHeaders()
       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;

    • removeHeaders

      public HealthCheck.Builder removeHeaders(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;

    • getHeadersBuilder

      public HeaderMatcher.Builder getHeadersBuilder(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;

    • getHeadersOrBuilder

      public 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;
      Specified by:
      getHeadersOrBuilder in interface HealthCheckOrBuilder

    • getHeadersOrBuilderList

      public 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;
      Specified by:
      getHeadersOrBuilderList in interface HealthCheckOrBuilder

    • addHeadersBuilder

      public HeaderMatcher.Builder addHeadersBuilder()
       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;

    • addHeadersBuilder

      public HeaderMatcher.Builder addHeadersBuilder(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;

    • getHeadersBuilderList

      public List<HeaderMatcher.Builder> getHeadersBuilderList()
       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;

    • setUnknownFields

      public final HealthCheck.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>

    • mergeUnknownFields

      public final HealthCheck.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>