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

Interface StreamConfigOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    BufferBehavior
    getBehavior()
    Whether to bypass / stream / fully buffer / etc.
    BufferBehaviorOrBuilder
    getBehaviorOrBuilder()
    Whether to bypass / stream / fully buffer / etc.
    com.google.protobuf.UInt64Value
    getMemoryBufferBytesLimit()
    The amount stored in the memory buffer before buffering to disk.
    com.google.protobuf.UInt64ValueOrBuilder
    getMemoryBufferBytesLimitOrBuilder()
    The amount stored in the memory buffer before buffering to disk.
    com.google.protobuf.UInt64Value
    getStorageBufferBytesLimit()
    The maximum storage (excluding memory) to be buffered in this filter.
    com.google.protobuf.UInt64ValueOrBuilder
    getStorageBufferBytesLimitOrBuilder()
    The maximum storage (excluding memory) to be buffered in this filter.
    com.google.protobuf.UInt64Value
    getStorageBufferQueueHighWatermarkBytes()
    The maximum amount that can be queued for writing to storage, above which the source is requested to pause.
    com.google.protobuf.UInt64ValueOrBuilder
    getStorageBufferQueueHighWatermarkBytesOrBuilder()
    The maximum amount that can be queued for writing to storage, above which the source is requested to pause.
    boolean
    hasBehavior()
    Whether to bypass / stream / fully buffer / etc.
    boolean
    hasMemoryBufferBytesLimit()
    The amount stored in the memory buffer before buffering to disk.
    boolean
    hasStorageBufferBytesLimit()
    The maximum storage (excluding memory) to be buffered in this filter.
    boolean
    hasStorageBufferQueueHighWatermarkBytes()
    The maximum amount that can be queued for writing to storage, above which the source is requested to pause.

    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

    • hasBehavior

      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;
      Returns:
      Whether the behavior field is set.

    • getBehavior

      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;
      Returns:
      The behavior.

    • getBehaviorOrBuilder

      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;

    • hasMemoryBufferBytesLimit

      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) = { ... }
      Returns:
      Whether the memoryBufferBytesLimit field is set.

    • getMemoryBufferBytesLimit

      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) = { ... }
      Returns:
      The memoryBufferBytesLimit.

    • getMemoryBufferBytesLimitOrBuilder

      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) = { ... }

    • hasStorageBufferBytesLimit

      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;
      Returns:
      Whether the storageBufferBytesLimit field is set.

    • getStorageBufferBytesLimit

      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;
      Returns:
      The storageBufferBytesLimit.

    • getStorageBufferBytesLimitOrBuilder

      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;

    • hasStorageBufferQueueHighWatermarkBytes

      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;
      Returns:
      Whether the storageBufferQueueHighWatermarkBytes field is set.

    • getStorageBufferQueueHighWatermarkBytes

      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;
      Returns:
      The storageBufferQueueHighWatermarkBytes.

    • getStorageBufferQueueHighWatermarkBytesOrBuilder

      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;