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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static 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<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 int`	`CACHE_TIME_FIELD_NUMBER`
`static int`	`CLUSTER_MIN_HEALTHY_PERCENTAGES_FIELD_NUMBER`
`static int`	`HEADERS_FIELD_NUMBER`
`static 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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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. .. note:: This value is interpreted as an integer by truncating, so 12.50% will be calculated as if it were 12%.
`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. .. note:: This value is interpreted as an integer by truncating, so 12.50% will be calculated as if it were 12%.
`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. .. note:: This value is interpreted as an integer by truncating, so 12.50% will be calculated as if it were 12%.
`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. .. note:: This value is interpreted as an integer by truncating, so 12.50% will be calculated as if it were 12%.
`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. .. note:: This value is interpreted as an integer by truncating, so 12.50% will be calculated as if it were 12%.
`static HealthCheck`	`getDefaultInstance()`
`HealthCheck`	`getDefaultInstanceForType()`
`static 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()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`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.MapField`	`internalGetMapField(int number)`
`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, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, 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, hasField, hasOneof

Field Detail
- PASS_THROUGH_MODE_FIELD_NUMBER
```
public static final int PASS_THROUGH_MODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CACHE_TIME_FIELD_NUMBER
```
public static final int CACHE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CLUSTER_MIN_HEALTHY_PERCENTAGES_FIELD_NUMBER
```
public static final int CLUSTER_MIN_HEALTHY_PERCENTAGES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HEADERS_FIELD_NUMBER
```
public static final int HEADERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

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