Class BufferSettings.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- 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 typeenvoy.extensions.filters.http.ext_authz.v3.BufferSettings
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BufferSettings.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)BufferSettingsbuild()BufferSettingsbuildPartial()BufferSettings.Builderclear()BufferSettings.BuilderclearAllowPartialMessage()When this field is true, Envoy will buffer the message until ``max_request_bytes`` is reached.BufferSettings.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)BufferSettings.BuilderclearMaxRequestBytes()Sets the maximum size of a message body that the filter will hold in memory.BufferSettings.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)BufferSettings.BuilderclearPackAsBytes()If true, the body sent to the external authorization service is set with raw bytes, it sets the :ref:`raw_body<envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.raw_body>` field of HTTP request attribute context.BufferSettings.Builderclone()booleangetAllowPartialMessage()When this field is true, Envoy will buffer the message until ``max_request_bytes`` is reached.BufferSettingsgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()intgetMaxRequestBytes()Sets the maximum size of a message body that the filter will hold in memory.booleangetPackAsBytes()If true, the body sent to the external authorization service is set with raw bytes, it sets the :ref:`raw_body<envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.raw_body>` field of HTTP request attribute context.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()BufferSettings.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)BufferSettings.BuildermergeFrom(com.google.protobuf.Message other)BufferSettings.BuildermergeFrom(BufferSettings other)BufferSettings.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)BufferSettings.BuildersetAllowPartialMessage(boolean value)When this field is true, Envoy will buffer the message until ``max_request_bytes`` is reached.BufferSettings.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)BufferSettings.BuildersetMaxRequestBytes(int value)Sets the maximum size of a message body that the filter will hold in memory.BufferSettings.BuildersetPackAsBytes(boolean value)If true, the body sent to the external authorization service is set with raw bytes, it sets the :ref:`raw_body<envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.raw_body>` field of HTTP request attribute context.BufferSettings.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)BufferSettings.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, 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
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>
-
clear
public BufferSettings.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>
-
getDefaultInstanceForType
public BufferSettings getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public BufferSettings build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public BufferSettings buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public BufferSettings.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>
-
setField
public BufferSettings.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>
-
clearField
public BufferSettings.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>
-
clearOneof
public BufferSettings.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>
-
setRepeatedField
public BufferSettings.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>
-
addRepeatedField
public BufferSettings.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>
-
mergeFrom
public BufferSettings.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<BufferSettings.Builder>
-
mergeFrom
public BufferSettings.Builder mergeFrom(BufferSettings other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.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 buffer reaches the number set in this field. Note that 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:
getMaxRequestBytesin interfaceBufferSettingsOrBuilder- 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 buffer reaches the number set in this field. Note that 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 buffer reaches the number set in this field. Note that 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.
bool allow_partial_message = 2;- Specified by:
getAllowPartialMessagein interfaceBufferSettingsOrBuilder- 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.
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.
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 with raw bytes, it sets the :ref:`raw_body<envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.raw_body>` field of HTTP request attribute context. Otherwise, :ref:` body<envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.body>` will be filled with UTF-8 string request body.
bool pack_as_bytes = 3;- Specified by:
getPackAsBytesin interfaceBufferSettingsOrBuilder- Returns:
- The packAsBytes.
-
setPackAsBytes
public BufferSettings.Builder setPackAsBytes(boolean value)
If true, the body sent to the external authorization service is set with raw bytes, it sets the :ref:`raw_body<envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.raw_body>` field of HTTP request attribute context. Otherwise, :ref:` body<envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.body>` will be filled with UTF-8 string request body.
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 with raw bytes, it sets the :ref:`raw_body<envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.raw_body>` field of HTTP request attribute context. Otherwise, :ref:` body<envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.body>` will be filled with UTF-8 string request body.
bool pack_as_bytes = 3;- Returns:
- This builder for chaining.
-
setUnknownFields
public final BufferSettings.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>
-
mergeUnknownFields
public final BufferSettings.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<BufferSettings.Builder>
-
-