Class HttpConnectionManager.UpgradeConfig

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.UpgradeConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpConnectionManager.UpgradeConfigOrBuilder, Serializable
Enclosing class:
HttpConnectionManager
public static final class HttpConnectionManager.UpgradeConfig extends com.google.protobuf.GeneratedMessage implements HttpConnectionManager.UpgradeConfigOrBuilder
The configuration for HTTP upgrades.
For each upgrade type desired, an UpgradeConfig must be added.

.. warning::

The current implementation of upgrade headers does not handle
multi-valued upgrade headers. Support for multi-valued headers may be
added in the future if needed.

.. warning::
The current implementation of upgrade headers does not work with HTTP/2
upstreams.
Protobuf type envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.UpgradeConfig
See Also:

  • Field Details

  • Constructor Details

    • UpgradeConfig

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

    • UpgradeConfig

      private UpgradeConfig()

  • 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

    • getUpgradeType

      public String getUpgradeType()
      The case-insensitive name of this upgrade, e.g. "websocket".
For each upgrade type present in upgrade_configs, requests with
Upgrade: [upgrade_type]
will be proxied upstream.
      string upgrade_type = 1;
      Specified by:
      getUpgradeType in interface HttpConnectionManager.UpgradeConfigOrBuilder
      Returns:
      The upgradeType.

    • getUpgradeTypeBytes

      public com.google.protobuf.ByteString getUpgradeTypeBytes()
      The case-insensitive name of this upgrade, e.g. "websocket".
For each upgrade type present in upgrade_configs, requests with
Upgrade: [upgrade_type]
will be proxied upstream.
      string upgrade_type = 1;
      Specified by:
      getUpgradeTypeBytes in interface HttpConnectionManager.UpgradeConfigOrBuilder
      Returns:
      The bytes for upgradeType.

    • getFiltersList

      public List<HttpFilter> getFiltersList()
      If present, this represents the filter chain which will be created for
this type of upgrade. If no filters are present, the filter chain for
HTTP connections will be used for this upgrade type.
      repeated .envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter filters = 2;
      Specified by:
      getFiltersList in interface HttpConnectionManager.UpgradeConfigOrBuilder

    • getFiltersOrBuilderList

      public List<? extends HttpFilterOrBuilder> getFiltersOrBuilderList()
      If present, this represents the filter chain which will be created for
this type of upgrade. If no filters are present, the filter chain for
HTTP connections will be used for this upgrade type.
      repeated .envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter filters = 2;
      Specified by:
      getFiltersOrBuilderList in interface HttpConnectionManager.UpgradeConfigOrBuilder

    • getFiltersCount

      public int getFiltersCount()
      If present, this represents the filter chain which will be created for
this type of upgrade. If no filters are present, the filter chain for
HTTP connections will be used for this upgrade type.
      repeated .envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter filters = 2;
      Specified by:
      getFiltersCount in interface HttpConnectionManager.UpgradeConfigOrBuilder

    • getFilters

      public HttpFilter getFilters(int index)
      If present, this represents the filter chain which will be created for
this type of upgrade. If no filters are present, the filter chain for
HTTP connections will be used for this upgrade type.
      repeated .envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter filters = 2;
      Specified by:
      getFilters in interface HttpConnectionManager.UpgradeConfigOrBuilder

    • getFiltersOrBuilder

      public HttpFilterOrBuilder getFiltersOrBuilder(int index)
      If present, this represents the filter chain which will be created for
this type of upgrade. If no filters are present, the filter chain for
HTTP connections will be used for this upgrade type.
      repeated .envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter filters = 2;
      Specified by:
      getFiltersOrBuilder in interface HttpConnectionManager.UpgradeConfigOrBuilder

    • hasEnabled

      public boolean hasEnabled()
      Determines if upgrades are enabled or disabled by default. Defaults to true.
This can be overridden on a per-route basis with :ref:`cluster
<envoy_v3_api_field_config.route.v3.RouteAction.upgrade_configs>` as documented in the
:ref:`upgrade documentation <arch_overview_upgrades>`.
      .google.protobuf.BoolValue enabled = 3;
      Specified by:
      hasEnabled in interface HttpConnectionManager.UpgradeConfigOrBuilder
      Returns:
      Whether the enabled field is set.

    • getEnabled

      public com.google.protobuf.BoolValue getEnabled()
      Determines if upgrades are enabled or disabled by default. Defaults to true.
This can be overridden on a per-route basis with :ref:`cluster
<envoy_v3_api_field_config.route.v3.RouteAction.upgrade_configs>` as documented in the
:ref:`upgrade documentation <arch_overview_upgrades>`.
      .google.protobuf.BoolValue enabled = 3;
      Specified by:
      getEnabled in interface HttpConnectionManager.UpgradeConfigOrBuilder
      Returns:
      The enabled.

    • getEnabledOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getEnabledOrBuilder()
      Determines if upgrades are enabled or disabled by default. Defaults to true.
This can be overridden on a per-route basis with :ref:`cluster
<envoy_v3_api_field_config.route.v3.RouteAction.upgrade_configs>` as documented in the
:ref:`upgrade documentation <arch_overview_upgrades>`.
      .google.protobuf.BoolValue enabled = 3;
      Specified by:
      getEnabledOrBuilder in interface HttpConnectionManager.UpgradeConfigOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static HttpConnectionManager.UpgradeConfig 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.UpgradeConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static HttpConnectionManager.UpgradeConfig.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static HttpConnectionManager.UpgradeConfig getDefaultInstance()

    • parser

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

    • getParserForType

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