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

Class StreamConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StreamConfigOrBuilder, Serializable
    public final class StreamConfig
extends com.google.protobuf.GeneratedMessageV3
implements StreamConfigOrBuilder
     The configuration for one direction of the filter behavior.
    Protobuf type envoy.extensions.filters.http.file_system_buffer.v3.StreamConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  StreamConfig.Builder
      The configuration for one direction of the filter behavior.

      • 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

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • MEMORY_BUFFER_BYTES_LIMIT_FIELD_NUMBER

        public static final int MEMORY_BUFFER_BYTES_LIMIT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STORAGE_BUFFER_BYTES_LIMIT_FIELD_NUMBER

        public static final int STORAGE_BUFFER_BYTES_LIMIT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STORAGE_BUFFER_QUEUE_HIGH_WATERMARK_BYTES_FIELD_NUMBER

        public static final int STORAGE_BUFFER_QUEUE_HIGH_WATERMARK_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

      • hasBehavior

        public boolean hasBehavior()
         Whether to bypass / stream / fully buffer / etc.
 If unset in route, vhost and listener config, the default is ``stream_when_possible``.
        .envoy.extensions.filters.http.file_system_buffer.v3.BufferBehavior behavior = 1;
        Specified by:
        hasBehavior in interface StreamConfigOrBuilder
        Returns:
        Whether the behavior field is set.

      • getBehavior

        public BufferBehavior getBehavior()
         Whether to bypass / stream / fully buffer / etc.
 If unset in route, vhost and listener config, the default is ``stream_when_possible``.
        .envoy.extensions.filters.http.file_system_buffer.v3.BufferBehavior behavior = 1;
        Specified by:
        getBehavior in interface StreamConfigOrBuilder
        Returns:
        The behavior.

      • getBehaviorOrBuilder

        public BufferBehaviorOrBuilder getBehaviorOrBuilder()
         Whether to bypass / stream / fully buffer / etc.
 If unset in route, vhost and listener config, the default is ``stream_when_possible``.
        .envoy.extensions.filters.http.file_system_buffer.v3.BufferBehavior behavior = 1;
        Specified by:
        getBehaviorOrBuilder in interface StreamConfigOrBuilder

      • hasMemoryBufferBytesLimit

        public boolean hasMemoryBufferBytesLimit()
         The amount stored in the memory buffer before buffering to disk.
 If unset in route, vhost and listener config, defaults to a hardcoded value of 1MiB
        .google.protobuf.UInt64Value memory_buffer_bytes_limit = 2 [(.validate.rules) = { ... }
        Specified by:
        hasMemoryBufferBytesLimit in interface StreamConfigOrBuilder
        Returns:
        Whether the memoryBufferBytesLimit field is set.

      • getMemoryBufferBytesLimit

        public com.google.protobuf.UInt64Value getMemoryBufferBytesLimit()
         The amount stored in the memory buffer before buffering to disk.
 If unset in route, vhost and listener config, defaults to a hardcoded value of 1MiB
        .google.protobuf.UInt64Value memory_buffer_bytes_limit = 2 [(.validate.rules) = { ... }
        Specified by:
        getMemoryBufferBytesLimit in interface StreamConfigOrBuilder
        Returns:
        The memoryBufferBytesLimit.

      • getMemoryBufferBytesLimitOrBuilder

        public com.google.protobuf.UInt64ValueOrBuilder getMemoryBufferBytesLimitOrBuilder()
         The amount stored in the memory buffer before buffering to disk.
 If unset in route, vhost and listener config, defaults to a hardcoded value of 1MiB
        .google.protobuf.UInt64Value memory_buffer_bytes_limit = 2 [(.validate.rules) = { ... }
        Specified by:
        getMemoryBufferBytesLimitOrBuilder in interface StreamConfigOrBuilder

      • hasStorageBufferBytesLimit

        public boolean hasStorageBufferBytesLimit()
         The maximum storage (excluding memory) to be buffered in this filter.
 If unset in route, vhost and listener config, defaults to a hardcoded value of 32MiB
        .google.protobuf.UInt64Value storage_buffer_bytes_limit = 3;
        Specified by:
        hasStorageBufferBytesLimit in interface StreamConfigOrBuilder
        Returns:
        Whether the storageBufferBytesLimit field is set.

      • getStorageBufferBytesLimit

        public com.google.protobuf.UInt64Value getStorageBufferBytesLimit()
         The maximum storage (excluding memory) to be buffered in this filter.
 If unset in route, vhost and listener config, defaults to a hardcoded value of 32MiB
        .google.protobuf.UInt64Value storage_buffer_bytes_limit = 3;
        Specified by:
        getStorageBufferBytesLimit in interface StreamConfigOrBuilder
        Returns:
        The storageBufferBytesLimit.

      • getStorageBufferBytesLimitOrBuilder

        public com.google.protobuf.UInt64ValueOrBuilder getStorageBufferBytesLimitOrBuilder()
         The maximum storage (excluding memory) to be buffered in this filter.
 If unset in route, vhost and listener config, defaults to a hardcoded value of 32MiB
        .google.protobuf.UInt64Value storage_buffer_bytes_limit = 3;
        Specified by:
        getStorageBufferBytesLimitOrBuilder in interface StreamConfigOrBuilder

      • hasStorageBufferQueueHighWatermarkBytes

        public boolean hasStorageBufferQueueHighWatermarkBytes()
         The maximum amount that can be queued for writing to storage, above which the
 source is requested to pause. If unset, defaults to the same value as
 ``memory_buffer_bytes_limit``.
 For example, assuming the recipient is not consuming data at all, if
 ``memory_buffer_bytes_limit`` was 32MiB, and ``storage_buffer_queue_high_watermark_bytes``
 was 64MiB, and the filesystem is backed up so writes are not occurring promptly,
 then:
 * Any request less than 32MiB will eventually pass through without ever attempting
   to write to disk.
 * Any request with over 32MiB buffered will start trying to write to disk.
   If it reaches (32+64)MiB buffered in memory (write to disk isn't keeping up), a high
   watermark signal is sent to the source.
 * Any stream whose total size exceeds
   ``memory_buffer_bytes_limit + storage_buffer_bytes_limit`` will provoke an error.
   (Note, if the recipient *is* consuming data then it is possible for such an
   oversized request to pass through the buffer filter, provided the recipient
   isn't consuming data too slowly.)
 The low watermark signal is sent when the memory buffer is at size
 ``memory_buffer_bytes_limit + (storage_buffer_queue_high_watermark_bytes / 2)``.
        .google.protobuf.UInt64Value storage_buffer_queue_high_watermark_bytes = 4;
        Specified by:
        hasStorageBufferQueueHighWatermarkBytes in interface StreamConfigOrBuilder
        Returns:
        Whether the storageBufferQueueHighWatermarkBytes field is set.

      • getStorageBufferQueueHighWatermarkBytes

        public com.google.protobuf.UInt64Value getStorageBufferQueueHighWatermarkBytes()
         The maximum amount that can be queued for writing to storage, above which the
 source is requested to pause. If unset, defaults to the same value as
 ``memory_buffer_bytes_limit``.
 For example, assuming the recipient is not consuming data at all, if
 ``memory_buffer_bytes_limit`` was 32MiB, and ``storage_buffer_queue_high_watermark_bytes``
 was 64MiB, and the filesystem is backed up so writes are not occurring promptly,
 then:
 * Any request less than 32MiB will eventually pass through without ever attempting
   to write to disk.
 * Any request with over 32MiB buffered will start trying to write to disk.
   If it reaches (32+64)MiB buffered in memory (write to disk isn't keeping up), a high
   watermark signal is sent to the source.
 * Any stream whose total size exceeds
   ``memory_buffer_bytes_limit + storage_buffer_bytes_limit`` will provoke an error.
   (Note, if the recipient *is* consuming data then it is possible for such an
   oversized request to pass through the buffer filter, provided the recipient
   isn't consuming data too slowly.)
 The low watermark signal is sent when the memory buffer is at size
 ``memory_buffer_bytes_limit + (storage_buffer_queue_high_watermark_bytes / 2)``.
        .google.protobuf.UInt64Value storage_buffer_queue_high_watermark_bytes = 4;
        Specified by:
        getStorageBufferQueueHighWatermarkBytes in interface StreamConfigOrBuilder
        Returns:
        The storageBufferQueueHighWatermarkBytes.

      • getStorageBufferQueueHighWatermarkBytesOrBuilder

        public com.google.protobuf.UInt64ValueOrBuilder getStorageBufferQueueHighWatermarkBytesOrBuilder()
         The maximum amount that can be queued for writing to storage, above which the
 source is requested to pause. If unset, defaults to the same value as
 ``memory_buffer_bytes_limit``.
 For example, assuming the recipient is not consuming data at all, if
 ``memory_buffer_bytes_limit`` was 32MiB, and ``storage_buffer_queue_high_watermark_bytes``
 was 64MiB, and the filesystem is backed up so writes are not occurring promptly,
 then:
 * Any request less than 32MiB will eventually pass through without ever attempting
   to write to disk.
 * Any request with over 32MiB buffered will start trying to write to disk.
   If it reaches (32+64)MiB buffered in memory (write to disk isn't keeping up), a high
   watermark signal is sent to the source.
 * Any stream whose total size exceeds
   ``memory_buffer_bytes_limit + storage_buffer_bytes_limit`` will provoke an error.
   (Note, if the recipient *is* consuming data then it is possible for such an
   oversized request to pass through the buffer filter, provided the recipient
   isn't consuming data too slowly.)
 The low watermark signal is sent when the memory buffer is at size
 ``memory_buffer_bytes_limit + (storage_buffer_queue_high_watermark_bytes / 2)``.
        .google.protobuf.UInt64Value storage_buffer_queue_high_watermark_bytes = 4;
        Specified by:
        getStorageBufferQueueHighWatermarkBytesOrBuilder in interface StreamConfigOrBuilder

      • 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 StreamConfig parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamConfig parseFrom​(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamConfig parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamConfig parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamConfig parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamConfig parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

        public StreamConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public StreamConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected StreamConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static StreamConfig getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<StreamConfig> 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 StreamConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder