Package io.envoyproxy.envoy.config.filter.network.http_connection_manager.v2

Class HttpConnectionManager.UpgradeConfig.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpConnectionManager.UpgradeConfigOrBuilder, Cloneable
    Enclosing class:
    HttpConnectionManager.UpgradeConfig
    public static final class HttpConnectionManager.UpgradeConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<HttpConnectionManager.UpgradeConfig.Builder>
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.config.filter.network.http_connection_manager.v2.HttpConnectionManager.UpgradeConfig

    • Method Detail

      • 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.Builder<HttpConnectionManager.UpgradeConfig.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.GeneratedMessageV3.Builder<HttpConnectionManager.UpgradeConfig.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

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

      • setUpgradeType

        public HttpConnectionManager.UpgradeConfig.Builder setUpgradeType​(String value)
         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;
        Parameters:
        value - The upgradeType to set.
        Returns:
        This builder for chaining.

      • clearUpgradeType

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

      • setUpgradeTypeBytes

        public HttpConnectionManager.UpgradeConfig.Builder setUpgradeTypeBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for upgradeType to set.
        Returns:
        This builder for chaining.

      • 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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;
        Specified by:
        getFiltersList 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.config.filter.network.http_connection_manager.v2.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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;
        Specified by:
        getFilters in interface HttpConnectionManager.UpgradeConfigOrBuilder

      • setFilters

        public HttpConnectionManager.UpgradeConfig.Builder setFilters​(int index,
                                                              HttpFilter value)
         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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

      • setFilters

        public HttpConnectionManager.UpgradeConfig.Builder setFilters​(int index,
                                                              HttpFilter.Builder builderForValue)
         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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

      • addFilters

        public HttpConnectionManager.UpgradeConfig.Builder addFilters​(HttpFilter value)
         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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

      • addFilters

        public HttpConnectionManager.UpgradeConfig.Builder addFilters​(int index,
                                                              HttpFilter value)
         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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

      • addFilters

        public HttpConnectionManager.UpgradeConfig.Builder addFilters​(HttpFilter.Builder builderForValue)
         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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

      • addFilters

        public HttpConnectionManager.UpgradeConfig.Builder addFilters​(int index,
                                                              HttpFilter.Builder builderForValue)
         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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

      • addAllFilters

        public HttpConnectionManager.UpgradeConfig.Builder addAllFilters​(Iterable<? extends HttpFilter> values)
         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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

      • clearFilters

        public HttpConnectionManager.UpgradeConfig.Builder clearFilters()
         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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

      • removeFilters

        public HttpConnectionManager.UpgradeConfig.Builder removeFilters​(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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

      • getFiltersBuilder

        public HttpFilter.Builder getFiltersBuilder​(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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

      • 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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;
        Specified by:
        getFiltersOrBuilder 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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;
        Specified by:
        getFiltersOrBuilderList in interface HttpConnectionManager.UpgradeConfigOrBuilder

      • addFiltersBuilder

        public HttpFilter.Builder addFiltersBuilder()
         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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

      • addFiltersBuilder

        public HttpFilter.Builder addFiltersBuilder​(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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

      • getFiltersBuilderList

        public List<HttpFilter.Builder> getFiltersBuilderList()
         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.config.filter.network.http_connection_manager.v2.HttpFilter filters = 2;

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

      • setEnabled

        public HttpConnectionManager.UpgradeConfig.Builder setEnabled​(com.google.protobuf.BoolValue value)
         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_api_field_route.RouteAction.upgrade_configs>` as documented in the
 :ref:`upgrade documentation <arch_overview_upgrades>`.
        .google.protobuf.BoolValue enabled = 3;

      • setEnabled

        public HttpConnectionManager.UpgradeConfig.Builder setEnabled​(com.google.protobuf.BoolValue.Builder builderForValue)
         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_api_field_route.RouteAction.upgrade_configs>` as documented in the
 :ref:`upgrade documentation <arch_overview_upgrades>`.
        .google.protobuf.BoolValue enabled = 3;

      • mergeEnabled

        public HttpConnectionManager.UpgradeConfig.Builder mergeEnabled​(com.google.protobuf.BoolValue value)
         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_api_field_route.RouteAction.upgrade_configs>` as documented in the
 :ref:`upgrade documentation <arch_overview_upgrades>`.
        .google.protobuf.BoolValue enabled = 3;

      • clearEnabled

        public HttpConnectionManager.UpgradeConfig.Builder clearEnabled()
         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_api_field_route.RouteAction.upgrade_configs>` as documented in the
 :ref:`upgrade documentation <arch_overview_upgrades>`.
        .google.protobuf.BoolValue enabled = 3;

      • getEnabledBuilder

        public com.google.protobuf.BoolValue.Builder getEnabledBuilder()
         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_api_field_route.RouteAction.upgrade_configs>` as documented in the
 :ref:`upgrade documentation <arch_overview_upgrades>`.
        .google.protobuf.BoolValue enabled = 3;

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