io.envoyproxy.envoy.config.core.v4alpha

Interface HttpProtocolOptionsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

HttpProtocolOptions, HttpProtocolOptions.Builder

public interface HttpProtocolOptionsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
HttpProtocolOptions.HeadersWithUnderscoresAction	getHeadersWithUnderscoresAction() Action to take when a client request with a header name containing underscore characters is received.
int	getHeadersWithUnderscoresActionValue() Action to take when a client request with a header name containing underscore characters is received.
com.google.protobuf.Duration	getIdleTimeout() The idle timeout for connections.
com.google.protobuf.DurationOrBuilder	getIdleTimeoutOrBuilder() The idle timeout for connections.
com.google.protobuf.Duration	getMaxConnectionDuration() The maximum duration of a connection.
com.google.protobuf.DurationOrBuilder	getMaxConnectionDurationOrBuilder() The maximum duration of a connection.
com.google.protobuf.UInt32Value	getMaxHeadersCount() The maximum number of headers.
com.google.protobuf.UInt32ValueOrBuilder	getMaxHeadersCountOrBuilder() The maximum number of headers.
com.google.protobuf.Duration	getMaxStreamDuration() Total duration to keep alive an HTTP request/response stream.
com.google.protobuf.DurationOrBuilder	getMaxStreamDurationOrBuilder() Total duration to keep alive an HTTP request/response stream.
boolean	hasIdleTimeout() The idle timeout for connections.
boolean	hasMaxConnectionDuration() The maximum duration of a connection.
boolean	hasMaxHeadersCount() The maximum number of headers.
boolean	hasMaxStreamDuration() Total duration to keep alive an HTTP request/response stream.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasIdleTimeout

boolean hasIdleTimeout()

 The idle timeout for connections. The idle timeout is defined as the
 period in which there are no active requests. When the
 idle timeout is reached the connection will be closed. If the connection is an HTTP/2
 downstream connection a drain sequence will occur prior to closing the connection, see
 :ref:`drain_timeout
 <envoy_api_field_extensions.filters.network.http_connection_manager.v4alpha.HttpConnectionManager.drain_timeout>`.
 Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.
 If not specified, this defaults to 1 hour. To disable idle timeouts explicitly set this to 0.
 .. warning::
   Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
   FIN packets, etc.
 If the :ref:`overload action <config_overload_manager_overload_actions>` "envoy.overload_actions.reduce_timeouts"
 is configured, this timeout is scaled for downstream connections according to the value for
 :ref:`HTTP_DOWNSTREAM_CONNECTION_IDLE <envoy_api_enum_value_config.overload.v3.ScaleTimersOverloadActionConfig.TimerType.HTTP_DOWNSTREAM_CONNECTION_IDLE>`.
 

.google.protobuf.Duration idle_timeout = 1;

getIdleTimeout

com.google.protobuf.Duration getIdleTimeout()

 The idle timeout for connections. The idle timeout is defined as the
 period in which there are no active requests. When the
 idle timeout is reached the connection will be closed. If the connection is an HTTP/2
 downstream connection a drain sequence will occur prior to closing the connection, see
 :ref:`drain_timeout
 <envoy_api_field_extensions.filters.network.http_connection_manager.v4alpha.HttpConnectionManager.drain_timeout>`.
 Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.
 If not specified, this defaults to 1 hour. To disable idle timeouts explicitly set this to 0.
 .. warning::
   Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
   FIN packets, etc.
 If the :ref:`overload action <config_overload_manager_overload_actions>` "envoy.overload_actions.reduce_timeouts"
 is configured, this timeout is scaled for downstream connections according to the value for
 :ref:`HTTP_DOWNSTREAM_CONNECTION_IDLE <envoy_api_enum_value_config.overload.v3.ScaleTimersOverloadActionConfig.TimerType.HTTP_DOWNSTREAM_CONNECTION_IDLE>`.
 

.google.protobuf.Duration idle_timeout = 1;

getIdleTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getIdleTimeoutOrBuilder()

 The idle timeout for connections. The idle timeout is defined as the
 period in which there are no active requests. When the
 idle timeout is reached the connection will be closed. If the connection is an HTTP/2
 downstream connection a drain sequence will occur prior to closing the connection, see
 :ref:`drain_timeout
 <envoy_api_field_extensions.filters.network.http_connection_manager.v4alpha.HttpConnectionManager.drain_timeout>`.
 Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.
 If not specified, this defaults to 1 hour. To disable idle timeouts explicitly set this to 0.
 .. warning::
   Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
   FIN packets, etc.
 If the :ref:`overload action <config_overload_manager_overload_actions>` "envoy.overload_actions.reduce_timeouts"
 is configured, this timeout is scaled for downstream connections according to the value for
 :ref:`HTTP_DOWNSTREAM_CONNECTION_IDLE <envoy_api_enum_value_config.overload.v3.ScaleTimersOverloadActionConfig.TimerType.HTTP_DOWNSTREAM_CONNECTION_IDLE>`.
 

.google.protobuf.Duration idle_timeout = 1;

hasMaxConnectionDuration

boolean hasMaxConnectionDuration()

 The maximum duration of a connection. The duration is defined as a period since a connection
 was established. If not set, there is no max duration. When max_connection_duration is reached
 the connection will be closed. Drain sequence will occur prior to closing the connection if
 if's applicable. See :ref:`drain_timeout
 <envoy_api_field_extensions.filters.network.http_connection_manager.v4alpha.HttpConnectionManager.drain_timeout>`.
 Note: not implemented for upstream connections.
 

.google.protobuf.Duration max_connection_duration = 3;

getMaxConnectionDuration

com.google.protobuf.Duration getMaxConnectionDuration()

 The maximum duration of a connection. The duration is defined as a period since a connection
 was established. If not set, there is no max duration. When max_connection_duration is reached
 the connection will be closed. Drain sequence will occur prior to closing the connection if
 if's applicable. See :ref:`drain_timeout
 <envoy_api_field_extensions.filters.network.http_connection_manager.v4alpha.HttpConnectionManager.drain_timeout>`.
 Note: not implemented for upstream connections.
 

.google.protobuf.Duration max_connection_duration = 3;

getMaxConnectionDurationOrBuilder

com.google.protobuf.DurationOrBuilder getMaxConnectionDurationOrBuilder()

 The maximum duration of a connection. The duration is defined as a period since a connection
 was established. If not set, there is no max duration. When max_connection_duration is reached
 the connection will be closed. Drain sequence will occur prior to closing the connection if
 if's applicable. See :ref:`drain_timeout
 <envoy_api_field_extensions.filters.network.http_connection_manager.v4alpha.HttpConnectionManager.drain_timeout>`.
 Note: not implemented for upstream connections.
 

.google.protobuf.Duration max_connection_duration = 3;

hasMaxHeadersCount

boolean hasMaxHeadersCount()

 The maximum number of headers. If unconfigured, the default
 maximum number of request headers allowed is 100. Requests that exceed this limit will receive
 a 431 response for HTTP/1.x and cause a stream reset for HTTP/2.
 

.google.protobuf.UInt32Value max_headers_count = 2 [(.validate.rules) = { ... }

getMaxHeadersCount

com.google.protobuf.UInt32Value getMaxHeadersCount()

 The maximum number of headers. If unconfigured, the default
 maximum number of request headers allowed is 100. Requests that exceed this limit will receive
 a 431 response for HTTP/1.x and cause a stream reset for HTTP/2.
 

.google.protobuf.UInt32Value max_headers_count = 2 [(.validate.rules) = { ... }

getMaxHeadersCountOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getMaxHeadersCountOrBuilder()

 The maximum number of headers. If unconfigured, the default
 maximum number of request headers allowed is 100. Requests that exceed this limit will receive
 a 431 response for HTTP/1.x and cause a stream reset for HTTP/2.
 

.google.protobuf.UInt32Value max_headers_count = 2 [(.validate.rules) = { ... }

hasMaxStreamDuration

boolean hasMaxStreamDuration()

 Total duration to keep alive an HTTP request/response stream. If the time limit is reached the stream will be
 reset independent of any other timeouts. If not specified, this value is not set.
 

.google.protobuf.Duration max_stream_duration = 4;

getMaxStreamDuration

com.google.protobuf.Duration getMaxStreamDuration()

 Total duration to keep alive an HTTP request/response stream. If the time limit is reached the stream will be
 reset independent of any other timeouts. If not specified, this value is not set.
 

.google.protobuf.Duration max_stream_duration = 4;

getMaxStreamDurationOrBuilder

com.google.protobuf.DurationOrBuilder getMaxStreamDurationOrBuilder()

 Total duration to keep alive an HTTP request/response stream. If the time limit is reached the stream will be
 reset independent of any other timeouts. If not specified, this value is not set.
 

.google.protobuf.Duration max_stream_duration = 4;

getHeadersWithUnderscoresActionValue

int getHeadersWithUnderscoresActionValue()

 Action to take when a client request with a header name containing underscore characters is received.
 If this setting is not specified, the value defaults to ALLOW.
 Note: upstream responses are not affected by this setting.
 

.envoy.config.core.v4alpha.HttpProtocolOptions.HeadersWithUnderscoresAction headers_with_underscores_action = 5;

getHeadersWithUnderscoresAction

HttpProtocolOptions.HeadersWithUnderscoresAction getHeadersWithUnderscoresAction()

 Action to take when a client request with a header name containing underscore characters is received.
 If this setting is not specified, the value defaults to ALLOW.
 Note: upstream responses are not affected by this setting.
 

.envoy.config.core.v4alpha.HttpProtocolOptions.HeadersWithUnderscoresAction headers_with_underscores_action = 5;