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<BuilderType>

com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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

Method Summary

Modifier and Type	Method	Description
HttpConnectionManager.ProxyStatusConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
HttpConnectionManager.ProxyStatusConfig	build()
HttpConnectionManager.ProxyStatusConfig	buildPartial()
HttpConnectionManager.ProxyStatusConfig.Builder	clear()
HttpConnectionManager.ProxyStatusConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
HttpConnectionManager.ProxyStatusConfig.Builder	clearLiteralProxyName()	If `literal_proxy_name` is set, Proxy-Status headers will use this value as the name of the proxy.
HttpConnectionManager.ProxyStatusConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
HttpConnectionManager.ProxyStatusConfig.Builder	clearProxyName()
HttpConnectionManager.ProxyStatusConfig.Builder	clearRemoveConnectionTerminationDetails()	If true, the details field of the Proxy-Status header will not contain connection termination details.
HttpConnectionManager.ProxyStatusConfig.Builder	clearRemoveDetails()	If true, the details field of the Proxy-Status header is not populated with stream_info.response_code_details.
HttpConnectionManager.ProxyStatusConfig.Builder	clearRemoveResponseFlags()	If true, the details field of the Proxy-Status header will not contain an enumeration of the Envoy ResponseFlags.
HttpConnectionManager.ProxyStatusConfig.Builder	clearSetRecommendedResponseCode()	If true, overwrites the existing Status header with the response code recommended by the Proxy-Status spec.
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.
HttpConnectionManager.ProxyStatusConfig.Builder	clone()
HttpConnectionManager.ProxyStatusConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
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.
boolean	getSetRecommendedResponseCode()	If true, overwrites the existing Status header with the response code recommended by the Proxy-Status spec.
boolean	getUseNodeId()	If `use_node_id` is set, Proxy-Status headers will use the Envoy's node ID as the name of the proxy.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
HttpConnectionManager.ProxyStatusConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
HttpConnectionManager.ProxyStatusConfig.Builder	mergeFrom(com.google.protobuf.Message other)
HttpConnectionManager.ProxyStatusConfig.Builder	mergeFrom(HttpConnectionManager.ProxyStatusConfig other)
HttpConnectionManager.ProxyStatusConfig.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
HttpConnectionManager.ProxyStatusConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
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.
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.
HttpConnectionManager.ProxyStatusConfig.Builder	setRemoveConnectionTerminationDetails(boolean value)	If true, the details field of the Proxy-Status header will not contain connection termination details.
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.
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.
HttpConnectionManager.ProxyStatusConfig.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
HttpConnectionManager.ProxyStatusConfig.Builder	setSetRecommendedResponseCode(boolean value)	If true, overwrites the existing Status header with the response code recommended by the Proxy-Status spec.
HttpConnectionManager.ProxyStatusConfig.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
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.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

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

clone

public HttpConnectionManager.ProxyStatusConfig.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>

setField

public HttpConnectionManager.ProxyStatusConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>

clearField

public HttpConnectionManager.ProxyStatusConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>

clearOneof

public HttpConnectionManager.ProxyStatusConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>

setRepeatedField

public HttpConnectionManager.ProxyStatusConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                        int index,
                                                                        Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>

addRepeatedField

public HttpConnectionManager.ProxyStatusConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                        Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>

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

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;

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;

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

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;

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;

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

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;

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;

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

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;

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;

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

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;

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;

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

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;

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;

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;

setUnknownFields

public final HttpConnectionManager.ProxyStatusConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>

mergeUnknownFields

public final HttpConnectionManager.ProxyStatusConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HttpConnectionManager.ProxyStatusConfig.Builder>