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

Class BufferSettings.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>
io.envoyproxy.envoy.extensions.filters.http.ext_authz.v3.BufferSettings.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BufferSettingsOrBuilder, Cloneable
Enclosing class:
BufferSettings
public static final class BufferSettings.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder> implements BufferSettingsOrBuilder
 Configuration for buffering the request data.
Protobuf type envoy.extensions.filters.http.ext_authz.v3.BufferSettings

  • Method Summary

    Modifier and Type
    Method
    Description
    BufferSettings.Builder
    addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    BufferSettings
    build()
     
    BufferSettings
    buildPartial()
     
    BufferSettings.Builder
    clear()
     
    BufferSettings.Builder
    clearAllowPartialMessage()
    When this field is ``true``, Envoy will buffer the message until ``max_request_bytes`` is reached.
    BufferSettings.Builder
    clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
     
    BufferSettings.Builder
    clearMaxRequestBytes()
    Sets the maximum size of a message body that the filter will hold in memory.
    BufferSettings.Builder
    clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
     
    BufferSettings.Builder
    clearPackAsBytes()
    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.
    BufferSettings.Builder
    clone()
     
    boolean
    getAllowPartialMessage()
    When this field is ``true``, Envoy will buffer the message until ``max_request_bytes`` is reached.
    BufferSettings
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    BufferSettings.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    BufferSettings.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    BufferSettings.Builder
    mergeFrom(BufferSettings other)
     
    final BufferSettings.Builder
    mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     
    BufferSettings.Builder
    setAllowPartialMessage(boolean value)
    When this field is ``true``, Envoy will buffer the message until ``max_request_bytes`` is reached.
    BufferSettings.Builder
    setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    BufferSettings.Builder
    setMaxRequestBytes(int value)
    Sets the maximum size of a message body that the filter will hold in memory.
    BufferSettings.Builder
    setPackAsBytes(boolean value)
    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.
    BufferSettings.Builder
    setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
     
    final BufferSettings.Builder
    setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     

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

    getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

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

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

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    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 Details

    • 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<BufferSettings.Builder>

    • clear

      public BufferSettings.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<BufferSettings.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<BufferSettings.Builder>

    • getDefaultInstanceForType

      public BufferSettings getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public BufferSettings build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public BufferSettings buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public BufferSettings.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<BufferSettings.Builder>

    • setField

      public BufferSettings.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<BufferSettings.Builder>

    • clearField

      public BufferSettings.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<BufferSettings.Builder>

    • clearOneof

      public BufferSettings.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<BufferSettings.Builder>

    • setRepeatedField

      public BufferSettings.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<BufferSettings.Builder>

    • addRepeatedField

      public BufferSettings.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<BufferSettings.Builder>

    • mergeFrom

      public BufferSettings.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<BufferSettings.Builder>

    • mergeFrom

      public BufferSettings.Builder mergeFrom(BufferSettings other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>

    • mergeFrom

      public BufferSettings.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<BufferSettings.Builder>
      Throws:
      IOException

    • getMaxRequestBytes

      public 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) = { ... }
      Specified by:
      getMaxRequestBytes in interface BufferSettingsOrBuilder
      Returns:
      The maxRequestBytes.

    • setMaxRequestBytes

      public BufferSettings.Builder setMaxRequestBytes(int value)
       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) = { ... }
      Parameters:
      value - The maxRequestBytes to set.
      Returns:
      This builder for chaining.

    • clearMaxRequestBytes

      public BufferSettings.Builder clearMaxRequestBytes()
       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:
      This builder for chaining.

    • getAllowPartialMessage

      public 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;
      Specified by:
      getAllowPartialMessage in interface BufferSettingsOrBuilder
      Returns:
      The allowPartialMessage.

    • setAllowPartialMessage

      public BufferSettings.Builder setAllowPartialMessage(boolean value)
       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;
      Parameters:
      value - The allowPartialMessage to set.
      Returns:
      This builder for chaining.

    • clearAllowPartialMessage

      public BufferSettings.Builder clearAllowPartialMessage()
       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:
      This builder for chaining.

    • getPackAsBytes

      public 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;
      Specified by:
      getPackAsBytes in interface BufferSettingsOrBuilder
      Returns:
      The packAsBytes.

    • setPackAsBytes

      public BufferSettings.Builder setPackAsBytes(boolean value)
       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;
      Parameters:
      value - The packAsBytes to set.
      Returns:
      This builder for chaining.

    • clearPackAsBytes

      public BufferSettings.Builder clearPackAsBytes()
       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:
      This builder for chaining.

    • setUnknownFields

      public final BufferSettings.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<BufferSettings.Builder>

    • mergeUnknownFields

      public final BufferSettings.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<BufferSettings.Builder>