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

Class HealthCheck.HttpHealthCheck

    • Field Detail

      • SERVICE_NAME_FIELD_NUMBER

        public static final int SERVICE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_HEADERS_TO_ADD_FIELD_NUMBER

        public static final int REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_HEADERS_TO_REMOVE_FIELD_NUMBER

        public static final int REQUEST_HEADERS_TO_REMOVE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPECTED_STATUSES_FIELD_NUMBER

        public static final int EXPECTED_STATUSES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CODEC_CLIENT_TYPE_FIELD_NUMBER

        public static final int CODEC_CLIENT_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_NAME_MATCHER_FIELD_NUMBER

        public static final int SERVICE_NAME_MATCHER_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getHost

        public 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;
        Specified by:
        getHost in interface HealthCheck.HttpHealthCheckOrBuilder
        Returns:
        The host.

      • getHostBytes

        public 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;
        Specified by:
        getHostBytes in interface HealthCheck.HttpHealthCheckOrBuilder
        Returns:
        The bytes for host.

      • getPath

        public String getPath()
         Specifies the HTTP path that will be requested during health checking. For example
 */healthcheck*.
        string path = 2 [(.validate.rules) = { ... }
        Specified by:
        getPath in interface HealthCheck.HttpHealthCheckOrBuilder
        Returns:
        The path.

      • getPathBytes

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

      • hasSend

        public boolean hasSend()
         [#not-implemented-hide:] HTTP specific payload.
        .envoy.api.v2.core.HealthCheck.Payload send = 3;
        Specified by:
        hasSend in interface HealthCheck.HttpHealthCheckOrBuilder
        Returns:
        Whether the send field is set.

      • hasReceive

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

      • getServiceName

        @Deprecated
public 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];
        Specified by:
        getServiceName in interface HealthCheck.HttpHealthCheckOrBuilder
        Returns:
        The serviceName.

      • getServiceNameBytes

        @Deprecated
public 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];
        Specified by:
        getServiceNameBytes in interface HealthCheck.HttpHealthCheckOrBuilder
        Returns:
        The bytes for serviceName.

      • getRequestHeadersToAddList

        public 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) = { ... }
        Specified by:
        getRequestHeadersToAddList in interface HealthCheck.HttpHealthCheckOrBuilder

      • getRequestHeadersToAddOrBuilderList

        public 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) = { ... }
        Specified by:
        getRequestHeadersToAddOrBuilderList in interface HealthCheck.HttpHealthCheckOrBuilder

      • getRequestHeadersToAddCount

        public 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) = { ... }
        Specified by:
        getRequestHeadersToAddCount in interface HealthCheck.HttpHealthCheckOrBuilder

      • getRequestHeadersToAdd

        public 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) = { ... }
        Specified by:
        getRequestHeadersToAdd in interface HealthCheck.HttpHealthCheckOrBuilder

      • getRequestHeadersToAddOrBuilder

        public 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) = { ... }
        Specified by:
        getRequestHeadersToAddOrBuilder in interface HealthCheck.HttpHealthCheckOrBuilder

      • getRequestHeadersToRemoveList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getRequestHeadersToRemoveList in interface HealthCheck.HttpHealthCheckOrBuilder
        Returns:
        A list containing the requestHeadersToRemove.

      • getRequestHeadersToRemoveCount

        public 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;
        Specified by:
        getRequestHeadersToRemoveCount in interface HealthCheck.HttpHealthCheckOrBuilder
        Returns:
        The count of requestHeadersToRemove.

      • getRequestHeadersToRemove

        public 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;
        Specified by:
        getRequestHeadersToRemove in interface HealthCheck.HttpHealthCheckOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The requestHeadersToRemove at the given index.

      • getRequestHeadersToRemoveBytes

        public 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;
        Specified by:
        getRequestHeadersToRemoveBytes in interface HealthCheck.HttpHealthCheckOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the requestHeadersToRemove at the given index.

      • getUseHttp2

        @Deprecated
public 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];
        Specified by:
        getUseHttp2 in interface HealthCheck.HttpHealthCheckOrBuilder
        Returns:
        The useHttp2.

      • getExpectedStatusesList

        public 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;
        Specified by:
        getExpectedStatusesList in interface HealthCheck.HttpHealthCheckOrBuilder

      • getExpectedStatusesOrBuilderList

        public 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;
        Specified by:
        getExpectedStatusesOrBuilderList in interface HealthCheck.HttpHealthCheckOrBuilder

      • getExpectedStatusesCount

        public 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;
        Specified by:
        getExpectedStatusesCount in interface HealthCheck.HttpHealthCheckOrBuilder

      • getExpectedStatuses

        public 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;
        Specified by:
        getExpectedStatuses in interface HealthCheck.HttpHealthCheckOrBuilder

      • getExpectedStatusesOrBuilder

        public 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;
        Specified by:
        getExpectedStatusesOrBuilder in interface HealthCheck.HttpHealthCheckOrBuilder

      • getCodecClientTypeValue

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

      • hasServiceNameMatcher

        public 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;
        Specified by:
        hasServiceNameMatcher in interface HealthCheck.HttpHealthCheckOrBuilder
        Returns:
        Whether the serviceNameMatcher field is set.

      • getServiceNameMatcher

        public 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;
        Specified by:
        getServiceNameMatcher in interface HealthCheck.HttpHealthCheckOrBuilder
        Returns:
        The serviceNameMatcher.

      • getServiceNameMatcherOrBuilder

        public 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;
        Specified by:
        getServiceNameMatcherOrBuilder in interface HealthCheck.HttpHealthCheckOrBuilder

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 HealthCheck.HttpHealthCheck parseFrom​(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HealthCheck.HttpHealthCheck parseFrom​(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HealthCheck.HttpHealthCheck parseFrom​(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HealthCheck.HttpHealthCheck parseFrom​(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HealthCheck.HttpHealthCheck parseFrom​(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected HealthCheck.HttpHealthCheck.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<HealthCheck.HttpHealthCheck> 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.GeneratedMessageV3

      • getDefaultInstanceForType

        public HealthCheck.HttpHealthCheck getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder