Package io.envoyproxy.envoy.config.endpoint.v3

Class Endpoint.HealthCheckConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.endpoint.v3.Endpoint.HealthCheckConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Endpoint.HealthCheckConfigOrBuilder, Serializable
Enclosing class:
Endpoint
public static final class Endpoint.HealthCheckConfig extends com.google.protobuf.GeneratedMessage implements Endpoint.HealthCheckConfigOrBuilder
 The optional health check configuration.
Protobuf type envoy.config.endpoint.v3.Endpoint.HealthCheckConfig
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • PORT_VALUE_FIELD_NUMBER

      public static final int PORT_VALUE_FIELD_NUMBER
      See Also:

    • portValue_

      private int portValue_

    • HOSTNAME_FIELD_NUMBER

      public static final int HOSTNAME_FIELD_NUMBER
      See Also:

    • hostname_

      private volatile Object hostname_

    • ADDRESS_FIELD_NUMBER

      public static final int ADDRESS_FIELD_NUMBER
      See Also:

    • address_

      private Address address_

    • DISABLE_ACTIVE_HEALTH_CHECK_FIELD_NUMBER

      public static final int DISABLE_ACTIVE_HEALTH_CHECK_FIELD_NUMBER
      See Also:

    • disableActiveHealthCheck_

      private boolean disableActiveHealthCheck_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final Endpoint.HealthCheckConfig DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<Endpoint.HealthCheckConfig> PARSER

  • Constructor Details

    • HealthCheckConfig

      private HealthCheckConfig(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • HealthCheckConfig

      private HealthCheckConfig()

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPortValue

      public 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) = { ... }
      Specified by:
      getPortValue in interface Endpoint.HealthCheckConfigOrBuilder
      Returns:
      The portValue.

    • getHostname

      public 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;
      Specified by:
      getHostname in interface Endpoint.HealthCheckConfigOrBuilder
      Returns:
      The hostname.

    • getHostnameBytes

      public 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;
      Specified by:
      getHostnameBytes in interface Endpoint.HealthCheckConfigOrBuilder
      Returns:
      The bytes for hostname.

    • hasAddress

      public 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;
      Specified by:
      hasAddress in interface Endpoint.HealthCheckConfigOrBuilder
      Returns:
      Whether the address field is set.

    • getAddress

      public 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;
      Specified by:
      getAddress in interface Endpoint.HealthCheckConfigOrBuilder
      Returns:
      The address.

    • getAddressOrBuilder

      public 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;
      Specified by:
      getAddressOrBuilder in interface Endpoint.HealthCheckConfigOrBuilder

    • getDisableActiveHealthCheck

      public 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;
      Specified by:
      getDisableActiveHealthCheck in interface Endpoint.HealthCheckConfigOrBuilder
      Returns:
      The disableActiveHealthCheck.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Endpoint.HealthCheckConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Endpoint.HealthCheckConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Endpoint.HealthCheckConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Endpoint.HealthCheckConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Endpoint.HealthCheckConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Endpoint.HealthCheckConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Endpoint.HealthCheckConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Endpoint.HealthCheckConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Endpoint.HealthCheckConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Endpoint.HealthCheckConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Endpoint.HealthCheckConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Endpoint.HealthCheckConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Endpoint.HealthCheckConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Endpoint.HealthCheckConfig.Builder newBuilder()

    • newBuilder

      public static Endpoint.HealthCheckConfig.Builder newBuilder(Endpoint.HealthCheckConfig prototype)

    • toBuilder

      public Endpoint.HealthCheckConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Endpoint.HealthCheckConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Endpoint.HealthCheckConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Endpoint.HealthCheckConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<Endpoint.HealthCheckConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Endpoint.HealthCheckConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder