Package io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3

Class HttpConnectionManager.ProxyStatusConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpConnectionManager.ProxyStatusConfigOrBuilder, Serializable
    Enclosing class:
    HttpConnectionManager
    public static final class HttpConnectionManager.ProxyStatusConfig
extends com.google.protobuf.GeneratedMessageV3
implements HttpConnectionManager.ProxyStatusConfigOrBuilder
     Configures the manner in which the Proxy-Status HTTP response header is
 populated.
 See the [Proxy-Status
 RFC](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-proxy-status-08).
 [#comment:TODO: Update this with the non-draft URL when finalized.]
 The Proxy-Status header is a string of the form:
   "<server_name>; error=<error_type>; details=<details>"
 [#next-free-field: 7]
    Protobuf type envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.ProxyStatusConfig
    See Also:
    Serialized Form

    • Field Detail

      • REMOVE_DETAILS_FIELD_NUMBER

        public static final int REMOVE_DETAILS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REMOVE_CONNECTION_TERMINATION_DETAILS_FIELD_NUMBER

        public static final int REMOVE_CONNECTION_TERMINATION_DETAILS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REMOVE_RESPONSE_FLAGS_FIELD_NUMBER

        public static final int REMOVE_RESPONSE_FLAGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SET_RECOMMENDED_RESPONSE_CODE_FIELD_NUMBER

        public static final int SET_RECOMMENDED_RESPONSE_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USE_NODE_ID_FIELD_NUMBER

        public static final int USE_NODE_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LITERAL_PROXY_NAME_FIELD_NUMBER

        public static final int LITERAL_PROXY_NAME_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

      • getRemoveDetails

        public boolean getRemoveDetails()
         If true, the details field of the Proxy-Status header is not populated with stream_info.response_code_details.
 This value defaults to ``false``, i.e. the ``details`` field is populated by default.
        bool remove_details = 1;
        Specified by:
        getRemoveDetails in interface HttpConnectionManager.ProxyStatusConfigOrBuilder
        Returns:
        The removeDetails.

      • getRemoveConnectionTerminationDetails

        public boolean getRemoveConnectionTerminationDetails()
         If true, the details field of the Proxy-Status header will not contain
 connection termination details. This value defaults to ``false``, i.e. the
 ``details`` field will contain connection termination details by default.
        bool remove_connection_termination_details = 2;
        Specified by:
        getRemoveConnectionTerminationDetails in interface HttpConnectionManager.ProxyStatusConfigOrBuilder
        Returns:
        The removeConnectionTerminationDetails.

      • getRemoveResponseFlags

        public boolean getRemoveResponseFlags()
         If true, the details field of the Proxy-Status header will not contain an
 enumeration of the Envoy ResponseFlags. This value defaults to ``false``,
 i.e. the ``details`` field will contain a list of ResponseFlags by default.
        bool remove_response_flags = 3;
        Specified by:
        getRemoveResponseFlags in interface HttpConnectionManager.ProxyStatusConfigOrBuilder
        Returns:
        The removeResponseFlags.

      • getSetRecommendedResponseCode

        public boolean getSetRecommendedResponseCode()
         If true, overwrites the existing Status header with the response code
 recommended by the Proxy-Status spec.
 This value defaults to ``false``, i.e. the HTTP response code is not
 overwritten.
        bool set_recommended_response_code = 4;
        Specified by:
        getSetRecommendedResponseCode in interface HttpConnectionManager.ProxyStatusConfigOrBuilder
        Returns:
        The setRecommendedResponseCode.

      • hasUseNodeId

        public boolean hasUseNodeId()
         If ``use_node_id`` is set, Proxy-Status headers will use the Envoy's node
 ID as the name of the proxy.
        bool use_node_id = 5;
        Specified by:
        hasUseNodeId in interface HttpConnectionManager.ProxyStatusConfigOrBuilder
        Returns:
        Whether the useNodeId field is set.

      • hasLiteralProxyName

        public boolean hasLiteralProxyName()
         If ``literal_proxy_name`` is set, Proxy-Status headers will use this
 value as the name of the proxy.
        string literal_proxy_name = 6;
        Specified by:
        hasLiteralProxyName in interface HttpConnectionManager.ProxyStatusConfigOrBuilder
        Returns:
        Whether the literalProxyName field is set.

      • getLiteralProxyNameBytes

        public com.google.protobuf.ByteString getLiteralProxyNameBytes()
         If ``literal_proxy_name`` is set, Proxy-Status headers will use this
 value as the name of the proxy.
        string literal_proxy_name = 6;
        Specified by:
        getLiteralProxyNameBytes in interface HttpConnectionManager.ProxyStatusConfigOrBuilder
        Returns:
        The bytes for literalProxyName.

      • 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 HttpConnectionManager.ProxyStatusConfig parseFrom​(ByteBuffer data,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<HttpConnectionManager.ProxyStatusConfig> 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 HttpConnectionManager.ProxyStatusConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder