Package io.envoyproxy.envoy.extensions.filters.http.compressor.v3

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: 9]
    Protobuf type envoy.extensions.filters.http.compressor.v3.Compressor
    See Also:
    Serialized Form

    • 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

      • COMPRESSOR_LIBRARY_FIELD_NUMBER

        public static final int COMPRESSOR_LIBRARY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_DIRECTION_CONFIG_FIELD_NUMBER

        public static final int REQUEST_DIRECTION_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPONSE_DIRECTION_CONFIG_FIELD_NUMBER

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

        @Deprecated
public boolean hasContentLength()
        Deprecated.
         Minimum response length, in bytes, which will trigger compression. The default value is 30.
        .google.protobuf.UInt32Value content_length = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        hasContentLength in interface CompressorOrBuilder

      • getContentLength

        @Deprecated
public com.google.protobuf.UInt32Value getContentLength()
        Deprecated.
         Minimum response length, in bytes, which will trigger compression. The default value is 30.
        .google.protobuf.UInt32Value content_length = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getContentLength in interface CompressorOrBuilder

      • getContentLengthOrBuilder

        @Deprecated
public com.google.protobuf.UInt32ValueOrBuilder getContentLengthOrBuilder()
        Deprecated.
         Minimum response length, in bytes, which will trigger compression. The default value is 30.
        .google.protobuf.UInt32Value content_length = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getContentLengthOrBuilder in interface CompressorOrBuilder

      • getContentTypeList

        @Deprecated
public com.google.protobuf.ProtocolStringList getContentTypeList()
        Deprecated.
         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 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getContentTypeList in interface CompressorOrBuilder

      • getContentTypeCount

        @Deprecated
public int getContentTypeCount()
        Deprecated.
         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 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getContentTypeCount in interface CompressorOrBuilder

      • getContentType

        @Deprecated
public String getContentType​(int index)
        Deprecated.
         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 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getContentType in interface CompressorOrBuilder

      • getContentTypeBytes

        @Deprecated
public com.google.protobuf.ByteString getContentTypeBytes​(int index)
        Deprecated.
         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 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getContentTypeBytes in interface CompressorOrBuilder

      • getDisableOnEtagHeader

        @Deprecated
public boolean getDisableOnEtagHeader()
        Deprecated.
         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 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getDisableOnEtagHeader in interface CompressorOrBuilder

      • getRemoveAcceptEncodingHeader

        @Deprecated
public boolean getRemoveAcceptEncodingHeader()
        Deprecated.
         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 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getRemoveAcceptEncodingHeader in interface CompressorOrBuilder

      • hasRuntimeEnabled

        @Deprecated
public boolean hasRuntimeEnabled()
        Deprecated.
         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.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        hasRuntimeEnabled in interface CompressorOrBuilder

      • getRuntimeEnabled

        @Deprecated
public RuntimeFeatureFlag getRuntimeEnabled()
        Deprecated.
         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.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getRuntimeEnabled in interface CompressorOrBuilder

      • getRuntimeEnabledOrBuilder

        @Deprecated
public RuntimeFeatureFlagOrBuilder getRuntimeEnabledOrBuilder()
        Deprecated.
         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.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getRuntimeEnabledOrBuilder in interface CompressorOrBuilder

      • hasCompressorLibrary

        public boolean hasCompressorLibrary()
         A compressor library to use for compression. Currently only
 :ref:`envoy.compression.gzip.compressor<envoy_v3_api_msg_extensions.compression.gzip.compressor.v3.Gzip>`
 is included in Envoy.
 [#extension-category: envoy.compression.compressor]
        .envoy.config.core.v3.TypedExtensionConfig compressor_library = 6 [(.validate.rules) = { ... }
        Specified by:
        hasCompressorLibrary in interface CompressorOrBuilder

      • getCompressorLibrary

        public TypedExtensionConfig getCompressorLibrary()
         A compressor library to use for compression. Currently only
 :ref:`envoy.compression.gzip.compressor<envoy_v3_api_msg_extensions.compression.gzip.compressor.v3.Gzip>`
 is included in Envoy.
 [#extension-category: envoy.compression.compressor]
        .envoy.config.core.v3.TypedExtensionConfig compressor_library = 6 [(.validate.rules) = { ... }
        Specified by:
        getCompressorLibrary in interface CompressorOrBuilder

      • getCompressorLibraryOrBuilder

        public TypedExtensionConfigOrBuilder getCompressorLibraryOrBuilder()
         A compressor library to use for compression. Currently only
 :ref:`envoy.compression.gzip.compressor<envoy_v3_api_msg_extensions.compression.gzip.compressor.v3.Gzip>`
 is included in Envoy.
 [#extension-category: envoy.compression.compressor]
        .envoy.config.core.v3.TypedExtensionConfig compressor_library = 6 [(.validate.rules) = { ... }
        Specified by:
        getCompressorLibraryOrBuilder in interface CompressorOrBuilder

      • hasRequestDirectionConfig

        public boolean hasRequestDirectionConfig()
         Configuration for request compression. Compression is disabled by default if left empty.
        .envoy.extensions.filters.http.compressor.v3.Compressor.RequestDirectionConfig request_direction_config = 7;
        Specified by:
        hasRequestDirectionConfig in interface CompressorOrBuilder

      • hasResponseDirectionConfig

        public boolean hasResponseDirectionConfig()
         Configuration for response compression. Compression is enabled by default if left empty.
 .. attention::
    If the field is not empty then the duplicate deprecated fields of the `Compressor` message,
    such as `content_length`, `content_type`, `disable_on_etag_header`,
    `remove_accept_encoding_header` and `runtime_enabled`, are ignored.
    Also all the statistics related to response compression will be rooted in
    `<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.response.*`
    instead of
    `<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.*`.
        .envoy.extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig response_direction_config = 8;
        Specified by:
        hasResponseDirectionConfig in interface CompressorOrBuilder

      • getResponseDirectionConfig

        public Compressor.ResponseDirectionConfig getResponseDirectionConfig()
         Configuration for response compression. Compression is enabled by default if left empty.
 .. attention::
    If the field is not empty then the duplicate deprecated fields of the `Compressor` message,
    such as `content_length`, `content_type`, `disable_on_etag_header`,
    `remove_accept_encoding_header` and `runtime_enabled`, are ignored.
    Also all the statistics related to response compression will be rooted in
    `<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.response.*`
    instead of
    `<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.*`.
        .envoy.extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig response_direction_config = 8;
        Specified by:
        getResponseDirectionConfig in interface CompressorOrBuilder

      • getResponseDirectionConfigOrBuilder

        public Compressor.ResponseDirectionConfigOrBuilder getResponseDirectionConfigOrBuilder()
         Configuration for response compression. Compression is enabled by default if left empty.
 .. attention::
    If the field is not empty then the duplicate deprecated fields of the `Compressor` message,
    such as `content_length`, `content_type`, `disable_on_etag_header`,
    `remove_accept_encoding_header` and `runtime_enabled`, are ignored.
    Also all the statistics related to response compression will be rooted in
    `<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.response.*`
    instead of
    `<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.*`.
        .envoy.extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig response_direction_config = 8;
        Specified by:
        getResponseDirectionConfigOrBuilder 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