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 Details

    • 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_v3_api_field_extensions.filters.network.http_connection_manager.v3.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_v3_api_enum_value_config.overload.v3.ScaleTimersOverloadActionConfig.TimerType.HTTP_DOWNSTREAM_CONNECTION_IDLE>`.
       
      .google.protobuf.Duration idle_timeout = 1;
      Returns:
      Whether the idleTimeout field is set.
    • 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_v3_api_field_extensions.filters.network.http_connection_manager.v3.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_v3_api_enum_value_config.overload.v3.ScaleTimersOverloadActionConfig.TimerType.HTTP_DOWNSTREAM_CONNECTION_IDLE>`.
       
      .google.protobuf.Duration idle_timeout = 1;
      Returns:
      The idleTimeout.
    • 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_v3_api_field_extensions.filters.network.http_connection_manager.v3.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_v3_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
       and if there are no active streams, the connection will be closed. If the connection is a
       downstream connection and there are any active streams, the drain sequence will kick-in,
       and the connection will be force-closed after the drain period. See :ref:`drain_timeout
       <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.drain_timeout>`.
       
      .google.protobuf.Duration max_connection_duration = 3;
      Returns:
      Whether the maxConnectionDuration field is set.
    • 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
       and if there are no active streams, the connection will be closed. If the connection is a
       downstream connection and there are any active streams, the drain sequence will kick-in,
       and the connection will be force-closed after the drain period. See :ref:`drain_timeout
       <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.drain_timeout>`.
       
      .google.protobuf.Duration max_connection_duration = 3;
      Returns:
      The maxConnectionDuration.
    • 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
       and if there are no active streams, the connection will be closed. If the connection is a
       downstream connection and there are any active streams, the drain sequence will kick-in,
       and the connection will be force-closed after the drain period. See :ref:`drain_timeout
       <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.drain_timeout>`.
       
      .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) = { ... }
      Returns:
      Whether the maxHeadersCount field is set.
    • 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) = { ... }
      Returns:
      The maxHeadersCount.
    • 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;
      Returns:
      Whether the maxStreamDuration field is set.
    • 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;
      Returns:
      The maxStreamDuration.
    • 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.
       Note: this only affects client headers. It does not affect headers added
       by Envoy filters and does not have any impact if added to cluster config.
       
      .envoy.config.core.v3.HttpProtocolOptions.HeadersWithUnderscoresAction headers_with_underscores_action = 5;
      Returns:
      The enum numeric value on the wire for headersWithUnderscoresAction.
    • 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.
       Note: this only affects client headers. It does not affect headers added
       by Envoy filters and does not have any impact if added to cluster config.
       
      .envoy.config.core.v3.HttpProtocolOptions.HeadersWithUnderscoresAction headers_with_underscores_action = 5;
      Returns:
      The headersWithUnderscoresAction.
    • hasMaxRequestsPerConnection

      boolean hasMaxRequestsPerConnection()
       Optional maximum requests for both upstream and downstream connections.
       If not specified, there is no limit.
       Setting this parameter to 1 will effectively disable keep alive.
       For HTTP/2 and HTTP/3, due to concurrent stream processing, the limit is approximate.
       
      .google.protobuf.UInt32Value max_requests_per_connection = 6;
      Returns:
      Whether the maxRequestsPerConnection field is set.
    • getMaxRequestsPerConnection

      com.google.protobuf.UInt32Value getMaxRequestsPerConnection()
       Optional maximum requests for both upstream and downstream connections.
       If not specified, there is no limit.
       Setting this parameter to 1 will effectively disable keep alive.
       For HTTP/2 and HTTP/3, due to concurrent stream processing, the limit is approximate.
       
      .google.protobuf.UInt32Value max_requests_per_connection = 6;
      Returns:
      The maxRequestsPerConnection.
    • getMaxRequestsPerConnectionOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getMaxRequestsPerConnectionOrBuilder()
       Optional maximum requests for both upstream and downstream connections.
       If not specified, there is no limit.
       Setting this parameter to 1 will effectively disable keep alive.
       For HTTP/2 and HTTP/3, due to concurrent stream processing, the limit is approximate.
       
      .google.protobuf.UInt32Value max_requests_per_connection = 6;