Interface Endpoint.HealthCheckConfigOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Address getAddress()
      Optional alternative health check host address.
      AddressOrBuilder getAddressOrBuilder()
      Optional alternative health check host address.
      boolean getDisableActiveHealthCheck()
      Optional flag to control if perform active health check for this endpoint.
      java.lang.String getHostname()
      By default, the host header for L7 health checks is controlled by cluster level configuration (see: :ref:`host <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.host>` and :ref:`authority <envoy_v3_api_field_config.core.v3.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_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.host>` and :ref:`authority <envoy_v3_api_field_config.core.v3.HealthCheck.GrpcHealthCheck.authority>`).
      int getPortValue()
      Optional alternative health check port value.
      boolean hasAddress()
      Optional alternative health check host address.
      • 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 Detail

      • 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

        java.lang.String getHostname()
         By default, the host header for L7 health checks is controlled by cluster level configuration
         (see: :ref:`host <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.host>` and
         :ref:`authority <envoy_v3_api_field_config.core.v3.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_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.host>` and
         :ref:`authority <envoy_v3_api_field_config.core.v3.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.
      • hasAddress

        boolean hasAddress()
         Optional alternative health check host address.
        
         .. attention::
        
         The form of the health check host address is expected to be a direct IP address.
         
        .envoy.config.core.v3.Address address = 3;
        Returns:
        Whether the address field is set.
      • getAddress

        Address getAddress()
         Optional alternative health check host address.
        
         .. attention::
        
         The form of the health check host address is expected to be a direct IP address.
         
        .envoy.config.core.v3.Address address = 3;
        Returns:
        The address.
      • getAddressOrBuilder

        AddressOrBuilder getAddressOrBuilder()
         Optional alternative health check host address.
        
         .. attention::
        
         The form of the health check host address is expected to be a direct IP address.
         
        .envoy.config.core.v3.Address address = 3;
      • getDisableActiveHealthCheck

        boolean getDisableActiveHealthCheck()
         Optional flag to control if perform active health check for this endpoint.
         Active health check is enabled by default if there is a health checker.
         
        bool disable_active_health_check = 4;
        Returns:
        The disableActiveHealthCheck.