public static interface HttpConnectionManagerOuterClass.HttpConnectionManagerOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
Accesslog.AccessLog |
getAccessLog(int index)
Configuration for :ref:`HTTP access logs <arch_overview_access_logs>`
emitted by the connection manager.
|
int |
getAccessLogCount()
Configuration for :ref:`HTTP access logs <arch_overview_access_logs>`
emitted by the connection manager.
|
List<Accesslog.AccessLog> |
getAccessLogList()
Configuration for :ref:`HTTP access logs <arch_overview_access_logs>`
emitted by the connection manager.
|
Accesslog.AccessLogOrBuilder |
getAccessLogOrBuilder(int index)
Configuration for :ref:`HTTP access logs <arch_overview_access_logs>`
emitted by the connection manager.
|
List<? extends Accesslog.AccessLogOrBuilder> |
getAccessLogOrBuilderList()
Configuration for :ref:`HTTP access logs <arch_overview_access_logs>`
emitted by the connection manager.
|
com.google.protobuf.BoolValue |
getAddUserAgent()
Whether the connection manager manipulates the :ref:`config_http_conn_man_headers_user-agent`
and :ref:`config_http_conn_man_headers_downstream-service-cluster` headers.
|
com.google.protobuf.BoolValueOrBuilder |
getAddUserAgentOrBuilder()
Whether the connection manager manipulates the :ref:`config_http_conn_man_headers_user-agent`
and :ref:`config_http_conn_man_headers_downstream-service-cluster` headers.
|
HttpConnectionManagerOuterClass.HttpConnectionManager.CodecType |
getCodecType()
Supplies the type of codec that the connection manager should use.
|
int |
getCodecTypeValue()
Supplies the type of codec that the connection manager should use.
|
com.google.protobuf.Duration |
getDelayedCloseTimeout()
The delayed close timeout is for downstream connections managed by the HTTP connection manager.
|
com.google.protobuf.DurationOrBuilder |
getDelayedCloseTimeoutOrBuilder()
The delayed close timeout is for downstream connections managed by the HTTP connection manager.
|
com.google.protobuf.Duration |
getDrainTimeout()
The time that Envoy will wait between sending an HTTP/2 “shutdown
notification” (GOAWAY frame with max stream ID) and a final GOAWAY frame.
|
com.google.protobuf.DurationOrBuilder |
getDrainTimeoutOrBuilder()
The time that Envoy will wait between sending an HTTP/2 “shutdown
notification” (GOAWAY frame with max stream ID) and a final GOAWAY frame.
|
HttpConnectionManagerOuterClass.HttpConnectionManager.ForwardClientCertDetails |
getForwardClientCertDetails()
How to handle the :ref:`config_http_conn_man_headers_x-forwarded-client-cert` (XFCC) HTTP
header.
|
int |
getForwardClientCertDetailsValue()
How to handle the :ref:`config_http_conn_man_headers_x-forwarded-client-cert` (XFCC) HTTP
header.
|
com.google.protobuf.BoolValue |
getGenerateRequestId()
Whether the connection manager will generate the :ref:`x-request-id
<config_http_conn_man_headers_x-request-id>` header if it does not exist.
|
com.google.protobuf.BoolValueOrBuilder |
getGenerateRequestIdOrBuilder()
Whether the connection manager will generate the :ref:`x-request-id
<config_http_conn_man_headers_x-request-id>` header if it does not exist.
|
Protocol.Http2ProtocolOptions |
getHttp2ProtocolOptions()
Additional HTTP/2 settings that are passed directly to the HTTP/2 codec.
|
Protocol.Http2ProtocolOptionsOrBuilder |
getHttp2ProtocolOptionsOrBuilder()
Additional HTTP/2 settings that are passed directly to the HTTP/2 codec.
|
HttpConnectionManagerOuterClass.HttpFilter |
getHttpFilters(int index)
A list of individual HTTP filters that make up the filter chain for
requests made to the connection manager.
|
int |
getHttpFiltersCount()
A list of individual HTTP filters that make up the filter chain for
requests made to the connection manager.
|
List<HttpConnectionManagerOuterClass.HttpFilter> |
getHttpFiltersList()
A list of individual HTTP filters that make up the filter chain for
requests made to the connection manager.
|
HttpConnectionManagerOuterClass.HttpFilterOrBuilder |
getHttpFiltersOrBuilder(int index)
A list of individual HTTP filters that make up the filter chain for
requests made to the connection manager.
|
List<? extends HttpConnectionManagerOuterClass.HttpFilterOrBuilder> |
getHttpFiltersOrBuilderList()
A list of individual HTTP filters that make up the filter chain for
requests made to the connection manager.
|
Protocol.Http1ProtocolOptions |
getHttpProtocolOptions()
Additional HTTP/1 settings that are passed to the HTTP/1 codec.
|
Protocol.Http1ProtocolOptionsOrBuilder |
getHttpProtocolOptionsOrBuilder()
Additional HTTP/1 settings that are passed to the HTTP/1 codec.
|
com.google.protobuf.Duration |
getIdleTimeout()
The idle timeout for connections managed by the connection manager.
|
com.google.protobuf.DurationOrBuilder |
getIdleTimeoutOrBuilder()
The idle timeout for connections managed by the connection manager.
|
HttpConnectionManagerOuterClass.HttpConnectionManager.InternalAddressConfig |
getInternalAddressConfig()
Configures what network addresses are considered internal for stats and header sanitation
purposes.
|
HttpConnectionManagerOuterClass.HttpConnectionManager.InternalAddressConfigOrBuilder |
getInternalAddressConfigOrBuilder()
Configures what network addresses are considered internal for stats and header sanitation
purposes.
|
boolean |
getProxy100Continue()
If proxy_100_continue is true, Envoy will proxy incoming "Expect:
100-continue" headers upstream, and forward "100 Continue" responses
downstream.
|
HttpConnectionManagerOuterClass.Rds |
getRds()
The connection manager’s route table will be dynamically loaded via the RDS API.
|
HttpConnectionManagerOuterClass.RdsOrBuilder |
getRdsOrBuilder()
The connection manager’s route table will be dynamically loaded via the RDS API.
|
boolean |
getRepresentIpv4RemoteAddressAsIpv4MappedIpv6()
If
:ref:`use_remote_address
<envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.use_remote_address>`
is true and represent_ipv4_remote_address_as_ipv4_mapped_ipv6 is true and the remote address is
an IPv4 address, the address will be mapped to IPv6 before it is appended to *x-forwarded-for*.
|
Rds.RouteConfiguration |
getRouteConfig()
The route table for the connection manager is static and is specified in this property.
|
Rds.RouteConfigurationOrBuilder |
getRouteConfigOrBuilder()
The route table for the connection manager is static and is specified in this property.
|
HttpConnectionManagerOuterClass.HttpConnectionManager.RouteSpecifierCase |
getRouteSpecifierCase() |
String |
getServerName()
An optional override that the connection manager will write to the server
header in responses.
|
com.google.protobuf.ByteString |
getServerNameBytes()
An optional override that the connection manager will write to the server
header in responses.
|
HttpConnectionManagerOuterClass.HttpConnectionManager.SetCurrentClientCertDetails |
getSetCurrentClientCertDetails()
This field is valid only when :ref:`forward_client_cert_details
<envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.forward_client_cert_details>`
is APPEND_FORWARD or SANITIZE_SET and the client connection is mTLS.
|
HttpConnectionManagerOuterClass.HttpConnectionManager.SetCurrentClientCertDetailsOrBuilder |
getSetCurrentClientCertDetailsOrBuilder()
This field is valid only when :ref:`forward_client_cert_details
<envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.forward_client_cert_details>`
is APPEND_FORWARD or SANITIZE_SET and the client connection is mTLS.
|
boolean |
getSkipXffAppend()
If set, Envoy will not append the remote address to the
:ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header.
|
String |
getStatPrefix()
The human readable prefix to use when emitting statistics for the
connection manager.
|
com.google.protobuf.ByteString |
getStatPrefixBytes()
The human readable prefix to use when emitting statistics for the
connection manager.
|
com.google.protobuf.Duration |
getStreamIdleTimeout()
The stream idle timeout for connections managed by the connection manager.
|
com.google.protobuf.DurationOrBuilder |
getStreamIdleTimeoutOrBuilder()
The stream idle timeout for connections managed by the connection manager.
|
HttpConnectionManagerOuterClass.HttpConnectionManager.Tracing |
getTracing()
Presence of the object defines whether the connection manager
emits :ref:`tracing <arch_overview_tracing>` data to the :ref:`configured tracing provider
<envoy_api_msg_config.trace.v2.Tracing>`.
|
HttpConnectionManagerOuterClass.HttpConnectionManager.TracingOrBuilder |
getTracingOrBuilder()
Presence of the object defines whether the connection manager
emits :ref:`tracing <arch_overview_tracing>` data to the :ref:`configured tracing provider
<envoy_api_msg_config.trace.v2.Tracing>`.
|
HttpConnectionManagerOuterClass.HttpConnectionManager.UpgradeConfig |
getUpgradeConfigs(int index)
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.UpgradeConfig upgrade_configs = 23; |
int |
getUpgradeConfigsCount()
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.UpgradeConfig upgrade_configs = 23; |
List<HttpConnectionManagerOuterClass.HttpConnectionManager.UpgradeConfig> |
getUpgradeConfigsList()
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.UpgradeConfig upgrade_configs = 23; |
HttpConnectionManagerOuterClass.HttpConnectionManager.UpgradeConfigOrBuilder |
getUpgradeConfigsOrBuilder(int index)
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.UpgradeConfig upgrade_configs = 23; |
List<? extends HttpConnectionManagerOuterClass.HttpConnectionManager.UpgradeConfigOrBuilder> |
getUpgradeConfigsOrBuilderList()
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.UpgradeConfig upgrade_configs = 23; |
com.google.protobuf.BoolValue |
getUseRemoteAddress()
If set to true, the connection manager will use the real remote address
of the client connection when determining internal versus external origin and manipulating
various headers.
|
com.google.protobuf.BoolValueOrBuilder |
getUseRemoteAddressOrBuilder()
If set to true, the connection manager will use the real remote address
of the client connection when determining internal versus external origin and manipulating
various headers.
|
String |
getVia()
Via header value to append to request and response headers.
|
com.google.protobuf.ByteString |
getViaBytes()
Via header value to append to request and response headers.
|
int |
getXffNumTrustedHops()
The number of additional ingress proxy hops from the right side of the
:ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header to trust when
determining the origin client's IP address.
|
boolean |
hasAddUserAgent()
Whether the connection manager manipulates the :ref:`config_http_conn_man_headers_user-agent`
and :ref:`config_http_conn_man_headers_downstream-service-cluster` headers.
|
boolean |
hasDelayedCloseTimeout()
The delayed close timeout is for downstream connections managed by the HTTP connection manager.
|
boolean |
hasDrainTimeout()
The time that Envoy will wait between sending an HTTP/2 “shutdown
notification” (GOAWAY frame with max stream ID) and a final GOAWAY frame.
|
boolean |
hasGenerateRequestId()
Whether the connection manager will generate the :ref:`x-request-id
<config_http_conn_man_headers_x-request-id>` header if it does not exist.
|
boolean |
hasHttp2ProtocolOptions()
Additional HTTP/2 settings that are passed directly to the HTTP/2 codec.
|
boolean |
hasHttpProtocolOptions()
Additional HTTP/1 settings that are passed to the HTTP/1 codec.
|
boolean |
hasIdleTimeout()
The idle timeout for connections managed by the connection manager.
|
boolean |
hasInternalAddressConfig()
Configures what network addresses are considered internal for stats and header sanitation
purposes.
|
boolean |
hasRds()
The connection manager’s route table will be dynamically loaded via the RDS API.
|
boolean |
hasRouteConfig()
The route table for the connection manager is static and is specified in this property.
|
boolean |
hasSetCurrentClientCertDetails()
This field is valid only when :ref:`forward_client_cert_details
<envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.forward_client_cert_details>`
is APPEND_FORWARD or SANITIZE_SET and the client connection is mTLS.
|
boolean |
hasStreamIdleTimeout()
The stream idle timeout for connections managed by the connection manager.
|
boolean |
hasTracing()
Presence of the object defines whether the connection manager
emits :ref:`tracing <arch_overview_tracing>` data to the :ref:`configured tracing provider
<envoy_api_msg_config.trace.v2.Tracing>`.
|
boolean |
hasUseRemoteAddress()
If set to true, the connection manager will use the real remote address
of the client connection when determining internal versus external origin and manipulating
various headers.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofint getCodecTypeValue()
Supplies the type of codec that the connection manager should use.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.CodecType codec_type = 1 [(.validate.rules) = { ... }HttpConnectionManagerOuterClass.HttpConnectionManager.CodecType getCodecType()
Supplies the type of codec that the connection manager should use.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.CodecType codec_type = 1 [(.validate.rules) = { ... }String getStatPrefix()
The human readable prefix to use when emitting statistics for the connection manager. See the :ref:`statistics documentation <config_http_conn_man_stats>` for more information.
string stat_prefix = 2 [(.validate.rules) = { ... }com.google.protobuf.ByteString getStatPrefixBytes()
The human readable prefix to use when emitting statistics for the connection manager. See the :ref:`statistics documentation <config_http_conn_man_stats>` for more information.
string stat_prefix = 2 [(.validate.rules) = { ... }boolean hasRds()
The connection manager’s route table will be dynamically loaded via the RDS API.
.envoy.config.filter.network.http_connection_manager.v2.Rds rds = 3;HttpConnectionManagerOuterClass.Rds getRds()
The connection manager’s route table will be dynamically loaded via the RDS API.
.envoy.config.filter.network.http_connection_manager.v2.Rds rds = 3;HttpConnectionManagerOuterClass.RdsOrBuilder getRdsOrBuilder()
The connection manager’s route table will be dynamically loaded via the RDS API.
.envoy.config.filter.network.http_connection_manager.v2.Rds rds = 3;boolean hasRouteConfig()
The route table for the connection manager is static and is specified in this property.
.envoy.api.v2.RouteConfiguration route_config = 4;Rds.RouteConfiguration getRouteConfig()
The route table for the connection manager is static and is specified in this property.
.envoy.api.v2.RouteConfiguration route_config = 4;Rds.RouteConfigurationOrBuilder getRouteConfigOrBuilder()
The route table for the connection manager is static and is specified in this property.
.envoy.api.v2.RouteConfiguration route_config = 4;List<HttpConnectionManagerOuterClass.HttpFilter> getHttpFiltersList()
A list of individual HTTP filters that make up the filter chain for requests made to the connection manager. Order matters as the filters are processed sequentially as request events happen.
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpFilter http_filters = 5;HttpConnectionManagerOuterClass.HttpFilter getHttpFilters(int index)
A list of individual HTTP filters that make up the filter chain for requests made to the connection manager. Order matters as the filters are processed sequentially as request events happen.
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpFilter http_filters = 5;int getHttpFiltersCount()
A list of individual HTTP filters that make up the filter chain for requests made to the connection manager. Order matters as the filters are processed sequentially as request events happen.
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpFilter http_filters = 5;List<? extends HttpConnectionManagerOuterClass.HttpFilterOrBuilder> getHttpFiltersOrBuilderList()
A list of individual HTTP filters that make up the filter chain for requests made to the connection manager. Order matters as the filters are processed sequentially as request events happen.
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpFilter http_filters = 5;HttpConnectionManagerOuterClass.HttpFilterOrBuilder getHttpFiltersOrBuilder(int index)
A list of individual HTTP filters that make up the filter chain for requests made to the connection manager. Order matters as the filters are processed sequentially as request events happen.
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpFilter http_filters = 5;boolean hasAddUserAgent()
Whether the connection manager manipulates the :ref:`config_http_conn_man_headers_user-agent` and :ref:`config_http_conn_man_headers_downstream-service-cluster` headers. See the linked documentation for more information. Defaults to false.
.google.protobuf.BoolValue add_user_agent = 6;com.google.protobuf.BoolValue getAddUserAgent()
Whether the connection manager manipulates the :ref:`config_http_conn_man_headers_user-agent` and :ref:`config_http_conn_man_headers_downstream-service-cluster` headers. See the linked documentation for more information. Defaults to false.
.google.protobuf.BoolValue add_user_agent = 6;com.google.protobuf.BoolValueOrBuilder getAddUserAgentOrBuilder()
Whether the connection manager manipulates the :ref:`config_http_conn_man_headers_user-agent` and :ref:`config_http_conn_man_headers_downstream-service-cluster` headers. See the linked documentation for more information. Defaults to false.
.google.protobuf.BoolValue add_user_agent = 6;boolean hasTracing()
Presence of the object defines whether the connection manager emits :ref:`tracing <arch_overview_tracing>` data to the :ref:`configured tracing provider <envoy_api_msg_config.trace.v2.Tracing>`.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing tracing = 7;HttpConnectionManagerOuterClass.HttpConnectionManager.Tracing getTracing()
Presence of the object defines whether the connection manager emits :ref:`tracing <arch_overview_tracing>` data to the :ref:`configured tracing provider <envoy_api_msg_config.trace.v2.Tracing>`.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing tracing = 7;HttpConnectionManagerOuterClass.HttpConnectionManager.TracingOrBuilder getTracingOrBuilder()
Presence of the object defines whether the connection manager emits :ref:`tracing <arch_overview_tracing>` data to the :ref:`configured tracing provider <envoy_api_msg_config.trace.v2.Tracing>`.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing tracing = 7;boolean hasHttpProtocolOptions()
Additional HTTP/1 settings that are passed to the HTTP/1 codec.
.envoy.api.v2.core.Http1ProtocolOptions http_protocol_options = 8;Protocol.Http1ProtocolOptions getHttpProtocolOptions()
Additional HTTP/1 settings that are passed to the HTTP/1 codec.
.envoy.api.v2.core.Http1ProtocolOptions http_protocol_options = 8;Protocol.Http1ProtocolOptionsOrBuilder getHttpProtocolOptionsOrBuilder()
Additional HTTP/1 settings that are passed to the HTTP/1 codec.
.envoy.api.v2.core.Http1ProtocolOptions http_protocol_options = 8;boolean hasHttp2ProtocolOptions()
Additional HTTP/2 settings that are passed directly to the HTTP/2 codec.
.envoy.api.v2.core.Http2ProtocolOptions http2_protocol_options = 9;Protocol.Http2ProtocolOptions getHttp2ProtocolOptions()
Additional HTTP/2 settings that are passed directly to the HTTP/2 codec.
.envoy.api.v2.core.Http2ProtocolOptions http2_protocol_options = 9;Protocol.Http2ProtocolOptionsOrBuilder getHttp2ProtocolOptionsOrBuilder()
Additional HTTP/2 settings that are passed directly to the HTTP/2 codec.
.envoy.api.v2.core.Http2ProtocolOptions http2_protocol_options = 9;String getServerName()
An optional override that the connection manager will write to the server header in responses. If not set, the default is *envoy*.
string server_name = 10;com.google.protobuf.ByteString getServerNameBytes()
An optional override that the connection manager will write to the server header in responses. If not set, the default is *envoy*.
string server_name = 10;boolean hasIdleTimeout()
The idle timeout for connections managed by the connection manager. The idle timeout is defined as the period in which there are no active requests. If not set, there is no idle timeout. When the idle timeout is reached the connection will be closed. If the connection is an HTTP/2 connection a drain sequence will occur prior to closing the connection. See :ref:`drain_timeout <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.drain_timeout>`.
.google.protobuf.Duration idle_timeout = 11 [(.gogoproto.stdduration) = true];com.google.protobuf.Duration getIdleTimeout()
The idle timeout for connections managed by the connection manager. The idle timeout is defined as the period in which there are no active requests. If not set, there is no idle timeout. When the idle timeout is reached the connection will be closed. If the connection is an HTTP/2 connection a drain sequence will occur prior to closing the connection. See :ref:`drain_timeout <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.drain_timeout>`.
.google.protobuf.Duration idle_timeout = 11 [(.gogoproto.stdduration) = true];com.google.protobuf.DurationOrBuilder getIdleTimeoutOrBuilder()
The idle timeout for connections managed by the connection manager. The idle timeout is defined as the period in which there are no active requests. If not set, there is no idle timeout. When the idle timeout is reached the connection will be closed. If the connection is an HTTP/2 connection a drain sequence will occur prior to closing the connection. See :ref:`drain_timeout <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.drain_timeout>`.
.google.protobuf.Duration idle_timeout = 11 [(.gogoproto.stdduration) = true];boolean hasStreamIdleTimeout()
The stream idle timeout for connections managed by the connection manager. If not specified, this defaults to 5 minutes. The default value was selected so as not to interfere with any smaller configured timeouts that may have existed in configurations prior to the introduction of this feature, while introducing robustness to TCP connections that terminate without a FIN. This idle timeout applies to new streams and is overridable by the :ref:`route-level idle_timeout <envoy_api_field_route.RouteAction.idle_timeout>`. Even on a stream in which the override applies, prior to receipt of the initial request headers, the :ref:`stream_idle_timeout <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.stream_idle_timeout>` applies. Each time an encode/decode event for headers or data is processed for the stream, the timer will be reset. If the timeout fires, the stream is terminated with a 408 Request Timeout error code if no upstream response header has been received, otherwise a stream reset occurs. Note that it is possible to idle timeout even if the wire traffic for a stream is non-idle, due to the granularity of events presented to the connection manager. For example, while receiving very large request headers, it may be the case that there is traffic regularly arriving on the wire while the connection manage is only able to observe the end-of-headers event, hence the stream may still idle timeout. A value of 0 will completely disable the connection manager stream idle timeout, although per-route idle timeout overrides will continue to apply.
.google.protobuf.Duration stream_idle_timeout = 24 [(.gogoproto.stdduration) = true];com.google.protobuf.Duration getStreamIdleTimeout()
The stream idle timeout for connections managed by the connection manager. If not specified, this defaults to 5 minutes. The default value was selected so as not to interfere with any smaller configured timeouts that may have existed in configurations prior to the introduction of this feature, while introducing robustness to TCP connections that terminate without a FIN. This idle timeout applies to new streams and is overridable by the :ref:`route-level idle_timeout <envoy_api_field_route.RouteAction.idle_timeout>`. Even on a stream in which the override applies, prior to receipt of the initial request headers, the :ref:`stream_idle_timeout <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.stream_idle_timeout>` applies. Each time an encode/decode event for headers or data is processed for the stream, the timer will be reset. If the timeout fires, the stream is terminated with a 408 Request Timeout error code if no upstream response header has been received, otherwise a stream reset occurs. Note that it is possible to idle timeout even if the wire traffic for a stream is non-idle, due to the granularity of events presented to the connection manager. For example, while receiving very large request headers, it may be the case that there is traffic regularly arriving on the wire while the connection manage is only able to observe the end-of-headers event, hence the stream may still idle timeout. A value of 0 will completely disable the connection manager stream idle timeout, although per-route idle timeout overrides will continue to apply.
.google.protobuf.Duration stream_idle_timeout = 24 [(.gogoproto.stdduration) = true];com.google.protobuf.DurationOrBuilder getStreamIdleTimeoutOrBuilder()
The stream idle timeout for connections managed by the connection manager. If not specified, this defaults to 5 minutes. The default value was selected so as not to interfere with any smaller configured timeouts that may have existed in configurations prior to the introduction of this feature, while introducing robustness to TCP connections that terminate without a FIN. This idle timeout applies to new streams and is overridable by the :ref:`route-level idle_timeout <envoy_api_field_route.RouteAction.idle_timeout>`. Even on a stream in which the override applies, prior to receipt of the initial request headers, the :ref:`stream_idle_timeout <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.stream_idle_timeout>` applies. Each time an encode/decode event for headers or data is processed for the stream, the timer will be reset. If the timeout fires, the stream is terminated with a 408 Request Timeout error code if no upstream response header has been received, otherwise a stream reset occurs. Note that it is possible to idle timeout even if the wire traffic for a stream is non-idle, due to the granularity of events presented to the connection manager. For example, while receiving very large request headers, it may be the case that there is traffic regularly arriving on the wire while the connection manage is only able to observe the end-of-headers event, hence the stream may still idle timeout. A value of 0 will completely disable the connection manager stream idle timeout, although per-route idle timeout overrides will continue to apply.
.google.protobuf.Duration stream_idle_timeout = 24 [(.gogoproto.stdduration) = true];boolean hasDrainTimeout()
The time that Envoy will wait between sending an HTTP/2 “shutdown notification” (GOAWAY frame with max stream ID) and a final GOAWAY frame. This is used so that Envoy provides a grace period for new streams that race with the final GOAWAY frame. During this grace period, Envoy will continue to accept new streams. After the grace period, a final GOAWAY frame is sent and Envoy will start refusing new streams. Draining occurs both when a connection hits the idle timeout or during general server draining. The default grace period is 5000 milliseconds (5 seconds) if this option is not specified.
.google.protobuf.Duration drain_timeout = 12 [(.gogoproto.stdduration) = true];com.google.protobuf.Duration getDrainTimeout()
The time that Envoy will wait between sending an HTTP/2 “shutdown notification” (GOAWAY frame with max stream ID) and a final GOAWAY frame. This is used so that Envoy provides a grace period for new streams that race with the final GOAWAY frame. During this grace period, Envoy will continue to accept new streams. After the grace period, a final GOAWAY frame is sent and Envoy will start refusing new streams. Draining occurs both when a connection hits the idle timeout or during general server draining. The default grace period is 5000 milliseconds (5 seconds) if this option is not specified.
.google.protobuf.Duration drain_timeout = 12 [(.gogoproto.stdduration) = true];com.google.protobuf.DurationOrBuilder getDrainTimeoutOrBuilder()
The time that Envoy will wait between sending an HTTP/2 “shutdown notification” (GOAWAY frame with max stream ID) and a final GOAWAY frame. This is used so that Envoy provides a grace period for new streams that race with the final GOAWAY frame. During this grace period, Envoy will continue to accept new streams. After the grace period, a final GOAWAY frame is sent and Envoy will start refusing new streams. Draining occurs both when a connection hits the idle timeout or during general server draining. The default grace period is 5000 milliseconds (5 seconds) if this option is not specified.
.google.protobuf.Duration drain_timeout = 12 [(.gogoproto.stdduration) = true];boolean hasDelayedCloseTimeout()
The delayed close timeout is for downstream connections managed by the HTTP connection manager. It is defined as a grace period after connection close processing has been locally initiated during which Envoy will flush the write buffers for the connection and await the peer to close (i.e., a TCP FIN/RST is received by Envoy from the downstream connection). Delaying Envoy's connection close and giving the peer the opportunity to initate the close sequence mitigates a race condition that exists when downstream clients do not drain/process data in a connection's receive buffer after a remote close has been detected via a socket write(). This race leads to such clients failing to process the response code sent by Envoy, which could result in erroneous downstream processing. If the timeout triggers, Envoy will close the connection's socket. The default timeout is 1000 ms if this option is not specified. A value of 0 will completely disable delayed close processing, and the downstream connection's socket will be closed immediately after the write flush is completed.
.google.protobuf.Duration delayed_close_timeout = 26 [(.gogoproto.stdduration) = true];com.google.protobuf.Duration getDelayedCloseTimeout()
The delayed close timeout is for downstream connections managed by the HTTP connection manager. It is defined as a grace period after connection close processing has been locally initiated during which Envoy will flush the write buffers for the connection and await the peer to close (i.e., a TCP FIN/RST is received by Envoy from the downstream connection). Delaying Envoy's connection close and giving the peer the opportunity to initate the close sequence mitigates a race condition that exists when downstream clients do not drain/process data in a connection's receive buffer after a remote close has been detected via a socket write(). This race leads to such clients failing to process the response code sent by Envoy, which could result in erroneous downstream processing. If the timeout triggers, Envoy will close the connection's socket. The default timeout is 1000 ms if this option is not specified. A value of 0 will completely disable delayed close processing, and the downstream connection's socket will be closed immediately after the write flush is completed.
.google.protobuf.Duration delayed_close_timeout = 26 [(.gogoproto.stdduration) = true];com.google.protobuf.DurationOrBuilder getDelayedCloseTimeoutOrBuilder()
The delayed close timeout is for downstream connections managed by the HTTP connection manager. It is defined as a grace period after connection close processing has been locally initiated during which Envoy will flush the write buffers for the connection and await the peer to close (i.e., a TCP FIN/RST is received by Envoy from the downstream connection). Delaying Envoy's connection close and giving the peer the opportunity to initate the close sequence mitigates a race condition that exists when downstream clients do not drain/process data in a connection's receive buffer after a remote close has been detected via a socket write(). This race leads to such clients failing to process the response code sent by Envoy, which could result in erroneous downstream processing. If the timeout triggers, Envoy will close the connection's socket. The default timeout is 1000 ms if this option is not specified. A value of 0 will completely disable delayed close processing, and the downstream connection's socket will be closed immediately after the write flush is completed.
.google.protobuf.Duration delayed_close_timeout = 26 [(.gogoproto.stdduration) = true];List<Accesslog.AccessLog> getAccessLogList()
Configuration for :ref:`HTTP access logs <arch_overview_access_logs>` emitted by the connection manager.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 13;Accesslog.AccessLog getAccessLog(int index)
Configuration for :ref:`HTTP access logs <arch_overview_access_logs>` emitted by the connection manager.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 13;int getAccessLogCount()
Configuration for :ref:`HTTP access logs <arch_overview_access_logs>` emitted by the connection manager.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 13;List<? extends Accesslog.AccessLogOrBuilder> getAccessLogOrBuilderList()
Configuration for :ref:`HTTP access logs <arch_overview_access_logs>` emitted by the connection manager.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 13;Accesslog.AccessLogOrBuilder getAccessLogOrBuilder(int index)
Configuration for :ref:`HTTP access logs <arch_overview_access_logs>` emitted by the connection manager.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 13;boolean hasUseRemoteAddress()
If set to true, the connection manager will use the real remote address of the client connection when determining internal versus external origin and manipulating various headers. If set to false or absent, the connection manager will use the :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header. See the documentation for :ref:`config_http_conn_man_headers_x-forwarded-for`, :ref:`config_http_conn_man_headers_x-envoy-internal`, and :ref:`config_http_conn_man_headers_x-envoy-external-address` for more information.
.google.protobuf.BoolValue use_remote_address = 14;com.google.protobuf.BoolValue getUseRemoteAddress()
If set to true, the connection manager will use the real remote address of the client connection when determining internal versus external origin and manipulating various headers. If set to false or absent, the connection manager will use the :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header. See the documentation for :ref:`config_http_conn_man_headers_x-forwarded-for`, :ref:`config_http_conn_man_headers_x-envoy-internal`, and :ref:`config_http_conn_man_headers_x-envoy-external-address` for more information.
.google.protobuf.BoolValue use_remote_address = 14;com.google.protobuf.BoolValueOrBuilder getUseRemoteAddressOrBuilder()
If set to true, the connection manager will use the real remote address of the client connection when determining internal versus external origin and manipulating various headers. If set to false or absent, the connection manager will use the :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header. See the documentation for :ref:`config_http_conn_man_headers_x-forwarded-for`, :ref:`config_http_conn_man_headers_x-envoy-internal`, and :ref:`config_http_conn_man_headers_x-envoy-external-address` for more information.
.google.protobuf.BoolValue use_remote_address = 14;int getXffNumTrustedHops()
The number of additional ingress proxy hops from the right side of the :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header to trust when determining the origin client's IP address. The default is zero if this option is not specified. See the documentation for :ref:`config_http_conn_man_headers_x-forwarded-for` for more information.
uint32 xff_num_trusted_hops = 19;boolean hasInternalAddressConfig()
Configures what network addresses are considered internal for stats and header sanitation purposes. If unspecified, only RFC1918 IP addresses will be considered internal. See the documentation for :ref:`config_http_conn_man_headers_x-envoy-internal` for more information about internal/external addresses.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.InternalAddressConfig internal_address_config = 25;HttpConnectionManagerOuterClass.HttpConnectionManager.InternalAddressConfig getInternalAddressConfig()
Configures what network addresses are considered internal for stats and header sanitation purposes. If unspecified, only RFC1918 IP addresses will be considered internal. See the documentation for :ref:`config_http_conn_man_headers_x-envoy-internal` for more information about internal/external addresses.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.InternalAddressConfig internal_address_config = 25;HttpConnectionManagerOuterClass.HttpConnectionManager.InternalAddressConfigOrBuilder getInternalAddressConfigOrBuilder()
Configures what network addresses are considered internal for stats and header sanitation purposes. If unspecified, only RFC1918 IP addresses will be considered internal. See the documentation for :ref:`config_http_conn_man_headers_x-envoy-internal` for more information about internal/external addresses.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.InternalAddressConfig internal_address_config = 25;boolean getSkipXffAppend()
If set, Envoy will not append the remote address to the :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header. This may be used in conjunction with HTTP filters that explicitly manipulate XFF after the HTTP connection manager has mutated the request headers. While :ref:`use_remote_address <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.use_remote_address>` will also suppress XFF addition, it has consequences for logging and other Envoy uses of the remote address, so *skip_xff_append* should be used when only an elision of XFF addition is intended.
bool skip_xff_append = 21;String getVia()
Via header value to append to request and response headers. If this is empty, no via header will be appended.
string via = 22;com.google.protobuf.ByteString getViaBytes()
Via header value to append to request and response headers. If this is empty, no via header will be appended.
string via = 22;boolean hasGenerateRequestId()
Whether the connection manager will generate the :ref:`x-request-id <config_http_conn_man_headers_x-request-id>` header if it does not exist. This defaults to true. Generating a random UUID4 is expensive so in high throughput scenarios where this feature is not desired it can be disabled.
.google.protobuf.BoolValue generate_request_id = 15;com.google.protobuf.BoolValue getGenerateRequestId()
Whether the connection manager will generate the :ref:`x-request-id <config_http_conn_man_headers_x-request-id>` header if it does not exist. This defaults to true. Generating a random UUID4 is expensive so in high throughput scenarios where this feature is not desired it can be disabled.
.google.protobuf.BoolValue generate_request_id = 15;com.google.protobuf.BoolValueOrBuilder getGenerateRequestIdOrBuilder()
Whether the connection manager will generate the :ref:`x-request-id <config_http_conn_man_headers_x-request-id>` header if it does not exist. This defaults to true. Generating a random UUID4 is expensive so in high throughput scenarios where this feature is not desired it can be disabled.
.google.protobuf.BoolValue generate_request_id = 15;int getForwardClientCertDetailsValue()
How to handle the :ref:`config_http_conn_man_headers_x-forwarded-client-cert` (XFCC) HTTP header.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.ForwardClientCertDetails forward_client_cert_details = 16 [(.validate.rules) = { ... }HttpConnectionManagerOuterClass.HttpConnectionManager.ForwardClientCertDetails getForwardClientCertDetails()
How to handle the :ref:`config_http_conn_man_headers_x-forwarded-client-cert` (XFCC) HTTP header.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.ForwardClientCertDetails forward_client_cert_details = 16 [(.validate.rules) = { ... }boolean hasSetCurrentClientCertDetails()
This field is valid only when :ref:`forward_client_cert_details <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.forward_client_cert_details>` is APPEND_FORWARD or SANITIZE_SET and the client connection is mTLS. It specifies the fields in the client certificate to be forwarded. Note that in the :ref:`config_http_conn_man_headers_x-forwarded-client-cert` header, *Hash* is always set, and *By* is always set when the client certificate presents the URI type Subject Alternative Name value.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.SetCurrentClientCertDetails set_current_client_cert_details = 17;HttpConnectionManagerOuterClass.HttpConnectionManager.SetCurrentClientCertDetails getSetCurrentClientCertDetails()
This field is valid only when :ref:`forward_client_cert_details <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.forward_client_cert_details>` is APPEND_FORWARD or SANITIZE_SET and the client connection is mTLS. It specifies the fields in the client certificate to be forwarded. Note that in the :ref:`config_http_conn_man_headers_x-forwarded-client-cert` header, *Hash* is always set, and *By* is always set when the client certificate presents the URI type Subject Alternative Name value.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.SetCurrentClientCertDetails set_current_client_cert_details = 17;HttpConnectionManagerOuterClass.HttpConnectionManager.SetCurrentClientCertDetailsOrBuilder getSetCurrentClientCertDetailsOrBuilder()
This field is valid only when :ref:`forward_client_cert_details <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.forward_client_cert_details>` is APPEND_FORWARD or SANITIZE_SET and the client connection is mTLS. It specifies the fields in the client certificate to be forwarded. Note that in the :ref:`config_http_conn_man_headers_x-forwarded-client-cert` header, *Hash* is always set, and *By* is always set when the client certificate presents the URI type Subject Alternative Name value.
.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.SetCurrentClientCertDetails set_current_client_cert_details = 17;boolean getProxy100Continue()
If proxy_100_continue is true, Envoy will proxy incoming "Expect: 100-continue" headers upstream, and forward "100 Continue" responses downstream. If this is false or not set, Envoy will instead strip the "Expect: 100-continue" header, and send a "100 Continue" response itself.
bool proxy_100_continue = 18;boolean getRepresentIpv4RemoteAddressAsIpv4MappedIpv6()
If :ref:`use_remote_address <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.use_remote_address>` is true and represent_ipv4_remote_address_as_ipv4_mapped_ipv6 is true and the remote address is an IPv4 address, the address will be mapped to IPv6 before it is appended to *x-forwarded-for*. This is useful for testing compatibility of upstream services that parse the header value. For example, 50.0.0.1 is represented as ::FFFF:50.0.0.1. See `IPv4-Mapped IPv6 Addresses <https://tools.ietf.org/html/rfc4291#section-2.5.5.2>`_ for details. This will also affect the :ref:`config_http_conn_man_headers_x-envoy-external-address` header. See :ref:`http_connection_manager.represent_ipv4_remote_address_as_ipv4_mapped_ipv6 <config_http_conn_man_runtime_represent_ipv4_remote_address_as_ipv4_mapped_ipv6>` for runtime control.
bool represent_ipv4_remote_address_as_ipv4_mapped_ipv6 = 20;List<HttpConnectionManagerOuterClass.HttpConnectionManager.UpgradeConfig> getUpgradeConfigsList()
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.UpgradeConfig upgrade_configs = 23;HttpConnectionManagerOuterClass.HttpConnectionManager.UpgradeConfig getUpgradeConfigs(int index)
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.UpgradeConfig upgrade_configs = 23;int getUpgradeConfigsCount()
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.UpgradeConfig upgrade_configs = 23;List<? extends HttpConnectionManagerOuterClass.HttpConnectionManager.UpgradeConfigOrBuilder> getUpgradeConfigsOrBuilderList()
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.UpgradeConfig upgrade_configs = 23;HttpConnectionManagerOuterClass.HttpConnectionManager.UpgradeConfigOrBuilder getUpgradeConfigsOrBuilder(int index)
repeated .envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.UpgradeConfig upgrade_configs = 23;HttpConnectionManagerOuterClass.HttpConnectionManager.RouteSpecifierCase getRouteSpecifierCase()
Copyright © 2018 The Envoy Project. All rights reserved.