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

Class HealthCheck

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    HealthCheck.Builder
    [#next-free-field: 6]

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CACHE_TIME_FIELD_NUMBER
     
    static final int
    CLUSTER_MIN_HEALTHY_PERCENTAGES_FIELD_NUMBER
     
    static final int
    HEADERS_FIELD_NUMBER
     
    static final int
    PASS_THROUGH_MODE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • 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.
    boolean
    equals(Object obj)
     
    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.
    static HealthCheck
    getDefaultInstance()
     
    HealthCheck
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.Parser<HealthCheck>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    boolean
    hasCacheTime()
    If operating in pass through mode, the amount of time in milliseconds that the filter should cache the upstream response.
    int
    hashCode()
     
    boolean
    hasPassThroughMode()
    Specifies whether the filter operates in pass through mode or not.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static HealthCheck.Builder
    newBuilder()
     
    static HealthCheck.Builder
    newBuilder(HealthCheck prototype)
     
    HealthCheck.Builder
    newBuilderForType()
     
    protected HealthCheck.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static HealthCheck
    parseDelimitedFrom(InputStream input)
     
    static HealthCheck
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HealthCheck
    parseFrom(byte[] data)
     
    static HealthCheck
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HealthCheck
    parseFrom(com.google.protobuf.ByteString data)
     
    static HealthCheck
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HealthCheck
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static HealthCheck
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HealthCheck
    parseFrom(InputStream input)
     
    static HealthCheck
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HealthCheck
    parseFrom(ByteBuffer data)
     
    static HealthCheck
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<HealthCheck>
    parser()
     
    HealthCheck.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • PASS_THROUGH_MODE_FIELD_NUMBER

      public static final int PASS_THROUGH_MODE_FIELD_NUMBER
      See Also:

    • CACHE_TIME_FIELD_NUMBER

      public static final int CACHE_TIME_FIELD_NUMBER
      See Also:

    • CLUSTER_MIN_HEALTHY_PERCENTAGES_FIELD_NUMBER

      public static final int CLUSTER_MIN_HEALTHY_PERCENTAGES_FIELD_NUMBER
      See Also:

    • HEADERS_FIELD_NUMBER

      public static final int HEADERS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • 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.

    • 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.

    • 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

    • 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

    • 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

    • 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

    • 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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static HealthCheck parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthCheck parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthCheck parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthCheck parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthCheck parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthCheck parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthCheck parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HealthCheck parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HealthCheck parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HealthCheck parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HealthCheck parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HealthCheck parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static HealthCheck.Builder newBuilder()

    • newBuilder

      public static HealthCheck.Builder newBuilder(HealthCheck prototype)

    • toBuilder

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

    • newBuilderForType

      protected HealthCheck.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static HealthCheck getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<HealthCheck> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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