Package io.envoyproxy.envoy.api.v2.endpoint

Interface Endpoint.HealthCheckConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Endpoint.HealthCheckConfig, Endpoint.HealthCheckConfig.Builder
Enclosing class:
Endpoint
public static interface Endpoint.HealthCheckConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHostname()
    By default, the host header for L7 health checks is controlled by cluster level configuration (see: :ref:`host <envoy_api_field_core.HealthCheck.HttpHealthCheck.host>` and :ref:`authority <envoy_api_field_core.HealthCheck.GrpcHealthCheck.authority>`).
    com.google.protobuf.ByteString
    getHostnameBytes()
    By default, the host header for L7 health checks is controlled by cluster level configuration (see: :ref:`host <envoy_api_field_core.HealthCheck.HttpHealthCheck.host>` and :ref:`authority <envoy_api_field_core.HealthCheck.GrpcHealthCheck.authority>`).
    int
    getPortValue()
    Optional alternative health check port value.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getPortValue

      int getPortValue()
       Optional alternative health check port value.

 By default the health check address port of an upstream host is the same
 as the host's serving address port. This provides an alternative health
 check port. Setting this with a non-zero value allows an upstream host
 to have different health check address port.
      uint32 port_value = 1 [(.validate.rules) = { ... }
      Returns:
      The portValue.

    • getHostname

      String getHostname()
       By default, the host header for L7 health checks is controlled by cluster level configuration
 (see: :ref:`host <envoy_api_field_core.HealthCheck.HttpHealthCheck.host>` and
 :ref:`authority <envoy_api_field_core.HealthCheck.GrpcHealthCheck.authority>`). Setting this
 to a non-empty value allows overriding the cluster level configuration for a specific
 endpoint.
      string hostname = 2;
      Returns:
      The hostname.

    • getHostnameBytes

      com.google.protobuf.ByteString getHostnameBytes()
       By default, the host header for L7 health checks is controlled by cluster level configuration
 (see: :ref:`host <envoy_api_field_core.HealthCheck.HttpHealthCheck.host>` and
 :ref:`authority <envoy_api_field_core.HealthCheck.GrpcHealthCheck.authority>`). Setting this
 to a non-empty value allows overriding the cluster level configuration for a specific
 endpoint.
      string hostname = 2;
      Returns:
      The bytes for hostname.