Package io.envoyproxy.envoy.extensions.compression.gzip.compressor.v3

Interface GzipOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Gzip, Gzip.Builder
    public interface GzipOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.UInt32Value getChunkSize()
      Value for Zlib's next output buffer.
      com.google.protobuf.UInt32ValueOrBuilder getChunkSizeOrBuilder()
      Value for Zlib's next output buffer.
      Gzip.CompressionLevel getCompressionLevel()
      A value used for selecting the zlib compression level.
      int getCompressionLevelValue()
      A value used for selecting the zlib compression level.
      Gzip.CompressionStrategy getCompressionStrategy()
      A value used for selecting the zlib compression strategy which is directly related to the characteristics of the content.
      int getCompressionStrategyValue()
      A value used for selecting the zlib compression strategy which is directly related to the characteristics of the content.
      com.google.protobuf.UInt32Value getMemoryLevel()
      Value from 1 to 9 that controls the amount of internal memory used by zlib.
      com.google.protobuf.UInt32ValueOrBuilder getMemoryLevelOrBuilder()
      Value from 1 to 9 that controls the amount of internal memory used by zlib.
      com.google.protobuf.UInt32Value getWindowBits()
      Value from 9 to 15 that represents the base two logarithmic of the compressor's window size.
      com.google.protobuf.UInt32ValueOrBuilder getWindowBitsOrBuilder()
      Value from 9 to 15 that represents the base two logarithmic of the compressor's window size.
      boolean hasChunkSize()
      Value for Zlib's next output buffer.
      boolean hasMemoryLevel()
      Value from 1 to 9 that controls the amount of internal memory used by zlib.
      boolean hasWindowBits()
      Value from 9 to 15 that represents the base two logarithmic of the compressor's window size.

      • 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 Detail

      • hasMemoryLevel

        boolean hasMemoryLevel()
         Value from 1 to 9 that controls the amount of internal memory used by zlib. Higher values
 use more memory, but are faster and produce better compression results. The default value is 5.
        .google.protobuf.UInt32Value memory_level = 1 [(.validate.rules) = { ... }
        Returns:
        Whether the memoryLevel field is set.

      • getMemoryLevel

        com.google.protobuf.UInt32Value getMemoryLevel()
         Value from 1 to 9 that controls the amount of internal memory used by zlib. Higher values
 use more memory, but are faster and produce better compression results. The default value is 5.
        .google.protobuf.UInt32Value memory_level = 1 [(.validate.rules) = { ... }
        Returns:
        The memoryLevel.

      • getMemoryLevelOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getMemoryLevelOrBuilder()
         Value from 1 to 9 that controls the amount of internal memory used by zlib. Higher values
 use more memory, but are faster and produce better compression results. The default value is 5.
        .google.protobuf.UInt32Value memory_level = 1 [(.validate.rules) = { ... }

      • getCompressionLevelValue

        int getCompressionLevelValue()
         A value used for selecting the zlib compression level. This setting will affect speed and
 amount of compression applied to the content. "BEST_COMPRESSION" provides higher compression
 at the cost of higher latency and is equal to "COMPRESSION_LEVEL_9". "BEST_SPEED" provides
 lower compression with minimum impact on response time, the same as "COMPRESSION_LEVEL_1".
 "DEFAULT_COMPRESSION" provides an optimal result between speed and compression. According
 to zlib's manual this level gives the same result as "COMPRESSION_LEVEL_6".
 This field will be set to "DEFAULT_COMPRESSION" if not specified.
        .envoy.extensions.compression.gzip.compressor.v3.Gzip.CompressionLevel compression_level = 2 [(.validate.rules) = { ... }
        Returns:
        The enum numeric value on the wire for compressionLevel.

      • getCompressionLevel

        Gzip.CompressionLevel getCompressionLevel()
         A value used for selecting the zlib compression level. This setting will affect speed and
 amount of compression applied to the content. "BEST_COMPRESSION" provides higher compression
 at the cost of higher latency and is equal to "COMPRESSION_LEVEL_9". "BEST_SPEED" provides
 lower compression with minimum impact on response time, the same as "COMPRESSION_LEVEL_1".
 "DEFAULT_COMPRESSION" provides an optimal result between speed and compression. According
 to zlib's manual this level gives the same result as "COMPRESSION_LEVEL_6".
 This field will be set to "DEFAULT_COMPRESSION" if not specified.
        .envoy.extensions.compression.gzip.compressor.v3.Gzip.CompressionLevel compression_level = 2 [(.validate.rules) = { ... }
        Returns:
        The compressionLevel.

      • getCompressionStrategyValue

        int getCompressionStrategyValue()
         A value used for selecting the zlib compression strategy which is directly related to the
 characteristics of the content. Most of the time "DEFAULT_STRATEGY" will be the best choice,
 which is also the default value for the parameter, though there are situations when
 changing this parameter might produce better results. For example, run-length encoding (RLE)
 is typically used when the content is known for having sequences which same data occurs many
 consecutive times. For more information about each strategy, please refer to zlib manual.
        .envoy.extensions.compression.gzip.compressor.v3.Gzip.CompressionStrategy compression_strategy = 3 [(.validate.rules) = { ... }
        Returns:
        The enum numeric value on the wire for compressionStrategy.

      • getCompressionStrategy

        Gzip.CompressionStrategy getCompressionStrategy()
         A value used for selecting the zlib compression strategy which is directly related to the
 characteristics of the content. Most of the time "DEFAULT_STRATEGY" will be the best choice,
 which is also the default value for the parameter, though there are situations when
 changing this parameter might produce better results. For example, run-length encoding (RLE)
 is typically used when the content is known for having sequences which same data occurs many
 consecutive times. For more information about each strategy, please refer to zlib manual.
        .envoy.extensions.compression.gzip.compressor.v3.Gzip.CompressionStrategy compression_strategy = 3 [(.validate.rules) = { ... }
        Returns:
        The compressionStrategy.

      • hasWindowBits

        boolean hasWindowBits()
         Value from 9 to 15 that represents the base two logarithmic of the compressor's window size.
 Larger window results in better compression at the expense of memory usage. The default is 12
 which will produce a 4096 bytes window. For more details about this parameter, please refer to
 zlib manual > deflateInit2.
        .google.protobuf.UInt32Value window_bits = 4 [(.validate.rules) = { ... }
        Returns:
        Whether the windowBits field is set.

      • getWindowBits

        com.google.protobuf.UInt32Value getWindowBits()
         Value from 9 to 15 that represents the base two logarithmic of the compressor's window size.
 Larger window results in better compression at the expense of memory usage. The default is 12
 which will produce a 4096 bytes window. For more details about this parameter, please refer to
 zlib manual > deflateInit2.
        .google.protobuf.UInt32Value window_bits = 4 [(.validate.rules) = { ... }
        Returns:
        The windowBits.

      • getWindowBitsOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getWindowBitsOrBuilder()
         Value from 9 to 15 that represents the base two logarithmic of the compressor's window size.
 Larger window results in better compression at the expense of memory usage. The default is 12
 which will produce a 4096 bytes window. For more details about this parameter, please refer to
 zlib manual > deflateInit2.
        .google.protobuf.UInt32Value window_bits = 4 [(.validate.rules) = { ... }

      • hasChunkSize

        boolean hasChunkSize()
         Value for Zlib's next output buffer. If not set, defaults to 4096.
 See https://www.zlib.net/manual.html for more details. Also see
 https://github.com/envoyproxy/envoy/issues/8448 for context on this filter's performance.
        .google.protobuf.UInt32Value chunk_size = 5 [(.validate.rules) = { ... }
        Returns:
        Whether the chunkSize field is set.

      • getChunkSize

        com.google.protobuf.UInt32Value getChunkSize()
         Value for Zlib's next output buffer. If not set, defaults to 4096.
 See https://www.zlib.net/manual.html for more details. Also see
 https://github.com/envoyproxy/envoy/issues/8448 for context on this filter's performance.
        .google.protobuf.UInt32Value chunk_size = 5 [(.validate.rules) = { ... }
        Returns:
        The chunkSize.

      • getChunkSizeOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getChunkSizeOrBuilder()
         Value for Zlib's next output buffer. If not set, defaults to 4096.
 See https://www.zlib.net/manual.html for more details. Also see
 https://github.com/envoyproxy/envoy/issues/8448 for context on this filter's performance.
        .google.protobuf.UInt32Value chunk_size = 5 [(.validate.rules) = { ... }