io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v4alpha

Class HttpConnectionManager.UpgradeConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v4alpha.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.GeneratedMessageV3
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.v4alpha.HttpConnectionManager.UpgradeConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpConnectionManager.UpgradeConfig.Builder The configuration for HTTP upgrades.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENABLED_FIELD_NUMBER
static int	FILTERS_FIELD_NUMBER
static int	UPGRADE_TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static HttpConnectionManager.UpgradeConfig	getDefaultInstance()
HttpConnectionManager.UpgradeConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.BoolValue	getEnabled() Determines if upgrades are enabled or disabled by default.
com.google.protobuf.BoolValueOrBuilder	getEnabledOrBuilder() Determines if upgrades are enabled or disabled by default.
HttpFilter	getFilters(int index) If present, this represents the filter chain which will be created for this type of upgrade.
int	getFiltersCount() If present, this represents the filter chain which will be created for this type of upgrade.
List<HttpFilter>	getFiltersList() If present, this represents the filter chain which will be created for this type of upgrade.
HttpFilterOrBuilder	getFiltersOrBuilder(int index) If present, this represents the filter chain which will be created for this type of upgrade.
List<? extends HttpFilterOrBuilder>	getFiltersOrBuilderList() If present, this represents the filter chain which will be created for this type of upgrade.
com.google.protobuf.Parser<HttpConnectionManager.UpgradeConfig>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
String	getUpgradeType() The case-insensitive name of this upgrade, e.g.
com.google.protobuf.ByteString	getUpgradeTypeBytes() The case-insensitive name of this upgrade, e.g.
boolean	hasEnabled() Determines if upgrades are enabled or disabled by default.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static HttpConnectionManager.UpgradeConfig.Builder	newBuilder()
static HttpConnectionManager.UpgradeConfig.Builder	newBuilder(HttpConnectionManager.UpgradeConfig prototype)
HttpConnectionManager.UpgradeConfig.Builder	newBuilderForType()
protected HttpConnectionManager.UpgradeConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static HttpConnectionManager.UpgradeConfig	parseDelimitedFrom(InputStream input)
static HttpConnectionManager.UpgradeConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpConnectionManager.UpgradeConfig	parseFrom(byte[] data)
static HttpConnectionManager.UpgradeConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpConnectionManager.UpgradeConfig	parseFrom(ByteBuffer data)
static HttpConnectionManager.UpgradeConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpConnectionManager.UpgradeConfig	parseFrom(com.google.protobuf.ByteString data)
static HttpConnectionManager.UpgradeConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpConnectionManager.UpgradeConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static HttpConnectionManager.UpgradeConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpConnectionManager.UpgradeConfig	parseFrom(InputStream input)
static HttpConnectionManager.UpgradeConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<HttpConnectionManager.UpgradeConfig>	parser()
HttpConnectionManager.UpgradeConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

UPGRADE_TYPE_FIELD_NUMBER

public static final int UPGRADE_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

FILTERS_FIELD_NUMBER

public static final int FILTERS_FIELD_NUMBER

See Also:

Constant Field Values

ENABLED_FIELD_NUMBER

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

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

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

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.v4alpha.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.v4alpha.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.v4alpha.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.v4alpha.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.v4alpha.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_api_field_config.route.v4alpha.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

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_config.route.v4alpha.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

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_config.route.v4alpha.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.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.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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

getDefaultInstanceForType

public HttpConnectionManager.UpgradeConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder