Class HealthCheck.HttpHealthCheck
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.core.v3.HealthCheck.HttpHealthCheck
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,HealthCheck.HttpHealthCheckOrBuilder
,Serializable
- Enclosing class:
HealthCheck
public static final class HealthCheck.HttpHealthCheck
extends com.google.protobuf.GeneratedMessage
implements HealthCheck.HttpHealthCheckOrBuilder
[#next-free-field: 15]Protobuf type
envoy.config.core.v3.HealthCheck.HttpHealthCheck
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
[#next-free-field: 15]Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
static final int
private int
private static final HealthCheck.HttpHealthCheck
static final int
private List
<Int64Range> private Object
static final int
private byte
private int
static final int
private static final com.google.protobuf.Parser
<HealthCheck.HttpHealthCheck> private Object
static final int
private List
<HealthCheck.Payload> static final int
static final int
static final int
private List
<HeaderValueOption> private com.google.protobuf.LazyStringArrayList
static final int
private com.google.protobuf.UInt64Value
static final int
private List
<Int64Range> private HealthCheck.Payload
static final int
private static final long
static final int
private StringMatcher
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
HttpHealthCheck
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Use specified application protocol for health checks.int
Use specified application protocol for health checks.static HealthCheck.HttpHealthCheck
static final com.google.protobuf.Descriptors.Descriptor
getExpectedStatuses
(int index) Specifies a list of HTTP response statuses considered healthy.int
Specifies a list of HTTP response statuses considered healthy.Specifies a list of HTTP response statuses considered healthy.getExpectedStatusesOrBuilder
(int index) Specifies a list of HTTP response statuses considered healthy.List
<? extends Int64RangeOrBuilder> Specifies a list of HTTP response statuses considered healthy.getHost()
The value of the host header in the HTTP health check request.com.google.protobuf.ByteString
The value of the host header in the HTTP health check request.HTTP Method that will be used for health checking, default is "GET".int
HTTP Method that will be used for health checking, default is "GET".com.google.protobuf.Parser
<HealthCheck.HttpHealthCheck> getPath()
Specifies the HTTP path that will be requested during health checking.com.google.protobuf.ByteString
Specifies the HTTP path that will be requested during health checking.getReceive
(int index) Specifies a list of HTTP expected responses to match in the first ``response_buffer_size`` bytes of the response body.int
Specifies a list of HTTP expected responses to match in the first ``response_buffer_size`` bytes of the response body.Specifies a list of HTTP expected responses to match in the first ``response_buffer_size`` bytes of the response body.getReceiveOrBuilder
(int index) Specifies a list of HTTP expected responses to match in the first ``response_buffer_size`` bytes of the response body.List
<? extends HealthCheck.PayloadOrBuilder> Specifies a list of HTTP expected responses to match in the first ``response_buffer_size`` bytes of the response body.getRequestHeadersToAdd
(int index) Specifies a list of HTTP headers that should be added to each request that is sent to the health checked cluster.int
Specifies a list of HTTP headers that should be added to each request that is sent to the health checked cluster.Specifies a list of HTTP headers that should be added to each request that is sent to the health checked cluster.getRequestHeadersToAddOrBuilder
(int index) Specifies a list of HTTP headers that should be added to each request that is sent to the health checked cluster.List
<? extends HeaderValueOptionOrBuilder> Specifies a list of HTTP headers that should be added to each request that is sent to the health checked cluster.getRequestHeadersToRemove
(int index) Specifies a list of HTTP headers that should be removed from each request that is sent to the health checked cluster.com.google.protobuf.ByteString
getRequestHeadersToRemoveBytes
(int index) Specifies a list of HTTP headers that should be removed from each request that is sent to the health checked cluster.int
Specifies a list of HTTP headers that should be removed from each request that is sent to the health checked cluster.com.google.protobuf.ProtocolStringList
Specifies a list of HTTP headers that should be removed from each request that is sent to the health checked cluster.com.google.protobuf.UInt64Value
Specifies the size of response buffer in bytes that is used to Payload match.com.google.protobuf.UInt64ValueOrBuilder
Specifies the size of response buffer in bytes that is used to Payload match.getRetriableStatuses
(int index) Specifies a list of HTTP response statuses considered retriable.int
Specifies a list of HTTP response statuses considered retriable.Specifies a list of HTTP response statuses considered retriable.getRetriableStatusesOrBuilder
(int index) Specifies a list of HTTP response statuses considered retriable.List
<? extends Int64RangeOrBuilder> Specifies a list of HTTP response statuses considered retriable.getSend()
[#not-implemented-hide:] HTTP specific payload.[#not-implemented-hide:] HTTP specific payload.int
An optional service name parameter which is used to validate the identity of the health checked cluster using a :ref:`StringMatcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`.An optional service name parameter which is used to validate the identity of the health checked cluster using a :ref:`StringMatcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`.int
hashCode()
boolean
Specifies the size of response buffer in bytes that is used to Payload match.boolean
hasSend()
[#not-implemented-hide:] HTTP specific payload.boolean
An optional service name parameter which is used to validate the identity of the health checked cluster using a :ref:`StringMatcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
newBuilder
(HealthCheck.HttpHealthCheck prototype) protected HealthCheck.HttpHealthCheck.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static HealthCheck.HttpHealthCheck
parseDelimitedFrom
(InputStream input) static HealthCheck.HttpHealthCheck
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HealthCheck.HttpHealthCheck
parseFrom
(byte[] data) static HealthCheck.HttpHealthCheck
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HealthCheck.HttpHealthCheck
parseFrom
(com.google.protobuf.ByteString data) static HealthCheck.HttpHealthCheck
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HealthCheck.HttpHealthCheck
parseFrom
(com.google.protobuf.CodedInputStream input) static HealthCheck.HttpHealthCheck
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HealthCheck.HttpHealthCheck
parseFrom
(InputStream input) static HealthCheck.HttpHealthCheck
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HealthCheck.HttpHealthCheck
parseFrom
(ByteBuffer data) static HealthCheck.HttpHealthCheck
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<HealthCheck.HttpHealthCheck> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
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
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
HOST_FIELD_NUMBER
public static final int HOST_FIELD_NUMBER- See Also:
-
host_
-
PATH_FIELD_NUMBER
public static final int PATH_FIELD_NUMBER- See Also:
-
path_
-
SEND_FIELD_NUMBER
public static final int SEND_FIELD_NUMBER- See Also:
-
send_
-
RECEIVE_FIELD_NUMBER
public static final int RECEIVE_FIELD_NUMBER- See Also:
-
receive_
-
RESPONSE_BUFFER_SIZE_FIELD_NUMBER
public static final int RESPONSE_BUFFER_SIZE_FIELD_NUMBER- See Also:
-
responseBufferSize_
private com.google.protobuf.UInt64Value responseBufferSize_ -
REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
public static final int REQUEST_HEADERS_TO_ADD_FIELD_NUMBER- See Also:
-
requestHeadersToAdd_
-
REQUEST_HEADERS_TO_REMOVE_FIELD_NUMBER
public static final int REQUEST_HEADERS_TO_REMOVE_FIELD_NUMBER- See Also:
-
requestHeadersToRemove_
private com.google.protobuf.LazyStringArrayList requestHeadersToRemove_ -
EXPECTED_STATUSES_FIELD_NUMBER
public static final int EXPECTED_STATUSES_FIELD_NUMBER- See Also:
-
expectedStatuses_
-
RETRIABLE_STATUSES_FIELD_NUMBER
public static final int RETRIABLE_STATUSES_FIELD_NUMBER- See Also:
-
retriableStatuses_
-
CODEC_CLIENT_TYPE_FIELD_NUMBER
public static final int CODEC_CLIENT_TYPE_FIELD_NUMBER- See Also:
-
codecClientType_
private int codecClientType_ -
SERVICE_NAME_MATCHER_FIELD_NUMBER
public static final int SERVICE_NAME_MATCHER_FIELD_NUMBER- See Also:
-
serviceNameMatcher_
-
METHOD_FIELD_NUMBER
public static final int METHOD_FIELD_NUMBER- See Also:
-
method_
private int method_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
HttpHealthCheck
private HttpHealthCheck(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
HttpHealthCheck
private HttpHealthCheck()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getHost
The value of the host header in the HTTP health check request. If left empty (default value), the name of the cluster this health check is associated with will be used. The host header can be customized for a specific endpoint by setting the :ref:`hostname <envoy_v3_api_field_config.endpoint.v3.Endpoint.HealthCheckConfig.hostname>` field.
string host = 1 [(.validate.rules) = { ... }
- Specified by:
getHost
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- The host.
-
getHostBytes
public com.google.protobuf.ByteString getHostBytes()The value of the host header in the HTTP health check request. If left empty (default value), the name of the cluster this health check is associated with will be used. The host header can be customized for a specific endpoint by setting the :ref:`hostname <envoy_v3_api_field_config.endpoint.v3.Endpoint.HealthCheckConfig.hostname>` field.
string host = 1 [(.validate.rules) = { ... }
- Specified by:
getHostBytes
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- The bytes for host.
-
getPath
Specifies the HTTP path that will be requested during health checking. For example ``/healthcheck``.
string path = 2 [(.validate.rules) = { ... }
- Specified by:
getPath
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- The path.
-
getPathBytes
public com.google.protobuf.ByteString getPathBytes()Specifies the HTTP path that will be requested during health checking. For example ``/healthcheck``.
string path = 2 [(.validate.rules) = { ... }
- Specified by:
getPathBytes
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- The bytes for path.
-
hasSend
public boolean hasSend()[#not-implemented-hide:] HTTP specific payload.
.envoy.config.core.v3.HealthCheck.Payload send = 3;
- Specified by:
hasSend
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- Whether the send field is set.
-
getSend
[#not-implemented-hide:] HTTP specific payload.
.envoy.config.core.v3.HealthCheck.Payload send = 3;
- Specified by:
getSend
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- The send.
-
getSendOrBuilder
[#not-implemented-hide:] HTTP specific payload.
.envoy.config.core.v3.HealthCheck.Payload send = 3;
- Specified by:
getSendOrBuilder
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getReceiveList
Specifies a list of HTTP expected responses to match in the first ``response_buffer_size`` bytes of the response body. If it is set, both the expected response check and status code determine the health check. When checking the response, “fuzzy” matching is performed such that each payload block must be found, and in the order specified, but not necessarily contiguous. .. note:: It is recommended to set ``response_buffer_size`` based on the total Payload size for efficiency. The default buffer size is 1024 bytes when it is not set.
repeated .envoy.config.core.v3.HealthCheck.Payload receive = 4;
- Specified by:
getReceiveList
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getReceiveOrBuilderList
Specifies a list of HTTP expected responses to match in the first ``response_buffer_size`` bytes of the response body. If it is set, both the expected response check and status code determine the health check. When checking the response, “fuzzy” matching is performed such that each payload block must be found, and in the order specified, but not necessarily contiguous. .. note:: It is recommended to set ``response_buffer_size`` based on the total Payload size for efficiency. The default buffer size is 1024 bytes when it is not set.
repeated .envoy.config.core.v3.HealthCheck.Payload receive = 4;
- Specified by:
getReceiveOrBuilderList
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getReceiveCount
public int getReceiveCount()Specifies a list of HTTP expected responses to match in the first ``response_buffer_size`` bytes of the response body. If it is set, both the expected response check and status code determine the health check. When checking the response, “fuzzy” matching is performed such that each payload block must be found, and in the order specified, but not necessarily contiguous. .. note:: It is recommended to set ``response_buffer_size`` based on the total Payload size for efficiency. The default buffer size is 1024 bytes when it is not set.
repeated .envoy.config.core.v3.HealthCheck.Payload receive = 4;
- Specified by:
getReceiveCount
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getReceive
Specifies a list of HTTP expected responses to match in the first ``response_buffer_size`` bytes of the response body. If it is set, both the expected response check and status code determine the health check. When checking the response, “fuzzy” matching is performed such that each payload block must be found, and in the order specified, but not necessarily contiguous. .. note:: It is recommended to set ``response_buffer_size`` based on the total Payload size for efficiency. The default buffer size is 1024 bytes when it is not set.
repeated .envoy.config.core.v3.HealthCheck.Payload receive = 4;
- Specified by:
getReceive
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getReceiveOrBuilder
Specifies a list of HTTP expected responses to match in the first ``response_buffer_size`` bytes of the response body. If it is set, both the expected response check and status code determine the health check. When checking the response, “fuzzy” matching is performed such that each payload block must be found, and in the order specified, but not necessarily contiguous. .. note:: It is recommended to set ``response_buffer_size`` based on the total Payload size for efficiency. The default buffer size is 1024 bytes when it is not set.
repeated .envoy.config.core.v3.HealthCheck.Payload receive = 4;
- Specified by:
getReceiveOrBuilder
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
hasResponseBufferSize
public boolean hasResponseBufferSize()Specifies the size of response buffer in bytes that is used to Payload match. The default value is 1024. Setting to 0 implies that the Payload will be matched against the entire response.
.google.protobuf.UInt64Value response_buffer_size = 14 [(.validate.rules) = { ... }
- Specified by:
hasResponseBufferSize
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- Whether the responseBufferSize field is set.
-
getResponseBufferSize
public com.google.protobuf.UInt64Value getResponseBufferSize()Specifies the size of response buffer in bytes that is used to Payload match. The default value is 1024. Setting to 0 implies that the Payload will be matched against the entire response.
.google.protobuf.UInt64Value response_buffer_size = 14 [(.validate.rules) = { ... }
- Specified by:
getResponseBufferSize
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- The responseBufferSize.
-
getResponseBufferSizeOrBuilder
public com.google.protobuf.UInt64ValueOrBuilder getResponseBufferSizeOrBuilder()Specifies the size of response buffer in bytes that is used to Payload match. The default value is 1024. Setting to 0 implies that the Payload will be matched against the entire response.
.google.protobuf.UInt64Value response_buffer_size = 14 [(.validate.rules) = { ... }
- Specified by:
getResponseBufferSizeOrBuilder
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getRequestHeadersToAddList
Specifies a list of HTTP headers that should be added to each request that is sent to the health checked cluster. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToAddList
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getRequestHeadersToAddOrBuilderList
Specifies a list of HTTP headers that should be added to each request that is sent to the health checked cluster. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToAddOrBuilderList
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getRequestHeadersToAddCount
public int getRequestHeadersToAddCount()Specifies a list of HTTP headers that should be added to each request that is sent to the health checked cluster. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToAddCount
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getRequestHeadersToAdd
Specifies a list of HTTP headers that should be added to each request that is sent to the health checked cluster. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToAdd
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getRequestHeadersToAddOrBuilder
Specifies a list of HTTP headers that should be added to each request that is sent to the health checked cluster. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToAddOrBuilder
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getRequestHeadersToRemoveList
public com.google.protobuf.ProtocolStringList getRequestHeadersToRemoveList()Specifies a list of HTTP headers that should be removed from each request that is sent to the health checked cluster.
repeated string request_headers_to_remove = 8 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToRemoveList
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- A list containing the requestHeadersToRemove.
-
getRequestHeadersToRemoveCount
public int getRequestHeadersToRemoveCount()Specifies a list of HTTP headers that should be removed from each request that is sent to the health checked cluster.
repeated string request_headers_to_remove = 8 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToRemoveCount
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- The count of requestHeadersToRemove.
-
getRequestHeadersToRemove
Specifies a list of HTTP headers that should be removed from each request that is sent to the health checked cluster.
repeated string request_headers_to_remove = 8 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToRemove
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The requestHeadersToRemove at the given index.
-
getRequestHeadersToRemoveBytes
public com.google.protobuf.ByteString getRequestHeadersToRemoveBytes(int index) Specifies a list of HTTP headers that should be removed from each request that is sent to the health checked cluster.
repeated string request_headers_to_remove = 8 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToRemoveBytes
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the requestHeadersToRemove at the given index.
-
getExpectedStatusesList
Specifies a list of HTTP response statuses considered healthy. If provided, replaces default 200-only policy - 200 must be included explicitly as needed. Ranges follow half-open semantics of :ref:`Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`. The start and end of each range are required. Only statuses in the range [100, 600) are allowed.
repeated .envoy.type.v3.Int64Range expected_statuses = 9;
- Specified by:
getExpectedStatusesList
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getExpectedStatusesOrBuilderList
Specifies a list of HTTP response statuses considered healthy. If provided, replaces default 200-only policy - 200 must be included explicitly as needed. Ranges follow half-open semantics of :ref:`Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`. The start and end of each range are required. Only statuses in the range [100, 600) are allowed.
repeated .envoy.type.v3.Int64Range expected_statuses = 9;
- Specified by:
getExpectedStatusesOrBuilderList
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getExpectedStatusesCount
public int getExpectedStatusesCount()Specifies a list of HTTP response statuses considered healthy. If provided, replaces default 200-only policy - 200 must be included explicitly as needed. Ranges follow half-open semantics of :ref:`Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`. The start and end of each range are required. Only statuses in the range [100, 600) are allowed.
repeated .envoy.type.v3.Int64Range expected_statuses = 9;
- Specified by:
getExpectedStatusesCount
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getExpectedStatuses
Specifies a list of HTTP response statuses considered healthy. If provided, replaces default 200-only policy - 200 must be included explicitly as needed. Ranges follow half-open semantics of :ref:`Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`. The start and end of each range are required. Only statuses in the range [100, 600) are allowed.
repeated .envoy.type.v3.Int64Range expected_statuses = 9;
- Specified by:
getExpectedStatuses
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getExpectedStatusesOrBuilder
Specifies a list of HTTP response statuses considered healthy. If provided, replaces default 200-only policy - 200 must be included explicitly as needed. Ranges follow half-open semantics of :ref:`Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`. The start and end of each range are required. Only statuses in the range [100, 600) are allowed.
repeated .envoy.type.v3.Int64Range expected_statuses = 9;
- Specified by:
getExpectedStatusesOrBuilder
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getRetriableStatusesList
Specifies a list of HTTP response statuses considered retriable. If provided, responses in this range will count towards the configured :ref:`unhealthy_threshold <envoy_v3_api_field_config.core.v3.HealthCheck.unhealthy_threshold>`, but will not result in the host being considered immediately unhealthy. Ranges follow half-open semantics of :ref:`Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`. The start and end of each range are required. Only statuses in the range [100, 600) are allowed. The :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>` field takes precedence for any range overlaps with this field i.e. if status code 200 is both retriable and expected, a 200 response will be considered a successful health check. By default all responses not in :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>` will result in the host being considered immediately unhealthy i.e. if status code 200 is expected and there are no configured retriable statuses, any non-200 response will result in the host being marked unhealthy.
repeated .envoy.type.v3.Int64Range retriable_statuses = 12;
- Specified by:
getRetriableStatusesList
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getRetriableStatusesOrBuilderList
Specifies a list of HTTP response statuses considered retriable. If provided, responses in this range will count towards the configured :ref:`unhealthy_threshold <envoy_v3_api_field_config.core.v3.HealthCheck.unhealthy_threshold>`, but will not result in the host being considered immediately unhealthy. Ranges follow half-open semantics of :ref:`Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`. The start and end of each range are required. Only statuses in the range [100, 600) are allowed. The :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>` field takes precedence for any range overlaps with this field i.e. if status code 200 is both retriable and expected, a 200 response will be considered a successful health check. By default all responses not in :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>` will result in the host being considered immediately unhealthy i.e. if status code 200 is expected and there are no configured retriable statuses, any non-200 response will result in the host being marked unhealthy.
repeated .envoy.type.v3.Int64Range retriable_statuses = 12;
- Specified by:
getRetriableStatusesOrBuilderList
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getRetriableStatusesCount
public int getRetriableStatusesCount()Specifies a list of HTTP response statuses considered retriable. If provided, responses in this range will count towards the configured :ref:`unhealthy_threshold <envoy_v3_api_field_config.core.v3.HealthCheck.unhealthy_threshold>`, but will not result in the host being considered immediately unhealthy. Ranges follow half-open semantics of :ref:`Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`. The start and end of each range are required. Only statuses in the range [100, 600) are allowed. The :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>` field takes precedence for any range overlaps with this field i.e. if status code 200 is both retriable and expected, a 200 response will be considered a successful health check. By default all responses not in :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>` will result in the host being considered immediately unhealthy i.e. if status code 200 is expected and there are no configured retriable statuses, any non-200 response will result in the host being marked unhealthy.
repeated .envoy.type.v3.Int64Range retriable_statuses = 12;
- Specified by:
getRetriableStatusesCount
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getRetriableStatuses
Specifies a list of HTTP response statuses considered retriable. If provided, responses in this range will count towards the configured :ref:`unhealthy_threshold <envoy_v3_api_field_config.core.v3.HealthCheck.unhealthy_threshold>`, but will not result in the host being considered immediately unhealthy. Ranges follow half-open semantics of :ref:`Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`. The start and end of each range are required. Only statuses in the range [100, 600) are allowed. The :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>` field takes precedence for any range overlaps with this field i.e. if status code 200 is both retriable and expected, a 200 response will be considered a successful health check. By default all responses not in :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>` will result in the host being considered immediately unhealthy i.e. if status code 200 is expected and there are no configured retriable statuses, any non-200 response will result in the host being marked unhealthy.
repeated .envoy.type.v3.Int64Range retriable_statuses = 12;
- Specified by:
getRetriableStatuses
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getRetriableStatusesOrBuilder
Specifies a list of HTTP response statuses considered retriable. If provided, responses in this range will count towards the configured :ref:`unhealthy_threshold <envoy_v3_api_field_config.core.v3.HealthCheck.unhealthy_threshold>`, but will not result in the host being considered immediately unhealthy. Ranges follow half-open semantics of :ref:`Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`. The start and end of each range are required. Only statuses in the range [100, 600) are allowed. The :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>` field takes precedence for any range overlaps with this field i.e. if status code 200 is both retriable and expected, a 200 response will be considered a successful health check. By default all responses not in :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>` will result in the host being considered immediately unhealthy i.e. if status code 200 is expected and there are no configured retriable statuses, any non-200 response will result in the host being marked unhealthy.
repeated .envoy.type.v3.Int64Range retriable_statuses = 12;
- Specified by:
getRetriableStatusesOrBuilder
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getCodecClientTypeValue
public int getCodecClientTypeValue()Use specified application protocol for health checks.
.envoy.type.v3.CodecClientType codec_client_type = 10 [(.validate.rules) = { ... }
- Specified by:
getCodecClientTypeValue
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- The enum numeric value on the wire for codecClientType.
-
getCodecClientType
Use specified application protocol for health checks.
.envoy.type.v3.CodecClientType codec_client_type = 10 [(.validate.rules) = { ... }
- Specified by:
getCodecClientType
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- The codecClientType.
-
hasServiceNameMatcher
public boolean hasServiceNameMatcher()An optional service name parameter which is used to validate the identity of the health checked cluster using a :ref:`StringMatcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`. See the :ref:`architecture overview <arch_overview_health_checking_identity>` for more information.
.envoy.type.matcher.v3.StringMatcher service_name_matcher = 11;
- Specified by:
hasServiceNameMatcher
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- Whether the serviceNameMatcher field is set.
-
getServiceNameMatcher
An optional service name parameter which is used to validate the identity of the health checked cluster using a :ref:`StringMatcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`. See the :ref:`architecture overview <arch_overview_health_checking_identity>` for more information.
.envoy.type.matcher.v3.StringMatcher service_name_matcher = 11;
- Specified by:
getServiceNameMatcher
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- The serviceNameMatcher.
-
getServiceNameMatcherOrBuilder
An optional service name parameter which is used to validate the identity of the health checked cluster using a :ref:`StringMatcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`. See the :ref:`architecture overview <arch_overview_health_checking_identity>` for more information.
.envoy.type.matcher.v3.StringMatcher service_name_matcher = 11;
- Specified by:
getServiceNameMatcherOrBuilder
in interfaceHealthCheck.HttpHealthCheckOrBuilder
-
getMethodValue
public int getMethodValue()HTTP Method that will be used for health checking, default is "GET". GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, PATCH methods are supported, but making request body is not supported. CONNECT method is disallowed because it is not appropriate for health check request. If a non-200 response is expected by the method, it needs to be set in :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>`.
.envoy.config.core.v3.RequestMethod method = 13 [(.validate.rules) = { ... }
- Specified by:
getMethodValue
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- The enum numeric value on the wire for method.
-
getMethod
HTTP Method that will be used for health checking, default is "GET". GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, PATCH methods are supported, but making request body is not supported. CONNECT method is disallowed because it is not appropriate for health check request. If a non-200 response is expected by the method, it needs to be set in :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>`.
.envoy.config.core.v3.RequestMethod method = 13 [(.validate.rules) = { ... }
- Specified by:
getMethod
in interfaceHealthCheck.HttpHealthCheckOrBuilder
- Returns:
- The method.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static HealthCheck.HttpHealthCheck parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HealthCheck.HttpHealthCheck parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HealthCheck.HttpHealthCheck parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HealthCheck.HttpHealthCheck 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.HttpHealthCheck parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HealthCheck.HttpHealthCheck parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static HealthCheck.HttpHealthCheck parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static HealthCheck.HttpHealthCheck parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static HealthCheck.HttpHealthCheck parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static HealthCheck.HttpHealthCheck parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected HealthCheck.HttpHealthCheck.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-