Package io.envoyproxy.envoy.config.core.v3

Interface HealthCheck.HttpHealthCheckOrBuilder

    • Method Detail

      • getHost

        String 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) = { ... }
        Returns:
        The host.

      • getHostBytes

        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) = { ... }
        Returns:
        The bytes for host.

      • getPath

        String getPath()
         Specifies the HTTP path that will be requested during health checking. For example
 ``/healthcheck``.
        string path = 2 [(.validate.rules) = { ... }
        Returns:
        The path.

      • getPathBytes

        com.google.protobuf.ByteString getPathBytes()
         Specifies the HTTP path that will be requested during health checking. For example
 ``/healthcheck``.
        string path = 2 [(.validate.rules) = { ... }
        Returns:
        The bytes for path.

      • hasSend

        boolean hasSend()
         [#not-implemented-hide:] HTTP specific payload.
        .envoy.config.core.v3.HealthCheck.Payload send = 3;
        Returns:
        Whether the send field is set.

      • getSend

        HealthCheck.Payload getSend()
         [#not-implemented-hide:] HTTP specific payload.
        .envoy.config.core.v3.HealthCheck.Payload send = 3;
        Returns:
        The send.

      • getSendOrBuilder

        HealthCheck.PayloadOrBuilder getSendOrBuilder()
         [#not-implemented-hide:] HTTP specific payload.
        .envoy.config.core.v3.HealthCheck.Payload send = 3;

      • hasReceive

        boolean hasReceive()
         [#not-implemented-hide:] HTTP specific response.
        .envoy.config.core.v3.HealthCheck.Payload receive = 4;
        Returns:
        Whether the receive field is set.

      • getReceive

        HealthCheck.Payload getReceive()
         [#not-implemented-hide:] HTTP specific response.
        .envoy.config.core.v3.HealthCheck.Payload receive = 4;
        Returns:
        The receive.

      • getReceiveOrBuilder

        HealthCheck.PayloadOrBuilder getReceiveOrBuilder()
         [#not-implemented-hide:] HTTP specific response.
        .envoy.config.core.v3.HealthCheck.Payload receive = 4;

      • getRequestHeadersToAddList

        List<HeaderValueOption> 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) = { ... }

      • getRequestHeadersToAdd

        HeaderValueOption getRequestHeadersToAdd​(int index)
         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) = { ... }

      • getRequestHeadersToAddCount

        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) = { ... }

      • getRequestHeadersToAddOrBuilderList

        List<? extends HeaderValueOptionOrBuilder> 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) = { ... }

      • getRequestHeadersToAddOrBuilder

        HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder​(int index)
         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) = { ... }

      • getRequestHeadersToRemoveList

        List<String> 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) = { ... }
        Returns:
        A list containing the requestHeadersToRemove.

      • getRequestHeadersToRemoveCount

        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) = { ... }
        Returns:
        The count of requestHeadersToRemove.

      • getRequestHeadersToRemove

        String getRequestHeadersToRemove​(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) = { ... }
        Parameters:
        index - The index of the element to return.
        Returns:
        The requestHeadersToRemove at the given index.

      • getRequestHeadersToRemoveBytes

        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) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the requestHeadersToRemove at the given index.

      • getExpectedStatusesList

        List<Int64Range> 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;

      • getExpectedStatuses

        Int64Range getExpectedStatuses​(int index)
         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;

      • getExpectedStatusesCount

        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;

      • getExpectedStatusesOrBuilderList

        List<? extends Int64RangeOrBuilder> 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;

      • getExpectedStatusesOrBuilder

        Int64RangeOrBuilder getExpectedStatusesOrBuilder​(int index)
         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;

      • getRetriableStatusesList

        List<Int64Range> 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;

      • getRetriableStatuses

        Int64Range getRetriableStatuses​(int index)
         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;

      • getRetriableStatusesCount

        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;

      • getRetriableStatusesOrBuilderList

        List<? extends Int64RangeOrBuilder> 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;

      • getRetriableStatusesOrBuilder

        Int64RangeOrBuilder getRetriableStatusesOrBuilder​(int index)
         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;

      • getCodecClientTypeValue

        int getCodecClientTypeValue()
         Use specified application protocol for health checks.
        .envoy.type.v3.CodecClientType codec_client_type = 10 [(.validate.rules) = { ... }
        Returns:
        The enum numeric value on the wire for codecClientType.

      • getCodecClientType

        CodecClientType getCodecClientType()
         Use specified application protocol for health checks.
        .envoy.type.v3.CodecClientType codec_client_type = 10 [(.validate.rules) = { ... }
        Returns:
        The codecClientType.

      • hasServiceNameMatcher

        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;
        Returns:
        Whether the serviceNameMatcher field is set.

      • getServiceNameMatcher

        StringMatcher 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;
        Returns:
        The serviceNameMatcher.

      • getServiceNameMatcherOrBuilder

        StringMatcherOrBuilder 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;