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

Class Zstd

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ZstdOrBuilder, Serializable
    public final class Zstd
extends com.google.protobuf.GeneratedMessageV3
implements ZstdOrBuilder
     [#next-free-field: 6]
    Protobuf type envoy.extensions.compression.zstd.compressor.v3.Zstd
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Zstd.Builder
      [#next-free-field: 6]
      static class  Zstd.Strategy
      Reference to http://facebook.github.io/zstd/zstd_manual.html

      • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      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.
      static Zstd getDefaultInstance()  
      Zstd getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      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.
      com.google.protobuf.Parser<Zstd> getParserForType()  
      int getSerializedSize()  
      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.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      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.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Zstd.Builder newBuilder()  
      static Zstd.Builder newBuilder​(Zstd prototype)  
      Zstd.Builder newBuilderForType()  
      protected Zstd.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Zstd parseDelimitedFrom​(InputStream input)  
      static Zstd parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Zstd parseFrom​(byte[] data)  
      static Zstd parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Zstd parseFrom​(com.google.protobuf.ByteString data)  
      static Zstd parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Zstd parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Zstd parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Zstd parseFrom​(InputStream input)  
      static Zstd parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Zstd parseFrom​(ByteBuffer data)  
      static Zstd parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Zstd> parser()  
      Zstd.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, isStringEmpty, 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 interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Field Detail

      • COMPRESSION_LEVEL_FIELD_NUMBER

        public static final int COMPRESSION_LEVEL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_CHECKSUM_FIELD_NUMBER

        public static final int ENABLE_CHECKSUM_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DICTIONARY_FIELD_NUMBER

        public static final int DICTIONARY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CHUNK_SIZE_FIELD_NUMBER

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

      • hasCompressionLevel

        public 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;
        Specified by:
        hasCompressionLevel in interface ZstdOrBuilder
        Returns:
        Whether the compressionLevel field is set.

      • getCompressionLevel

        public 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;
        Specified by:
        getCompressionLevel in interface ZstdOrBuilder
        Returns:
        The compressionLevel.

      • getCompressionLevelOrBuilder

        public 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;
        Specified by:
        getCompressionLevelOrBuilder in interface ZstdOrBuilder

      • getEnableChecksum

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

      • getStrategyValue

        public 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) = { ... }
        Specified by:
        getStrategyValue in interface ZstdOrBuilder
        Returns:
        The enum numeric value on the wire for strategy.

      • getStrategy

        public 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) = { ... }
        Specified by:
        getStrategy in interface ZstdOrBuilder
        Returns:
        The strategy.

      • hasDictionary

        public 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;
        Specified by:
        hasDictionary in interface ZstdOrBuilder
        Returns:
        Whether the dictionary field is set.

      • getDictionary

        public 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;
        Specified by:
        getDictionary in interface ZstdOrBuilder
        Returns:
        The dictionary.

      • getDictionaryOrBuilder

        public 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;
        Specified by:
        getDictionaryOrBuilder in interface ZstdOrBuilder

      • hasChunkSize

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

      • getChunkSize

        public 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) = { ... }
        Specified by:
        getChunkSize in interface ZstdOrBuilder
        Returns:
        The chunkSize.

      • getChunkSizeOrBuilder

        public 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) = { ... }
        Specified by:
        getChunkSizeOrBuilder in interface ZstdOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Zstd getDefaultInstance()

      • parser

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

      • getParserForType

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