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

Interface CompressorOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Compressor, Compressor.Builder
public interface CompressorOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    List<String>
    getContentTypeList()
    Set of strings that allows specifying which mime-types yield compression; e.g., application/json, text/html, etc.
    boolean
    getDisableOnEtagHeader()
    If true, disables compression when the response contains an etag header.
    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.
    boolean
    hasContentLength()
    Minimum response length, in bytes, which will trigger compression.
    boolean
    hasRuntimeEnabled()
    Runtime flag that controls whether the filter is enabled or not.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasContentLength

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

    • getContentLength

      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;
      Returns:
      The contentLength.

    • getContentLengthOrBuilder

      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;

    • getContentTypeList

      List<String> 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;
      Returns:
      A list containing the contentType.

    • getContentTypeCount

      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;
      Returns:
      The count of contentType.

    • getContentType

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The contentType at the given index.

    • getContentTypeBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the contentType at the given index.

    • getDisableOnEtagHeader

      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;
      Returns:
      The disableOnEtagHeader.

    • getRemoveAcceptEncodingHeader

      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;
      Returns:
      The removeAcceptEncodingHeader.

    • hasRuntimeEnabled

      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;
      Returns:
      Whether the runtimeEnabled field is set.

    • getRuntimeEnabled

      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;
      Returns:
      The runtimeEnabled.

    • getRuntimeEnabledOrBuilder

      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;