Package io.envoyproxy.envoy.extensions.filters.http.ext_authz.v3

Interface BufferSettingsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BufferSettings, BufferSettings.Builder
public interface BufferSettingsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAllowPartialMessage()
    When this field is ``true``, Envoy will buffer the message until ``max_request_bytes`` is reached.
    int
    getMaxRequestBytes()
    Sets the maximum size of a message body that the filter will hold in memory.
    boolean
    getPackAsBytes()
    If ``true``, the body sent to the external authorization service is set as raw bytes and populates :ref:`raw_body<envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.raw_body>` in the HTTP request attribute context.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getMaxRequestBytes

      int getMaxRequestBytes()
       Sets the maximum size of a message body that the filter will hold in memory. Envoy will return
 ``HTTP 413`` and will *not* initiate the authorization process when the buffer reaches the size
 set in this field.

 .. note::
   This setting will have precedence over :ref:`failure_mode_allow
   <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.failure_mode_allow>`.
      uint32 max_request_bytes = 1 [(.validate.rules) = { ... }
      Returns:
      The maxRequestBytes.

    • getAllowPartialMessage

      boolean getAllowPartialMessage()
       When this field is ``true``, Envoy will buffer the message until ``max_request_bytes`` is reached.
 The authorization request will be dispatched and no 413 HTTP error will be returned by the
 filter.

 Defaults to ``false``.
      bool allow_partial_message = 2;
      Returns:
      The allowPartialMessage.

    • getPackAsBytes

      boolean getPackAsBytes()
       If ``true``, the body sent to the external authorization service is set as raw bytes and populates
 :ref:`raw_body<envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.raw_body>`
 in the HTTP request attribute context. Otherwise, :ref:`body
 <envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.body>` will be populated
 with a UTF-8 string request body.

 This field only affects configurations using a :ref:`grpc_service
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`. In configurations that use
 an :ref:`http_service <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.http_service>`, this
 has no effect.

 Defaults to ``false``.
      bool pack_as_bytes = 3;
      Returns:
      The packAsBytes.