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

Class Gzip

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.compression.gzip.compressor.v3.Gzip
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GzipOrBuilder, Serializable
public final class Gzip extends com.google.protobuf.GeneratedMessageV3 implements GzipOrBuilder
 [#next-free-field: 6]
Protobuf type envoy.extensions.compression.gzip.compressor.v3.Gzip
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Gzip.Builder
    [#next-free-field: 6]
    static enum 
    Gzip.CompressionLevel
    Protobuf enum envoy.extensions.compression.gzip.compressor.v3.Gzip.CompressionLevel
    static enum 
    Gzip.CompressionStrategy
    All the values of this enumeration translate directly to zlib's compression strategies.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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 Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CHUNK_SIZE_FIELD_NUMBER
     
    static final int
    COMPRESSION_LEVEL_FIELD_NUMBER
     
    static final int
    COMPRESSION_STRATEGY_FIELD_NUMBER
     
    static final int
    MEMORY_LEVEL_FIELD_NUMBER
     
    static final int
    WINDOW_BITS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    static Gzip
    getDefaultInstance()
     
    Gzip
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.Parser<Gzip>
    getParserForType()
     
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    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.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Gzip.Builder
    newBuilder()
     
    static Gzip.Builder
    newBuilder(Gzip prototype)
     
    Gzip.Builder
    newBuilderForType()
     
    protected Gzip.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Gzip
    parseDelimitedFrom(InputStream input)
     
    static Gzip
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Gzip
    parseFrom(byte[] data)
     
    static Gzip
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Gzip
    parseFrom(com.google.protobuf.ByteString data)
     
    static Gzip
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Gzip
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Gzip
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Gzip
    parseFrom(InputStream input)
     
    static Gzip
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Gzip
    parseFrom(ByteBuffer data)
     
    static Gzip
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Gzip>
    parser()
     
    Gzip.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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 class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    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, getUnknownFields, hasField, hasOneof

  • Field Details

    • MEMORY_LEVEL_FIELD_NUMBER

      public static final int MEMORY_LEVEL_FIELD_NUMBER
      See Also:

    • COMPRESSION_LEVEL_FIELD_NUMBER

      public static final int COMPRESSION_LEVEL_FIELD_NUMBER
      See Also:

    • COMPRESSION_STRATEGY_FIELD_NUMBER

      public static final int COMPRESSION_STRATEGY_FIELD_NUMBER
      See Also:

    • WINDOW_BITS_FIELD_NUMBER

      public static final int WINDOW_BITS_FIELD_NUMBER
      See Also:

    • CHUNK_SIZE_FIELD_NUMBER

      public static final int CHUNK_SIZE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • hasMemoryLevel

      public 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) = { ... }
      Specified by:
      hasMemoryLevel in interface GzipOrBuilder
      Returns:
      Whether the memoryLevel field is set.

    • getMemoryLevel

      public 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) = { ... }
      Specified by:
      getMemoryLevel in interface GzipOrBuilder
      Returns:
      The memoryLevel.

    • getMemoryLevelOrBuilder

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

    • getCompressionLevelValue

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

    • getCompressionLevel

      public 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) = { ... }
      Specified by:
      getCompressionLevel in interface GzipOrBuilder
      Returns:
      The compressionLevel.

    • getCompressionStrategyValue

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

    • getCompressionStrategy

      public 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) = { ... }
      Specified by:
      getCompressionStrategy in interface GzipOrBuilder
      Returns:
      The compressionStrategy.

    • hasWindowBits

      public 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) = { ... }
      Specified by:
      hasWindowBits in interface GzipOrBuilder
      Returns:
      Whether the windowBits field is set.

    • getWindowBits

      public 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) = { ... }
      Specified by:
      getWindowBits in interface GzipOrBuilder
      Returns:
      The windowBits.

    • getWindowBitsOrBuilder

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

    • hasChunkSize

      public 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) = { ... }
      Specified by:
      hasChunkSize in interface GzipOrBuilder
      Returns:
      Whether the chunkSize field is set.

    • getChunkSize

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

    • getChunkSizeOrBuilder

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Gzip parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Gzip parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Gzip parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Gzip parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Gzip parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Gzip.Builder newBuilder()

    • newBuilder

      public static Gzip.Builder newBuilder(Gzip prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Gzip getDefaultInstance()

    • parser

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

    • getParserForType

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