Class HttpConnectionManager.ProxyStatusConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3.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.GeneratedMessage 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:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • proxyNameCase_

      private int proxyNameCase_

    • proxyName_

      private Object proxyName_

    • REMOVE_DETAILS_FIELD_NUMBER

      public static final int REMOVE_DETAILS_FIELD_NUMBER
      See Also:

    • removeDetails_

      private boolean removeDetails_

    • REMOVE_CONNECTION_TERMINATION_DETAILS_FIELD_NUMBER

      public static final int REMOVE_CONNECTION_TERMINATION_DETAILS_FIELD_NUMBER
      See Also:

    • removeConnectionTerminationDetails_

      private boolean removeConnectionTerminationDetails_

    • REMOVE_RESPONSE_FLAGS_FIELD_NUMBER

      public static final int REMOVE_RESPONSE_FLAGS_FIELD_NUMBER
      See Also:

    • removeResponseFlags_

      private boolean removeResponseFlags_

    • setRecommendedResponseCode_

      private boolean setRecommendedResponseCode_

    • USE_NODE_ID_FIELD_NUMBER

      public static final int USE_NODE_ID_FIELD_NUMBER
      See Also:

    • LITERAL_PROXY_NAME_FIELD_NUMBER

      public static final int LITERAL_PROXY_NAME_FIELD_NUMBER
      See Also:

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final HttpConnectionManager.ProxyStatusConfig DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<HttpConnectionManager.ProxyStatusConfig> PARSER

  • Constructor Details

    • ProxyStatusConfig

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

    • ProxyStatusConfig

      private ProxyStatusConfig()

  • 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

    • getProxyNameCase

      public HttpConnectionManager.ProxyStatusConfig.ProxyNameCase getProxyNameCase()
      Specified by:
      getProxyNameCase in interface HttpConnectionManager.ProxyStatusConfigOrBuilder

    • 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.

    • getUseNodeId

      public boolean getUseNodeId()
      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:
      getUseNodeId in interface HttpConnectionManager.ProxyStatusConfigOrBuilder
      Returns:
      The useNodeId.

    • 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.

    • getLiteralProxyName

      public String getLiteralProxyName()
      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:
      getLiteralProxyName in interface HttpConnectionManager.ProxyStatusConfigOrBuilder
      Returns:
      The literalProxyName.

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

    • 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

    • parseFrom

      public static HttpConnectionManager.ProxyStatusConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static HttpConnectionManager.ProxyStatusConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static HttpConnectionManager.ProxyStatusConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static HttpConnectionManager.ProxyStatusConfig.Builder newBuilder()

    • newBuilder

      public static HttpConnectionManager.ProxyStatusConfig.Builder newBuilder(HttpConnectionManager.ProxyStatusConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static HttpConnectionManager.ProxyStatusConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<HttpConnectionManager.ProxyStatusConfig> parser()

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public HttpConnectionManager.ProxyStatusConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder