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

Class BufferSettings

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BufferSettingsOrBuilder, Serializable

public final class BufferSettings
extends com.google.protobuf.GeneratedMessageV3
implements BufferSettingsOrBuilder

 Configuration for buffering the request data.
 

Protobuf type envoy.extensions.filters.http.ext_authz.v3.BufferSettings

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BufferSettings.Builder Configuration for buffering the request data.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOW_PARTIAL_MESSAGE_FIELD_NUMBER
static int	MAX_REQUEST_BYTES_FIELD_NUMBER
static int	PACK_AS_BYTES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getAllowPartialMessage() When this field is true, Envoy will buffer the message until *max_request_bytes* is reached.
static BufferSettings	getDefaultInstance()
BufferSettings	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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 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.
com.google.protobuf.Parser<BufferSettings>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BufferSettings.Builder	newBuilder()
static BufferSettings.Builder	newBuilder(BufferSettings prototype)
BufferSettings.Builder	newBuilderForType()
protected BufferSettings.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BufferSettings	parseDelimitedFrom(InputStream input)
static BufferSettings	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BufferSettings	parseFrom(byte[] data)
static BufferSettings	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BufferSettings	parseFrom(ByteBuffer data)
static BufferSettings	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BufferSettings	parseFrom(com.google.protobuf.ByteString data)
static BufferSettings	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BufferSettings	parseFrom(com.google.protobuf.CodedInputStream input)
static BufferSettings	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BufferSettings	parseFrom(InputStream input)
static BufferSettings	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BufferSettings>	parser()
BufferSettings.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MAX_REQUEST_BYTES_FIELD_NUMBER

public static final int MAX_REQUEST_BYTES_FIELD_NUMBER

See Also:

Constant Field Values

ALLOW_PARTIAL_MESSAGE_FIELD_NUMBER

public static final int ALLOW_PARTIAL_MESSAGE_FIELD_NUMBER

See Also:

Constant Field Values

PACK_AS_BYTES_FIELD_NUMBER

public static final int PACK_AS_BYTES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

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_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

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:

getAllowPartialMessage in interface BufferSettingsOrBuilder

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:

getPackAsBytes in interface BufferSettingsOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static BufferSettings parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BufferSettings parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BufferSettings parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BufferSettings parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BufferSettings parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BufferSettings parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BufferSettings parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static BufferSettings parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static BufferSettings parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static BufferSettings parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static BufferSettings parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static BufferSettings parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public BufferSettings.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BufferSettings.Builder newBuilder()

newBuilder

public static BufferSettings.Builder newBuilder(BufferSettings prototype)

toBuilder

public BufferSettings.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected BufferSettings.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BufferSettings getDefaultInstance()

parser

public static com.google.protobuf.Parser<BufferSettings> parser()

getParserForType

public com.google.protobuf.Parser<BufferSettings> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public BufferSettings getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder