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

Class HttpConnectionManager.ProxyStatusConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpConnectionManager.ProxyStatusConfig.Builder	Configures the manner in which the Proxy-Status HTTP response header is populated.
static class	HttpConnectionManager.ProxyStatusConfig.ProxyNameCase

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	Description
static int	LITERAL_PROXY_NAME_FIELD_NUMBER
static int	REMOVE_CONNECTION_TERMINATION_DETAILS_FIELD_NUMBER
static int	REMOVE_DETAILS_FIELD_NUMBER
static int	REMOVE_RESPONSE_FLAGS_FIELD_NUMBER
static int	SET_RECOMMENDED_RESPONSE_CODE_FIELD_NUMBER
static int	USE_NODE_ID_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	Description
boolean	equals(Object obj)
static HttpConnectionManager.ProxyStatusConfig	getDefaultInstance()
HttpConnectionManager.ProxyStatusConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getLiteralProxyName()	If `literal_proxy_name` is set, Proxy-Status headers will use this value as the name of the proxy.
com.google.protobuf.ByteString	getLiteralProxyNameBytes()	If `literal_proxy_name` is set, Proxy-Status headers will use this value as the name of the proxy.
com.google.protobuf.Parser<HttpConnectionManager.ProxyStatusConfig>	getParserForType()
HttpConnectionManager.ProxyStatusConfig.ProxyNameCase	getProxyNameCase()
boolean	getRemoveConnectionTerminationDetails()	If true, the details field of the Proxy-Status header will not contain connection termination details.
boolean	getRemoveDetails()	If true, the details field of the Proxy-Status header is not populated with stream_info.response_code_details.
boolean	getRemoveResponseFlags()	If true, the details field of the Proxy-Status header will not contain an enumeration of the Envoy ResponseFlags.
int	getSerializedSize()
boolean	getSetRecommendedResponseCode()	If true, overwrites the existing Status header with the response code recommended by the Proxy-Status spec.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	getUseNodeId()	If `use_node_id` is set, Proxy-Status headers will use the Envoy's node ID as the name of the proxy.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static HttpConnectionManager.ProxyStatusConfig.Builder	newBuilder()
static HttpConnectionManager.ProxyStatusConfig.Builder	newBuilder(HttpConnectionManager.ProxyStatusConfig prototype)
HttpConnectionManager.ProxyStatusConfig.Builder	newBuilderForType()
protected HttpConnectionManager.ProxyStatusConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static HttpConnectionManager.ProxyStatusConfig	parseDelimitedFrom(InputStream input)
static HttpConnectionManager.ProxyStatusConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpConnectionManager.ProxyStatusConfig	parseFrom(byte[] data)
static HttpConnectionManager.ProxyStatusConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpConnectionManager.ProxyStatusConfig	parseFrom(com.google.protobuf.ByteString data)
static HttpConnectionManager.ProxyStatusConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpConnectionManager.ProxyStatusConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static HttpConnectionManager.ProxyStatusConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpConnectionManager.ProxyStatusConfig	parseFrom(InputStream input)
static HttpConnectionManager.ProxyStatusConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpConnectionManager.ProxyStatusConfig	parseFrom(ByteBuffer data)
static HttpConnectionManager.ProxyStatusConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<HttpConnectionManager.ProxyStatusConfig>	parser()
HttpConnectionManager.ProxyStatusConfig.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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

REMOVE_DETAILS_FIELD_NUMBER

public static final int REMOVE_DETAILS_FIELD_NUMBER

See Also:

Constant Field Values

REMOVE_CONNECTION_TERMINATION_DETAILS_FIELD_NUMBER

public static final int REMOVE_CONNECTION_TERMINATION_DETAILS_FIELD_NUMBER

See Also:

Constant Field Values

REMOVE_RESPONSE_FLAGS_FIELD_NUMBER

public static final int REMOVE_RESPONSE_FLAGS_FIELD_NUMBER

See Also:

Constant Field Values

SET_RECOMMENDED_RESPONSE_CODE_FIELD_NUMBER

public static final int SET_RECOMMENDED_RESPONSE_CODE_FIELD_NUMBER

See Also:

Constant Field Values

USE_NODE_ID_FIELD_NUMBER

public static final int USE_NODE_ID_FIELD_NUMBER

See Also:

Constant Field Values

LITERAL_PROXY_NAME_FIELD_NUMBER

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

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

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

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

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

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

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

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

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

getDefaultInstanceForType

public HttpConnectionManager.ProxyStatusConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder