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

Interface Compressor.CommonDirectionConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Compressor.CommonDirectionConfig, Compressor.CommonDirectionConfig.Builder
Enclosing class:
Compressor
public static interface Compressor.CommonDirectionConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    RuntimeFeatureFlag
    getEnabled()
    Runtime flag that controls whether compression is enabled for the direction this common config is applied to.
    RuntimeFeatureFlagOrBuilder
    getEnabledOrBuilder()
    Runtime flag that controls whether compression is enabled for the direction this common config is applied to.
    com.google.protobuf.UInt32Value
    getMinContentLength()
    Minimum value of the ``Content-Length`` header in request or response messages (depending on the direction this common config is applied to), in bytes, that will trigger compression.
    com.google.protobuf.UInt32ValueOrBuilder
    getMinContentLengthOrBuilder()
    Minimum value of the ``Content-Length`` header in request or response messages (depending on the direction this common config is applied to), in bytes, that will trigger compression.
    boolean
    hasEnabled()
    Runtime flag that controls whether compression is enabled for the direction this common config is applied to.
    boolean
    hasMinContentLength()
    Minimum value of the ``Content-Length`` header in request or response messages (depending on the direction this common config is applied to), in bytes, that will trigger compression.

    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

    • hasEnabled

      boolean hasEnabled()
       Runtime flag that controls whether compression is enabled for the direction this
 common config is applied to. When this field is ``false``, the filter will operate as a
 pass-through filter in the chosen direction, unless overridden by ``CompressorPerRoute``.
 If this field is not specified, the filter will be enabled.
      .envoy.config.core.v3.RuntimeFeatureFlag enabled = 1;
      Returns:
      Whether the enabled field is set.

    • getEnabled

      RuntimeFeatureFlag getEnabled()
       Runtime flag that controls whether compression is enabled for the direction this
 common config is applied to. When this field is ``false``, the filter will operate as a
 pass-through filter in the chosen direction, unless overridden by ``CompressorPerRoute``.
 If this field is not specified, the filter will be enabled.
      .envoy.config.core.v3.RuntimeFeatureFlag enabled = 1;
      Returns:
      The enabled.

    • getEnabledOrBuilder

      RuntimeFeatureFlagOrBuilder getEnabledOrBuilder()
       Runtime flag that controls whether compression is enabled for the direction this
 common config is applied to. When this field is ``false``, the filter will operate as a
 pass-through filter in the chosen direction, unless overridden by ``CompressorPerRoute``.
 If this field is not specified, the filter will be enabled.
      .envoy.config.core.v3.RuntimeFeatureFlag enabled = 1;

    • hasMinContentLength

      boolean hasMinContentLength()
       Minimum value of the ``Content-Length`` header in request or response messages (depending on the
 direction this common config is applied to), in bytes, that will trigger compression. Defaults to 30.
      .google.protobuf.UInt32Value min_content_length = 2;
      Returns:
      Whether the minContentLength field is set.

    • getMinContentLength

      com.google.protobuf.UInt32Value getMinContentLength()
       Minimum value of the ``Content-Length`` header in request or response messages (depending on the
 direction this common config is applied to), in bytes, that will trigger compression. Defaults to 30.
      .google.protobuf.UInt32Value min_content_length = 2;
      Returns:
      The minContentLength.

    • getMinContentLengthOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getMinContentLengthOrBuilder()
       Minimum value of the ``Content-Length`` header in request or response messages (depending on the
 direction this common config is applied to), in bytes, that will trigger compression. Defaults to 30.
      .google.protobuf.UInt32Value min_content_length = 2;

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