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

Class Compressor

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.compressor.v3.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: 10]
Protobuf type envoy.extensions.filters.http.compressor.v3.Compressor
See Also:

  • Field Details

    • CONTENT_LENGTH_FIELD_NUMBER

      public static final int CONTENT_LENGTH_FIELD_NUMBER
      See Also:

    • CONTENT_TYPE_FIELD_NUMBER

      public static final int CONTENT_TYPE_FIELD_NUMBER
      See Also:

    • DISABLE_ON_ETAG_HEADER_FIELD_NUMBER

      public static final int DISABLE_ON_ETAG_HEADER_FIELD_NUMBER
      See Also:

    • REMOVE_ACCEPT_ENCODING_HEADER_FIELD_NUMBER

      public static final int REMOVE_ACCEPT_ENCODING_HEADER_FIELD_NUMBER
      See Also:

    • RUNTIME_ENABLED_FIELD_NUMBER

      public static final int RUNTIME_ENABLED_FIELD_NUMBER
      See Also:

    • COMPRESSOR_LIBRARY_FIELD_NUMBER

      public static final int COMPRESSOR_LIBRARY_FIELD_NUMBER
      See Also:

    • REQUEST_DIRECTION_CONFIG_FIELD_NUMBER

      public static final int REQUEST_DIRECTION_CONFIG_FIELD_NUMBER
      See Also:

    • RESPONSE_DIRECTION_CONFIG_FIELD_NUMBER

      public static final int RESPONSE_DIRECTION_CONFIG_FIELD_NUMBER
      See Also:

    • CHOOSE_FIRST_FIELD_NUMBER

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

    • hasContentLength

      @Deprecated public boolean hasContentLength()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.content_length is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=101
       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
      Returns:
      Whether the contentLength field is set.

    • getContentLength

      @Deprecated public com.google.protobuf.UInt32Value getContentLength()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.content_length is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=101
       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
      Returns:
      The contentLength.

    • 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.
      envoy.extensions.filters.http.compressor.v3.Compressor.content_type is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=119
       Set of strings that allows specifying which mime-types yield compression; e.g.,
 ``application/json``, ``text/html``, etc.

 When this field is not specified, compression will be applied to these following mime-types
 and their synonyms:

 * ``application/javascript``
 * ``application/json``
 * ``application/xhtml+xml``
 * ``image/svg+xml``
 * ``text/css``
 * ``text/html``
 * ``text/plain``
 * ``text/xml``
      repeated string content_type = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getContentTypeList in interface CompressorOrBuilder
      Returns:
      A list containing the contentType.

    • getContentTypeCount

      @Deprecated public int getContentTypeCount()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.content_type is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=119
       Set of strings that allows specifying which mime-types yield compression; e.g.,
 ``application/json``, ``text/html``, etc.

 When this field is not specified, compression will be applied to these following mime-types
 and their synonyms:

 * ``application/javascript``
 * ``application/json``
 * ``application/xhtml+xml``
 * ``image/svg+xml``
 * ``text/css``
 * ``text/html``
 * ``text/plain``
 * ``text/xml``
      repeated string content_type = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getContentTypeCount in interface CompressorOrBuilder
      Returns:
      The count of contentType.

    • getContentType

      @Deprecated public String getContentType(int index)
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.content_type is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=119
       Set of strings that allows specifying which mime-types yield compression; e.g.,
 ``application/json``, ``text/html``, etc.

 When this field is not specified, compression will be applied to these following mime-types
 and their synonyms:

 * ``application/javascript``
 * ``application/json``
 * ``application/xhtml+xml``
 * ``image/svg+xml``
 * ``text/css``
 * ``text/html``
 * ``text/plain``
 * ``text/xml``
      repeated string content_type = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getContentType in interface CompressorOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The contentType at the given index.

    • getContentTypeBytes

      @Deprecated public com.google.protobuf.ByteString getContentTypeBytes(int index)
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.content_type is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=119
       Set of strings that allows specifying which mime-types yield compression; e.g.,
 ``application/json``, ``text/html``, etc.

 When this field is not specified, compression will be applied to these following mime-types
 and their synonyms:

 * ``application/javascript``
 * ``application/json``
 * ``application/xhtml+xml``
 * ``image/svg+xml``
 * ``text/css``
 * ``text/html``
 * ``text/plain``
 * ``text/xml``
      repeated string content_type = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      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

      @Deprecated public boolean getDisableOnEtagHeader()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.disable_on_etag_header is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=125
       When this field is ``true``, disables compression when the response contains an ``ETag`` header.
 When this field is ``false``, the filter will preserve weak ``ETag`` values and remove those 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
      Returns:
      The disableOnEtagHeader.

    • getRemoveAcceptEncodingHeader

      @Deprecated public boolean getRemoveAcceptEncodingHeader()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.remove_accept_encoding_header is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=135
       When this field is ``true``, removes ``Accept-Encoding`` from the request headers before dispatching
 the request 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
      Returns:
      The removeAcceptEncodingHeader.

    • hasRuntimeEnabled

      @Deprecated public boolean hasRuntimeEnabled()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.runtime_enabled is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=141
       Runtime flag that controls whether the filter is enabled. When this field is ``false``, the
 filter will operate as a pass-through filter, unless overridden by ``CompressorPerRoute``.
 If this field is not specified, the filter is enabled by default.
      .envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      hasRuntimeEnabled in interface CompressorOrBuilder
      Returns:
      Whether the runtimeEnabled field is set.

    • getRuntimeEnabled

      @Deprecated public RuntimeFeatureFlag getRuntimeEnabled()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.runtime_enabled is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=141
       Runtime flag that controls whether the filter is enabled. When this field is ``false``, the
 filter will operate as a pass-through filter, unless overridden by ``CompressorPerRoute``.
 If this field is not specified, the filter is enabled by default.
      .envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getRuntimeEnabled in interface CompressorOrBuilder
      Returns:
      The runtimeEnabled.

    • getRuntimeEnabledOrBuilder

      @Deprecated public RuntimeFeatureFlagOrBuilder getRuntimeEnabledOrBuilder()
      Deprecated.
       Runtime flag that controls whether the filter is enabled. When this field is ``false``, the
 filter will operate as a pass-through filter, unless overridden by ``CompressorPerRoute``.
 If this field is not specified, the filter is enabled by default.
      .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.
 [#extension-category: envoy.compression.compressor]
      .envoy.config.core.v3.TypedExtensionConfig compressor_library = 6 [(.validate.rules) = { ... }
      Specified by:
      hasCompressorLibrary in interface CompressorOrBuilder
      Returns:
      Whether the compressorLibrary field is set.

    • getCompressorLibrary

      public TypedExtensionConfig getCompressorLibrary()
       A compressor library to use for compression.
 [#extension-category: envoy.compression.compressor]
      .envoy.config.core.v3.TypedExtensionConfig compressor_library = 6 [(.validate.rules) = { ... }
      Specified by:
      getCompressorLibrary in interface CompressorOrBuilder
      Returns:
      The compressorLibrary.

    • getCompressorLibraryOrBuilder

      public TypedExtensionConfigOrBuilder getCompressorLibraryOrBuilder()
       A compressor library to use for compression.
 [#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. If this field is not specified, request compression is disabled.
      .envoy.extensions.filters.http.compressor.v3.Compressor.RequestDirectionConfig request_direction_config = 7;
      Specified by:
      hasRequestDirectionConfig in interface CompressorOrBuilder
      Returns:
      Whether the requestDirectionConfig field is set.

    • getRequestDirectionConfig

      public Compressor.RequestDirectionConfig getRequestDirectionConfig()
       Configuration for request compression. If this field is not specified, request compression is disabled.
      .envoy.extensions.filters.http.compressor.v3.Compressor.RequestDirectionConfig request_direction_config = 7;
      Specified by:
      getRequestDirectionConfig in interface CompressorOrBuilder
      Returns:
      The requestDirectionConfig.

    • getRequestDirectionConfigOrBuilder

      public Compressor.RequestDirectionConfigOrBuilder getRequestDirectionConfigOrBuilder()
       Configuration for request compression. If this field is not specified, request compression is disabled.
      .envoy.extensions.filters.http.compressor.v3.Compressor.RequestDirectionConfig request_direction_config = 7;
      Specified by:
      getRequestDirectionConfigOrBuilder in interface CompressorOrBuilder

    • hasResponseDirectionConfig

      public boolean hasResponseDirectionConfig()
       Configuration for response compression. If this field is not specified, response compression is enabled.

 .. attention::

    When this field is set, 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.

    Additionally, all 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
      Returns:
      Whether the responseDirectionConfig field is set.

    • getResponseDirectionConfig

      public Compressor.ResponseDirectionConfig getResponseDirectionConfig()
       Configuration for response compression. If this field is not specified, response compression is enabled.

 .. attention::

    When this field is set, 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.

    Additionally, all 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
      Returns:
      The responseDirectionConfig.

    • getResponseDirectionConfigOrBuilder

      public Compressor.ResponseDirectionConfigOrBuilder getResponseDirectionConfigOrBuilder()
       Configuration for response compression. If this field is not specified, response compression is enabled.

 .. attention::

    When this field is set, 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.

    Additionally, all 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

    • getChooseFirst

      public boolean getChooseFirst()
       When this field is ``true``, this compressor is preferred when q-values in ``Accept-Encoding`` are equal.
 If multiple compressor filters set ``choose_first`` to ``true``, the last one in the filter chain is chosen.
      bool choose_first = 9;
      Specified by:
      getChooseFirst in interface CompressorOrBuilder
      Returns:
      The chooseFirst.

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • 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

    • newBuilder

      public static Compressor.Builder newBuilder()

    • newBuilder

      public static Compressor.Builder newBuilder(Compressor prototype)

    • 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