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

Interface ZstdOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.UInt32Value
    getChunkSize()
    Value for compressor's next output buffer.
    com.google.protobuf.UInt32ValueOrBuilder
    getChunkSizeOrBuilder()
    Value for compressor's next output buffer.
    com.google.protobuf.UInt32Value
    getCompressionLevel()
    Set compression parameters according to pre-defined compression level table.
    com.google.protobuf.UInt32ValueOrBuilder
    getCompressionLevelOrBuilder()
    Set compression parameters according to pre-defined compression level table.
    DataSource
    getDictionary()
    A dictionary for compression.
    DataSourceOrBuilder
    getDictionaryOrBuilder()
    A dictionary for compression.
    boolean
    getEnableChecksum()
    A 32-bits checksum of content is written at end of frame.
    Zstd.Strategy
    getStrategy()
    The higher the value of selected strategy, the more complex it is, resulting in stronger and slower compression.
    int
    getStrategyValue()
    The higher the value of selected strategy, the more complex it is, resulting in stronger and slower compression.
    boolean
    hasChunkSize()
    Value for compressor's next output buffer.
    boolean
    hasCompressionLevel()
    Set compression parameters according to pre-defined compression level table.
    boolean
    hasDictionary()
    A dictionary for compression.

    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

    • hasCompressionLevel

      boolean hasCompressionLevel()
       Set compression parameters according to pre-defined compression level table.
 Note that exact compression parameters are dynamically determined,
 depending on both compression level and source content size (when known).
 Value 0 means default, and default level is 3.
 Setting a level does not automatically set all other compression parameters
 to default. Setting this will however eventually dynamically impact the compression
 parameters which have not been manually set. The manually set
 ones will 'stick'.
      .google.protobuf.UInt32Value compression_level = 1;
      Returns:
      Whether the compressionLevel field is set.

    • getCompressionLevel

      com.google.protobuf.UInt32Value getCompressionLevel()
       Set compression parameters according to pre-defined compression level table.
 Note that exact compression parameters are dynamically determined,
 depending on both compression level and source content size (when known).
 Value 0 means default, and default level is 3.
 Setting a level does not automatically set all other compression parameters
 to default. Setting this will however eventually dynamically impact the compression
 parameters which have not been manually set. The manually set
 ones will 'stick'.
      .google.protobuf.UInt32Value compression_level = 1;
      Returns:
      The compressionLevel.

    • getCompressionLevelOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getCompressionLevelOrBuilder()
       Set compression parameters according to pre-defined compression level table.
 Note that exact compression parameters are dynamically determined,
 depending on both compression level and source content size (when known).
 Value 0 means default, and default level is 3.
 Setting a level does not automatically set all other compression parameters
 to default. Setting this will however eventually dynamically impact the compression
 parameters which have not been manually set. The manually set
 ones will 'stick'.
      .google.protobuf.UInt32Value compression_level = 1;

    • getEnableChecksum

      boolean getEnableChecksum()
       A 32-bits checksum of content is written at end of frame. If not set, defaults to false.
      bool enable_checksum = 2;
      Returns:
      The enableChecksum.

    • getStrategyValue

      int getStrategyValue()
       The higher the value of selected strategy, the more complex it is,
 resulting in stronger and slower compression.
 Special: value 0 means "use default strategy".
      .envoy.extensions.compression.zstd.compressor.v3.Zstd.Strategy strategy = 3 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for strategy.

    • getStrategy

      Zstd.Strategy getStrategy()
       The higher the value of selected strategy, the more complex it is,
 resulting in stronger and slower compression.
 Special: value 0 means "use default strategy".
      .envoy.extensions.compression.zstd.compressor.v3.Zstd.Strategy strategy = 3 [(.validate.rules) = { ... }
      Returns:
      The strategy.

    • hasDictionary

      boolean hasDictionary()
       A dictionary for compression. Zstd offers dictionary compression, which greatly improves
 efficiency on small files and messages. Each dictionary will be generated with a dictionary ID
 that can be used to search the same dictionary during decompression.
 Please refer to `zstd manual <https://github.com/facebook/zstd/blob/dev/programs/zstd.1.md#dictionary-builder>`_
 to train a specific dictionary for compression.
      .envoy.config.core.v3.DataSource dictionary = 4;
      Returns:
      Whether the dictionary field is set.

    • getDictionary

      DataSource getDictionary()
       A dictionary for compression. Zstd offers dictionary compression, which greatly improves
 efficiency on small files and messages. Each dictionary will be generated with a dictionary ID
 that can be used to search the same dictionary during decompression.
 Please refer to `zstd manual <https://github.com/facebook/zstd/blob/dev/programs/zstd.1.md#dictionary-builder>`_
 to train a specific dictionary for compression.
      .envoy.config.core.v3.DataSource dictionary = 4;
      Returns:
      The dictionary.

    • getDictionaryOrBuilder

      DataSourceOrBuilder getDictionaryOrBuilder()
       A dictionary for compression. Zstd offers dictionary compression, which greatly improves
 efficiency on small files and messages. Each dictionary will be generated with a dictionary ID
 that can be used to search the same dictionary during decompression.
 Please refer to `zstd manual <https://github.com/facebook/zstd/blob/dev/programs/zstd.1.md#dictionary-builder>`_
 to train a specific dictionary for compression.
      .envoy.config.core.v3.DataSource dictionary = 4;

    • hasChunkSize

      boolean hasChunkSize()
       Value for compressor's next output buffer. If not set, defaults to 4096.
      .google.protobuf.UInt32Value chunk_size = 5 [(.validate.rules) = { ... }
      Returns:
      Whether the chunkSize field is set.

    • getChunkSize

      com.google.protobuf.UInt32Value getChunkSize()
       Value for compressor's next output buffer. If not set, defaults to 4096.
      .google.protobuf.UInt32Value chunk_size = 5 [(.validate.rules) = { ... }
      Returns:
      The chunkSize.

    • getChunkSizeOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getChunkSizeOrBuilder()
       Value for compressor's next output buffer. If not set, defaults to 4096.
      .google.protobuf.UInt32Value chunk_size = 5 [(.validate.rules) = { ... }