Package io.envoyproxy.envoy.config.filter.http.compressor.v2

Class Compressor

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CompressorOrBuilder, Serializable
    public final class Compressor
extends com.google.protobuf.GeneratedMessageV3
implements CompressorOrBuilder
     [#next-free-field: 6]
    Protobuf type envoy.config.filter.http.compressor.v2.Compressor
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Compressor.Builder
      [#next-free-field: 6]

      • 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 getContentLength()
      Minimum response length, in bytes, which will trigger compression.
      com.google.protobuf.UInt32ValueOrBuilder getContentLengthOrBuilder()
      Minimum response length, in bytes, which will trigger compression.
      String getContentType​(int index)
      Set of strings that allows specifying which mime-types yield compression; e.g., application/json, text/html, etc.
      com.google.protobuf.ByteString getContentTypeBytes​(int index)
      Set of strings that allows specifying which mime-types yield compression; e.g., application/json, text/html, etc.
      int getContentTypeCount()
      Set of strings that allows specifying which mime-types yield compression; e.g., application/json, text/html, etc.
      com.google.protobuf.ProtocolStringList getContentTypeList()
      Set of strings that allows specifying which mime-types yield compression; e.g., application/json, text/html, etc.
      static Compressor getDefaultInstance()  
      Compressor getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      boolean getDisableOnEtagHeader()
      If true, disables compression when the response contains an etag header.
      com.google.protobuf.Parser<Compressor> getParserForType()  
      boolean getRemoveAcceptEncodingHeader()
      If true, removes accept-encoding from the request headers before dispatching it to the upstream so that responses do not get compressed before reaching the filter. .. attention: To avoid interfering with other compression filters in the same chain use this option in the filter closest to the upstream.
      RuntimeFeatureFlag getRuntimeEnabled()
      Runtime flag that controls whether the filter is enabled or not.
      RuntimeFeatureFlagOrBuilder getRuntimeEnabledOrBuilder()
      Runtime flag that controls whether the filter is enabled or not.
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasContentLength()
      Minimum response length, in bytes, which will trigger compression.
      int hashCode()  
      boolean hasRuntimeEnabled()
      Runtime flag that controls whether the filter is enabled or not.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Compressor.Builder newBuilder()  
      static Compressor.Builder newBuilder​(Compressor prototype)  
      Compressor.Builder newBuilderForType()  
      protected Compressor.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Compressor parseDelimitedFrom​(InputStream input)  
      static Compressor parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Compressor parseFrom​(byte[] data)  
      static Compressor parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Compressor parseFrom​(com.google.protobuf.ByteString data)  
      static Compressor parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Compressor parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Compressor parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Compressor parseFrom​(InputStream input)  
      static Compressor parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Compressor parseFrom​(ByteBuffer data)  
      static Compressor parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Compressor> parser()  
      Compressor.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

      • CONTENT_LENGTH_FIELD_NUMBER

        public static final int CONTENT_LENGTH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONTENT_TYPE_FIELD_NUMBER

        public static final int CONTENT_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_ON_ETAG_HEADER_FIELD_NUMBER

        public static final int DISABLE_ON_ETAG_HEADER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REMOVE_ACCEPT_ENCODING_HEADER_FIELD_NUMBER

        public static final int REMOVE_ACCEPT_ENCODING_HEADER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUNTIME_ENABLED_FIELD_NUMBER

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

      • hasContentLength

        public boolean hasContentLength()
         Minimum response length, in bytes, which will trigger compression. The default value is 30.
        .google.protobuf.UInt32Value content_length = 1;
        Specified by:
        hasContentLength in interface CompressorOrBuilder
        Returns:
        Whether the contentLength field is set.

      • getContentLength

        public com.google.protobuf.UInt32Value getContentLength()
         Minimum response length, in bytes, which will trigger compression. The default value is 30.
        .google.protobuf.UInt32Value content_length = 1;
        Specified by:
        getContentLength in interface CompressorOrBuilder
        Returns:
        The contentLength.

      • getContentLengthOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getContentLengthOrBuilder()
         Minimum response length, in bytes, which will trigger compression. The default value is 30.
        .google.protobuf.UInt32Value content_length = 1;
        Specified by:
        getContentLengthOrBuilder in interface CompressorOrBuilder

      • getContentTypeList

        public com.google.protobuf.ProtocolStringList getContentTypeList()
         Set of strings that allows specifying which mime-types yield compression; e.g.,
 application/json, text/html, etc. When this field is not defined, compression will be applied
 to the following mime-types: "application/javascript", "application/json",
 "application/xhtml+xml", "image/svg+xml", "text/css", "text/html", "text/plain", "text/xml"
 and their synonyms.
        repeated string content_type = 2;
        Specified by:
        getContentTypeList in interface CompressorOrBuilder
        Returns:
        A list containing the contentType.

      • getContentTypeCount

        public int getContentTypeCount()
         Set of strings that allows specifying which mime-types yield compression; e.g.,
 application/json, text/html, etc. When this field is not defined, compression will be applied
 to the following mime-types: "application/javascript", "application/json",
 "application/xhtml+xml", "image/svg+xml", "text/css", "text/html", "text/plain", "text/xml"
 and their synonyms.
        repeated string content_type = 2;
        Specified by:
        getContentTypeCount in interface CompressorOrBuilder
        Returns:
        The count of contentType.

      • getContentType

        public String getContentType​(int index)
         Set of strings that allows specifying which mime-types yield compression; e.g.,
 application/json, text/html, etc. When this field is not defined, compression will be applied
 to the following mime-types: "application/javascript", "application/json",
 "application/xhtml+xml", "image/svg+xml", "text/css", "text/html", "text/plain", "text/xml"
 and their synonyms.
        repeated string content_type = 2;
        Specified by:
        getContentType in interface CompressorOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The contentType at the given index.

      • getContentTypeBytes

        public com.google.protobuf.ByteString getContentTypeBytes​(int index)
         Set of strings that allows specifying which mime-types yield compression; e.g.,
 application/json, text/html, etc. When this field is not defined, compression will be applied
 to the following mime-types: "application/javascript", "application/json",
 "application/xhtml+xml", "image/svg+xml", "text/css", "text/html", "text/plain", "text/xml"
 and their synonyms.
        repeated string content_type = 2;
        Specified by:
        getContentTypeBytes in interface CompressorOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the contentType at the given index.

      • getDisableOnEtagHeader

        public boolean getDisableOnEtagHeader()
         If true, disables compression when the response contains an etag header. When it is false, the
 filter will preserve weak etags and remove the ones that require strong validation.
        bool disable_on_etag_header = 3;
        Specified by:
        getDisableOnEtagHeader in interface CompressorOrBuilder
        Returns:
        The disableOnEtagHeader.

      • getRemoveAcceptEncodingHeader

        public boolean getRemoveAcceptEncodingHeader()
         If true, removes accept-encoding from the request headers before dispatching it to the upstream
 so that responses do not get compressed before reaching the filter.
 .. attention:
    To avoid interfering with other compression filters in the same chain use this option in
    the filter closest to the upstream.
        bool remove_accept_encoding_header = 4;
        Specified by:
        getRemoveAcceptEncodingHeader in interface CompressorOrBuilder
        Returns:
        The removeAcceptEncodingHeader.

      • hasRuntimeEnabled

        public boolean hasRuntimeEnabled()
         Runtime flag that controls whether the filter is enabled or not. If set to false, the
 filter will operate as a pass-through filter. If not specified, defaults to enabled.
        .envoy.api.v2.core.RuntimeFeatureFlag runtime_enabled = 5;
        Specified by:
        hasRuntimeEnabled in interface CompressorOrBuilder
        Returns:
        Whether the runtimeEnabled field is set.

      • getRuntimeEnabled

        public RuntimeFeatureFlag getRuntimeEnabled()
         Runtime flag that controls whether the filter is enabled or not. If set to false, the
 filter will operate as a pass-through filter. If not specified, defaults to enabled.
        .envoy.api.v2.core.RuntimeFeatureFlag runtime_enabled = 5;
        Specified by:
        getRuntimeEnabled in interface CompressorOrBuilder
        Returns:
        The runtimeEnabled.

      • getRuntimeEnabledOrBuilder

        public RuntimeFeatureFlagOrBuilder getRuntimeEnabledOrBuilder()
         Runtime flag that controls whether the filter is enabled or not. If set to false, the
 filter will operate as a pass-through filter. If not specified, defaults to enabled.
        .envoy.api.v2.core.RuntimeFeatureFlag runtime_enabled = 5;
        Specified by:
        getRuntimeEnabledOrBuilder in interface CompressorOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Compressor getDefaultInstance()

      • parser

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

      • getParserForType

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