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

Class HttpConnectionManager.ProxyStatusConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>
com.google.protobuf.GeneratedMessage.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>
io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.ProxyStatusConfig.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpConnectionManager.ProxyStatusConfigOrBuilder, Cloneable
Enclosing class:
HttpConnectionManager.ProxyStatusConfig
public static final class HttpConnectionManager.ProxyStatusConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<HttpConnectionManager.ProxyStatusConfig.Builder> 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

  • Field Details

    • proxyNameCase_

      private int proxyNameCase_

    • proxyName_

      private Object proxyName_

    • bitField0_

      private int bitField0_

    • removeDetails_

      private boolean removeDetails_

    • removeConnectionTerminationDetails_

      private boolean removeConnectionTerminationDetails_

    • removeResponseFlags_

      private boolean removeResponseFlags_

    • setRecommendedResponseCode_

      private boolean setRecommendedResponseCode_

  • Constructor Details

    • Builder

      private Builder()

    • Builder

      private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>

    • clear

      public HttpConnectionManager.ProxyStatusConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • buildPartial0

      private void buildPartial0(HttpConnectionManager.ProxyStatusConfig result)

    • buildPartialOneofs

      private void buildPartialOneofs(HttpConnectionManager.ProxyStatusConfig result)

    • mergeFrom

      public HttpConnectionManager.ProxyStatusConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>

    • mergeFrom

      public HttpConnectionManager.ProxyStatusConfig.Builder mergeFrom(HttpConnectionManager.ProxyStatusConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>

    • mergeFrom

      public HttpConnectionManager.ProxyStatusConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>
      Throws:
      IOException

    • getProxyNameCase

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

    • clearProxyName

      public HttpConnectionManager.ProxyStatusConfig.Builder clearProxyName()

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

    • setRemoveDetails

      public HttpConnectionManager.ProxyStatusConfig.Builder setRemoveDetails(boolean value)
       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;
      Parameters:
      value - The removeDetails to set.
      Returns:
      This builder for chaining.

    • clearRemoveDetails

      public HttpConnectionManager.ProxyStatusConfig.Builder clearRemoveDetails()
       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;
      Returns:
      This builder for chaining.

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

    • setRemoveConnectionTerminationDetails

      public HttpConnectionManager.ProxyStatusConfig.Builder setRemoveConnectionTerminationDetails(boolean value)
       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;
      Parameters:
      value - The removeConnectionTerminationDetails to set.
      Returns:
      This builder for chaining.

    • clearRemoveConnectionTerminationDetails

      public HttpConnectionManager.ProxyStatusConfig.Builder clearRemoveConnectionTerminationDetails()
       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;
      Returns:
      This builder for chaining.

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

    • setRemoveResponseFlags

      public HttpConnectionManager.ProxyStatusConfig.Builder setRemoveResponseFlags(boolean value)
       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;
      Parameters:
      value - The removeResponseFlags to set.
      Returns:
      This builder for chaining.

    • clearRemoveResponseFlags

      public HttpConnectionManager.ProxyStatusConfig.Builder clearRemoveResponseFlags()
       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;
      Returns:
      This builder for chaining.

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

    • setSetRecommendedResponseCode

      public HttpConnectionManager.ProxyStatusConfig.Builder setSetRecommendedResponseCode(boolean value)
       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;
      Parameters:
      value - The setRecommendedResponseCode to set.
      Returns:
      This builder for chaining.

    • clearSetRecommendedResponseCode

      public HttpConnectionManager.ProxyStatusConfig.Builder clearSetRecommendedResponseCode()
       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;
      Returns:
      This builder for chaining.

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

    • setUseNodeId

      public HttpConnectionManager.ProxyStatusConfig.Builder setUseNodeId(boolean value)
       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;
      Parameters:
      value - The useNodeId to set.
      Returns:
      This builder for chaining.

    • clearUseNodeId

      public HttpConnectionManager.ProxyStatusConfig.Builder clearUseNodeId()
       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;
      Returns:
      This builder for chaining.

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

    • setLiteralProxyName

      public HttpConnectionManager.ProxyStatusConfig.Builder setLiteralProxyName(String value)
       If ``literal_proxy_name`` is set, Proxy-Status headers will use this
 value as the name of the proxy.
      string literal_proxy_name = 6;
      Parameters:
      value - The literalProxyName to set.
      Returns:
      This builder for chaining.

    • clearLiteralProxyName

      public HttpConnectionManager.ProxyStatusConfig.Builder clearLiteralProxyName()
       If ``literal_proxy_name`` is set, Proxy-Status headers will use this
 value as the name of the proxy.
      string literal_proxy_name = 6;
      Returns:
      This builder for chaining.

    • setLiteralProxyNameBytes

      public HttpConnectionManager.ProxyStatusConfig.Builder setLiteralProxyNameBytes(com.google.protobuf.ByteString value)
       If ``literal_proxy_name`` is set, Proxy-Status headers will use this
 value as the name of the proxy.
      string literal_proxy_name = 6;
      Parameters:
      value - The bytes for literalProxyName to set.
      Returns:
      This builder for chaining.