Package io.envoyproxy.envoy.api.v2.core

Interface HealthCheck.HttpHealthCheckOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HealthCheck.HttpHealthCheck, HealthCheck.HttpHealthCheck.Builder
Enclosing class:
HealthCheck
public static interface HealthCheck.HttpHealthCheckOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • 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_api_field_endpoint.Endpoint.HealthCheckConfig.hostname>` field.
      string host = 1;
      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_api_field_endpoint.Endpoint.HealthCheckConfig.hostname>` field.
      string host = 1;
      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.api.v2.core.HealthCheck.Payload send = 3;
      Returns:
      Whether the send field is set.

    • getSend

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

    • getSendOrBuilder

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

    • hasReceive

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

    • getReceive

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

    • getReceiveOrBuilder

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

    • getServiceName

      @Deprecated String getServiceName()
      Deprecated.
      envoy.api.v2.core.HealthCheck.HttpHealthCheck.service_name is deprecated. See envoy/api/v2/core/health_check.proto;l=99
       An optional service name parameter which is used to validate the identity of
 the health checked cluster. See the :ref:`architecture overview
 <arch_overview_health_checking_identity>` for more information.

 .. attention::

   This field has been deprecated in favor of `service_name_matcher` for better flexibility
   over matching with service-cluster name.
      string service_name = 5 [deprecated = true];
      Returns:
      The serviceName.

    • getServiceNameBytes

      @Deprecated com.google.protobuf.ByteString getServiceNameBytes()
      Deprecated.
      envoy.api.v2.core.HealthCheck.HttpHealthCheck.service_name is deprecated. See envoy/api/v2/core/health_check.proto;l=99
       An optional service name parameter which is used to validate the identity of
 the health checked cluster. See the :ref:`architecture overview
 <arch_overview_health_checking_identity>` for more information.

 .. attention::

   This field has been deprecated in favor of `service_name_matcher` for better flexibility
   over matching with service-cluster name.
      string service_name = 5 [deprecated = true];
      Returns:
      The bytes for serviceName.

    • 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.api.v2.core.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.api.v2.core.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.api.v2.core.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.api.v2.core.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.api.v2.core.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;
      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;
      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;
      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the requestHeadersToRemove at the given index.

    • getUseHttp2

      @Deprecated boolean getUseHttp2()
      Deprecated.
      envoy.api.v2.core.HealthCheck.HttpHealthCheck.use_http2 is deprecated. See envoy/api/v2/core/health_check.proto;l=115
       If set, health checks will be made using http/2.
 Deprecated, use :ref:`codec_client_type
 <envoy_api_field_core.HealthCheck.HttpHealthCheck.codec_client_type>` instead.
      bool use_http2 = 7 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
      Returns:
      The useHttp2.

    • 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_api_msg_type.Int64Range>`. The start and end of each
 range are required. Only statuses in the range [100, 600) are allowed.
      repeated .envoy.type.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_api_msg_type.Int64Range>`. The start and end of each
 range are required. Only statuses in the range [100, 600) are allowed.
      repeated .envoy.type.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_api_msg_type.Int64Range>`. The start and end of each
 range are required. Only statuses in the range [100, 600) are allowed.
      repeated .envoy.type.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_api_msg_type.Int64Range>`. The start and end of each
 range are required. Only statuses in the range [100, 600) are allowed.
      repeated .envoy.type.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_api_msg_type.Int64Range>`. The start and end of each
 range are required. Only statuses in the range [100, 600) are allowed.
      repeated .envoy.type.Int64Range expected_statuses = 9;

    • getCodecClientTypeValue

      int getCodecClientTypeValue()
       Use specified application protocol for health checks.
      .envoy.type.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.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_api_msg_type.matcher.StringMatcher>`. See the :ref:`architecture overview
 <arch_overview_health_checking_identity>` for more information.
      .envoy.type.matcher.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_api_msg_type.matcher.StringMatcher>`. See the :ref:`architecture overview
 <arch_overview_health_checking_identity>` for more information.
      .envoy.type.matcher.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_api_msg_type.matcher.StringMatcher>`. See the :ref:`architecture overview
 <arch_overview_health_checking_identity>` for more information.
      .envoy.type.matcher.StringMatcher service_name_matcher = 11;