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

Class Gzip

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.compression.gzip.decompressor.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
Protobuf type envoy.extensions.compression.gzip.decompressor.v3.Gzip
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Gzip.Builder
    Protobuf type envoy.extensions.compression.gzip.decompressor.v3.Gzip

    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
    MAX_INFLATE_RATIO_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 decompressor output buffer.
    com.google.protobuf.UInt32ValueOrBuilder
    getChunkSizeOrBuilder()
    Value for zlib's decompressor output buffer.
    static Gzip
    getDefaultInstance()
     
    Gzip
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.UInt32Value
    getMaxInflateRatio()
    An upper bound to the number of times the output buffer is allowed to be bigger than the size of the accumulated input.
    com.google.protobuf.UInt32ValueOrBuilder
    getMaxInflateRatioOrBuilder()
    An upper bound to the number of times the output buffer is allowed to be bigger than the size of the accumulated input.
    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 decompressor's window size.
    com.google.protobuf.UInt32ValueOrBuilder
    getWindowBitsOrBuilder()
    Value from 9 to 15 that represents the base two logarithmic of the decompressor's window size.
    boolean
    hasChunkSize()
    Value for zlib's decompressor output buffer.
    int
    hashCode()
     
    boolean
    hasMaxInflateRatio()
    An upper bound to the number of times the output buffer is allowed to be bigger than the size of the accumulated input.
    boolean
    hasWindowBits()
    Value from 9 to 15 that represents the base two logarithmic of the decompressor'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

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

    • MAX_INFLATE_RATIO_FIELD_NUMBER

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

    • hasWindowBits

      public boolean hasWindowBits()
       Value from 9 to 15 that represents the base two logarithmic of the decompressor's window size.
 The decompression window size needs to be equal or larger than the compression window size.
 The default window size is 15.
 This is so that the decompressor can decompress a response compressed by a compressor with any compression window size.
 For more details about this parameter, please refer to `zlib manual <https://www.zlib.net/manual.html>`_ > inflateInit2.
      .google.protobuf.UInt32Value window_bits = 1 [(.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 decompressor's window size.
 The decompression window size needs to be equal or larger than the compression window size.
 The default window size is 15.
 This is so that the decompressor can decompress a response compressed by a compressor with any compression window size.
 For more details about this parameter, please refer to `zlib manual <https://www.zlib.net/manual.html>`_ > inflateInit2.
      .google.protobuf.UInt32Value window_bits = 1 [(.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 decompressor's window size.
 The decompression window size needs to be equal or larger than the compression window size.
 The default window size is 15.
 This is so that the decompressor can decompress a response compressed by a compressor with any compression window size.
 For more details about this parameter, please refer to `zlib manual <https://www.zlib.net/manual.html>`_ > inflateInit2.
      .google.protobuf.UInt32Value window_bits = 1 [(.validate.rules) = { ... }
      Specified by:
      getWindowBitsOrBuilder in interface GzipOrBuilder

    • hasChunkSize

      public boolean hasChunkSize()
       Value for zlib's decompressor output buffer. If not set, defaults to 4096.
 See https://www.zlib.net/manual.html for more details.
      .google.protobuf.UInt32Value chunk_size = 2 [(.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 decompressor output buffer. If not set, defaults to 4096.
 See https://www.zlib.net/manual.html for more details.
      .google.protobuf.UInt32Value chunk_size = 2 [(.validate.rules) = { ... }
      Specified by:
      getChunkSize in interface GzipOrBuilder
      Returns:
      The chunkSize.

    • getChunkSizeOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getChunkSizeOrBuilder()
       Value for zlib's decompressor output buffer. If not set, defaults to 4096.
 See https://www.zlib.net/manual.html for more details.
      .google.protobuf.UInt32Value chunk_size = 2 [(.validate.rules) = { ... }
      Specified by:
      getChunkSizeOrBuilder in interface GzipOrBuilder

    • hasMaxInflateRatio

      public boolean hasMaxInflateRatio()
       An upper bound to the number of times the output buffer is allowed to be bigger than the size of
 the accumulated input. This value is used to prevent decompression bombs. If not set, defaults to 100.
 [#comment:TODO(rojkov): Re-design the Decompressor interface to handle compression bombs gracefully instead of this quick solution.
 See https://github.com/envoyproxy/envoy/commit/d4c39e635603e2f23e1e08ddecf5a5fb5a706338 for details.]
      .google.protobuf.UInt32Value max_inflate_ratio = 3 [(.validate.rules) = { ... }
      Specified by:
      hasMaxInflateRatio in interface GzipOrBuilder
      Returns:
      Whether the maxInflateRatio field is set.

    • getMaxInflateRatio

      public com.google.protobuf.UInt32Value getMaxInflateRatio()
       An upper bound to the number of times the output buffer is allowed to be bigger than the size of
 the accumulated input. This value is used to prevent decompression bombs. If not set, defaults to 100.
 [#comment:TODO(rojkov): Re-design the Decompressor interface to handle compression bombs gracefully instead of this quick solution.
 See https://github.com/envoyproxy/envoy/commit/d4c39e635603e2f23e1e08ddecf5a5fb5a706338 for details.]
      .google.protobuf.UInt32Value max_inflate_ratio = 3 [(.validate.rules) = { ... }
      Specified by:
      getMaxInflateRatio in interface GzipOrBuilder
      Returns:
      The maxInflateRatio.

    • getMaxInflateRatioOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getMaxInflateRatioOrBuilder()
       An upper bound to the number of times the output buffer is allowed to be bigger than the size of
 the accumulated input. This value is used to prevent decompression bombs. If not set, defaults to 100.
 [#comment:TODO(rojkov): Re-design the Decompressor interface to handle compression bombs gracefully instead of this quick solution.
 See https://github.com/envoyproxy/envoy/commit/d4c39e635603e2f23e1e08ddecf5a5fb5a706338 for details.]
      .google.protobuf.UInt32Value max_inflate_ratio = 3 [(.validate.rules) = { ... }
      Specified by:
      getMaxInflateRatioOrBuilder 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